v1

package
v0.32.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 29, 2023 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// Syntax `proto2`.
	ApiSyntaxSyntaxProto2 = ApiSyntax("SYNTAX_PROTO2")
	// Syntax `proto3`.
	ApiSyntaxSyntaxProto3 = ApiSyntax("SYNTAX_PROTO3")
	// Syntax `editions`.
	ApiSyntaxSyntaxEditions = ApiSyntax("SYNTAX_EDITIONS")
)
View Source
const (
	// Default case. Should never be this.
	AuditLogConfigLogTypeLogTypeUnspecified = AuditLogConfigLogType("LOG_TYPE_UNSPECIFIED")
	// Admin reads. Example: CloudIAM getIamPolicy
	AuditLogConfigLogTypeAdminRead = AuditLogConfigLogType("ADMIN_READ")
	// Data writes. Example: CloudSQL Users create
	AuditLogConfigLogTypeDataWrite = AuditLogConfigLogType("DATA_WRITE")
	// Data reads. Example: CloudSQL Users list
	AuditLogConfigLogTypeDataRead = AuditLogConfigLogType("DATA_READ")
)
View Source
const (
	BackendRulePathTranslationPathTranslationUnspecified = BackendRulePathTranslation("PATH_TRANSLATION_UNSPECIFIED")
	// Use the backend address as-is, with no modification to the path. If the URL pattern contains variables, the variable names and values will be appended to the query string. If a query string parameter and a URL pattern variable have the same name, this may result in duplicate keys in the query string. # Examples Given the following operation config: Method path: /api/company/{cid}/user/{uid} Backend address: https://example.cloudfunctions.net/getUser Requests to the following request paths will call the backend at the translated path: Request path: /api/company/widgetworks/user/johndoe Translated: https://example.cloudfunctions.net/getUser?cid=widgetworks&uid=johndoe Request path: /api/company/widgetworks/user/johndoe?timezone=EST Translated: https://example.cloudfunctions.net/getUser?timezone=EST&cid=widgetworks&uid=johndoe
	BackendRulePathTranslationConstantAddress = BackendRulePathTranslation("CONSTANT_ADDRESS")
	// The request path will be appended to the backend address. # Examples Given the following operation config: Method path: /api/company/{cid}/user/{uid} Backend address: https://example.appspot.com Requests to the following request paths will call the backend at the translated path: Request path: /api/company/widgetworks/user/johndoe Translated: https://example.appspot.com/api/company/widgetworks/user/johndoe Request path: /api/company/widgetworks/user/johndoe?timezone=EST Translated: https://example.appspot.com/api/company/widgetworks/user/johndoe?timezone=EST
	BackendRulePathTranslationAppendPathToAddress = BackendRulePathTranslation("APPEND_PATH_TO_ADDRESS")
)
View Source
const (
	// Do not use this default value.
	ClientLibrarySettingsLaunchStageLaunchStageUnspecified = ClientLibrarySettingsLaunchStage("LAUNCH_STAGE_UNSPECIFIED")
	// The feature is not yet implemented. Users can not use it.
	ClientLibrarySettingsLaunchStageUnimplemented = ClientLibrarySettingsLaunchStage("UNIMPLEMENTED")
	// Prelaunch features are hidden from users and are only visible internally.
	ClientLibrarySettingsLaunchStagePrelaunch = ClientLibrarySettingsLaunchStage("PRELAUNCH")
	// Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.
	ClientLibrarySettingsLaunchStageEarlyAccess = ClientLibrarySettingsLaunchStage("EARLY_ACCESS")
	// Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.
	ClientLibrarySettingsLaunchStageAlpha = ClientLibrarySettingsLaunchStage("ALPHA")
	// Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.
	ClientLibrarySettingsLaunchStageBeta = ClientLibrarySettingsLaunchStage("BETA")
	// GA features are open to all developers and are considered stable and fully qualified for production use.
	ClientLibrarySettingsLaunchStageGa = ClientLibrarySettingsLaunchStage("GA")
	// Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our [Terms of Service](https://cloud.google.com/terms/) and the [Google Cloud Platform Subject to the Deprecation Policy](https://cloud.google.com/terms/deprecation) documentation.
	ClientLibrarySettingsLaunchStageDeprecated = ClientLibrarySettingsLaunchStage("DEPRECATED")
)
View Source
const (
	// Client libraries will neither be generated nor published to package managers.
	CommonLanguageSettingsDestinationsItemClientLibraryDestinationUnspecified = CommonLanguageSettingsDestinationsItem("CLIENT_LIBRARY_DESTINATION_UNSPECIFIED")
	// Generate the client library in a repo under github.com/googleapis, but don't publish it to package managers.
	CommonLanguageSettingsDestinationsItemGithub = CommonLanguageSettingsDestinationsItem("GITHUB")
	// Publish the library to package managers like nuget.org and npmjs.com.
	CommonLanguageSettingsDestinationsItemPackageManager = CommonLanguageSettingsDestinationsItem("PACKAGE_MANAGER")
)
View Source
const (
	// Syntax `proto2`.
	EnumSyntaxSyntaxProto2 = EnumSyntax("SYNTAX_PROTO2")
	// Syntax `proto3`.
	EnumSyntaxSyntaxProto3 = EnumSyntax("SYNTAX_PROTO3")
	// Syntax `editions`.
	EnumSyntaxSyntaxEditions = EnumSyntax("SYNTAX_EDITIONS")
)
View Source
const (
	// For fields with unknown cardinality.
	FieldCardinalityCardinalityUnknown = FieldCardinality("CARDINALITY_UNKNOWN")
	// For optional fields.
	FieldCardinalityCardinalityOptional = FieldCardinality("CARDINALITY_OPTIONAL")
	// For required fields. Proto2 syntax only.
	FieldCardinalityCardinalityRequired = FieldCardinality("CARDINALITY_REQUIRED")
	// For repeated fields.
	FieldCardinalityCardinalityRepeated = FieldCardinality("CARDINALITY_REPEATED")
)
View Source
const (
	// Field type unknown.
	FieldKindTypeUnknown = FieldKind("TYPE_UNKNOWN")
	// Field type double.
	FieldKindTypeDouble = FieldKind("TYPE_DOUBLE")
	// Field type float.
	FieldKindTypeFloat = FieldKind("TYPE_FLOAT")
	// Field type int64.
	FieldKindTypeInt64 = FieldKind("TYPE_INT64")
	// Field type uint64.
	FieldKindTypeUint64 = FieldKind("TYPE_UINT64")
	// Field type int32.
	FieldKindTypeInt32 = FieldKind("TYPE_INT32")
	// Field type fixed64.
	FieldKindTypeFixed64 = FieldKind("TYPE_FIXED64")
	// Field type fixed32.
	FieldKindTypeFixed32 = FieldKind("TYPE_FIXED32")
	// Field type bool.
	FieldKindTypeBool = FieldKind("TYPE_BOOL")
	// Field type string.
	FieldKindTypeString = FieldKind("TYPE_STRING")
	// Field type group. Proto2 syntax only, and deprecated.
	FieldKindTypeGroup = FieldKind("TYPE_GROUP")
	// Field type message.
	FieldKindTypeMessage = FieldKind("TYPE_MESSAGE")
	// Field type bytes.
	FieldKindTypeBytes = FieldKind("TYPE_BYTES")
	// Field type uint32.
	FieldKindTypeUint32 = FieldKind("TYPE_UINT32")
	// Field type enum.
	FieldKindTypeEnum = FieldKind("TYPE_ENUM")
	// Field type sfixed32.
	FieldKindTypeSfixed32 = FieldKind("TYPE_SFIXED32")
	// Field type sfixed64.
	FieldKindTypeSfixed64 = FieldKind("TYPE_SFIXED64")
	// Field type sint32.
	FieldKindTypeSint32 = FieldKind("TYPE_SINT32")
	// Field type sint64.
	FieldKindTypeSint64 = FieldKind("TYPE_SINT64")
)
View Source
const (
	// A variable-length string. This is the default.
	LabelDescriptorValueTypeString = LabelDescriptorValueType("STRING")
	// Boolean; true or false.
	LabelDescriptorValueTypeBool = LabelDescriptorValueType("BOOL")
	// A 64-bit signed integer.
	LabelDescriptorValueTypeInt64 = LabelDescriptorValueType("INT64")
)
View Source
const (
	// Syntax `proto2`.
	MethodSyntaxSyntaxProto2 = MethodSyntax("SYNTAX_PROTO2")
	// Syntax `proto3`.
	MethodSyntaxSyntaxProto3 = MethodSyntax("SYNTAX_PROTO3")
	// Syntax `editions`.
	MethodSyntaxSyntaxEditions = MethodSyntax("SYNTAX_EDITIONS")
)
View Source
const (
	// Do not use this default value.
	MetricDescriptorLaunchStageLaunchStageUnspecified = MetricDescriptorLaunchStage("LAUNCH_STAGE_UNSPECIFIED")
	// The feature is not yet implemented. Users can not use it.
	MetricDescriptorLaunchStageUnimplemented = MetricDescriptorLaunchStage("UNIMPLEMENTED")
	// Prelaunch features are hidden from users and are only visible internally.
	MetricDescriptorLaunchStagePrelaunch = MetricDescriptorLaunchStage("PRELAUNCH")
	// Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.
	MetricDescriptorLaunchStageEarlyAccess = MetricDescriptorLaunchStage("EARLY_ACCESS")
	// Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.
	MetricDescriptorLaunchStageAlpha = MetricDescriptorLaunchStage("ALPHA")
	// Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.
	MetricDescriptorLaunchStageBeta = MetricDescriptorLaunchStage("BETA")
	// GA features are open to all developers and are considered stable and fully qualified for production use.
	MetricDescriptorLaunchStageGa = MetricDescriptorLaunchStage("GA")
	// Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our [Terms of Service](https://cloud.google.com/terms/) and the [Google Cloud Platform Subject to the Deprecation Policy](https://cloud.google.com/terms/deprecation) documentation.
	MetricDescriptorLaunchStageDeprecated = MetricDescriptorLaunchStage("DEPRECATED")
)
View Source
const (
	// Do not use this default value.
	MetricDescriptorMetadataLaunchStageLaunchStageUnspecified = MetricDescriptorMetadataLaunchStage("LAUNCH_STAGE_UNSPECIFIED")
	// The feature is not yet implemented. Users can not use it.
	MetricDescriptorMetadataLaunchStageUnimplemented = MetricDescriptorMetadataLaunchStage("UNIMPLEMENTED")
	// Prelaunch features are hidden from users and are only visible internally.
	MetricDescriptorMetadataLaunchStagePrelaunch = MetricDescriptorMetadataLaunchStage("PRELAUNCH")
	// Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.
	MetricDescriptorMetadataLaunchStageEarlyAccess = MetricDescriptorMetadataLaunchStage("EARLY_ACCESS")
	// Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.
	MetricDescriptorMetadataLaunchStageAlpha = MetricDescriptorMetadataLaunchStage("ALPHA")
	// Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.
	MetricDescriptorMetadataLaunchStageBeta = MetricDescriptorMetadataLaunchStage("BETA")
	// GA features are open to all developers and are considered stable and fully qualified for production use.
	MetricDescriptorMetadataLaunchStageGa = MetricDescriptorMetadataLaunchStage("GA")
	// Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our [Terms of Service](https://cloud.google.com/terms/) and the [Google Cloud Platform Subject to the Deprecation Policy](https://cloud.google.com/terms/deprecation) documentation.
	MetricDescriptorMetadataLaunchStageDeprecated = MetricDescriptorMetadataLaunchStage("DEPRECATED")
)
View Source
const (
	// Do not use this default value.
	MetricDescriptorMetricKindMetricKindUnspecified = MetricDescriptorMetricKind("METRIC_KIND_UNSPECIFIED")
	// An instantaneous measurement of a value.
	MetricDescriptorMetricKindGauge = MetricDescriptorMetricKind("GAUGE")
	// The change in a value during a time interval.
	MetricDescriptorMetricKindDelta = MetricDescriptorMetricKind("DELTA")
	// A value accumulated over a time interval. Cumulative measurements in a time series should have the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points.
	MetricDescriptorMetricKindCumulative = MetricDescriptorMetricKind("CUMULATIVE")
)
View Source
const (
	// Do not use this default value.
	MetricDescriptorValueTypeValueTypeUnspecified = MetricDescriptorValueType("VALUE_TYPE_UNSPECIFIED")
	// The value is a boolean. This value type can be used only if the metric kind is `GAUGE`.
	MetricDescriptorValueTypeBool = MetricDescriptorValueType("BOOL")
	// The value is a signed 64-bit integer.
	MetricDescriptorValueTypeInt64 = MetricDescriptorValueType("INT64")
	// The value is a double precision floating point number.
	MetricDescriptorValueTypeDouble = MetricDescriptorValueType("DOUBLE")
	// The value is a text string. This value type can be used only if the metric kind is `GAUGE`.
	MetricDescriptorValueTypeString = MetricDescriptorValueType("STRING")
	// The value is a `Distribution`.
	MetricDescriptorValueTypeDistribution = MetricDescriptorValueType("DISTRIBUTION")
	// The value is money.
	MetricDescriptorValueTypeMoney = MetricDescriptorValueType("MONEY")
)
View Source
const (
	// Do not use this default value.
	MonitoredResourceDescriptorLaunchStageLaunchStageUnspecified = MonitoredResourceDescriptorLaunchStage("LAUNCH_STAGE_UNSPECIFIED")
	// The feature is not yet implemented. Users can not use it.
	MonitoredResourceDescriptorLaunchStageUnimplemented = MonitoredResourceDescriptorLaunchStage("UNIMPLEMENTED")
	// Prelaunch features are hidden from users and are only visible internally.
	MonitoredResourceDescriptorLaunchStagePrelaunch = MonitoredResourceDescriptorLaunchStage("PRELAUNCH")
	// Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.
	MonitoredResourceDescriptorLaunchStageEarlyAccess = MonitoredResourceDescriptorLaunchStage("EARLY_ACCESS")
	// Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.
	MonitoredResourceDescriptorLaunchStageAlpha = MonitoredResourceDescriptorLaunchStage("ALPHA")
	// Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.
	MonitoredResourceDescriptorLaunchStageBeta = MonitoredResourceDescriptorLaunchStage("BETA")
	// GA features are open to all developers and are considered stable and fully qualified for production use.
	MonitoredResourceDescriptorLaunchStageGa = MonitoredResourceDescriptorLaunchStage("GA")
	// Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our [Terms of Service](https://cloud.google.com/terms/) and the [Google Cloud Platform Subject to the Deprecation Policy](https://cloud.google.com/terms/deprecation) documentation.
	MonitoredResourceDescriptorLaunchStageDeprecated = MonitoredResourceDescriptorLaunchStage("DEPRECATED")
)
View Source
const (
	// Not useful.
	PublishingOrganizationClientLibraryOrganizationUnspecified = PublishingOrganization("CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED")
	// Google Cloud Platform Org.
	PublishingOrganizationCloud = PublishingOrganization("CLOUD")
	// Ads (Advertising) Org.
	PublishingOrganizationAds = PublishingOrganization("ADS")
	// Photos Org.
	PublishingOrganizationPhotos = PublishingOrganization("PHOTOS")
	// Street View Org.
	PublishingOrganizationStreetView = PublishingOrganization("STREET_VIEW")
	// Shopping Org.
	PublishingOrganizationShopping = PublishingOrganization("SHOPPING")
	// Geo Org.
	PublishingOrganizationGeo = PublishingOrganization("GEO")
	// Generative AI - https://developers.generativeai.google
	PublishingOrganizationGenerativeAi = PublishingOrganization("GENERATIVE_AI")
)
View Source
const (
	// No status specified.
	RolloutStatusRolloutStatusUnspecified = RolloutStatus("ROLLOUT_STATUS_UNSPECIFIED")
	// The Rollout is in progress.
	RolloutStatusInProgress = RolloutStatus("IN_PROGRESS")
	// The Rollout has completed successfully.
	RolloutStatusSuccess = RolloutStatus("SUCCESS")
	// The Rollout has been cancelled. This can happen if you have overlapping Rollout pushes, and the previous ones will be cancelled.
	RolloutStatusCancelled = RolloutStatus("CANCELLED")
	// The Rollout has failed and the rollback attempt has failed too.
	RolloutStatusFailed = RolloutStatus("FAILED")
	// The Rollout has not started yet and is pending for execution.
	RolloutStatusPending = RolloutStatus("PENDING")
	// The Rollout has failed and rolled back to the previous successful Rollout.
	RolloutStatusFailedRolledBack = RolloutStatus("FAILED_ROLLED_BACK")
)
View Source
const (
	// Syntax `proto2`.
	TypeSyntaxSyntaxProto2 = TypeSyntax("SYNTAX_PROTO2")
	// Syntax `proto3`.
	TypeSyntaxSyntaxProto3 = TypeSyntax("SYNTAX_PROTO3")
	// Syntax `editions`.
	TypeSyntaxSyntaxEditions = TypeSyntax("SYNTAX_EDITIONS")
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Api

type Api struct {
	// The methods of this interface, in unspecified order.
	Methods []Method `pulumi:"methods"`
	// Included interfaces. See Mixin.
	Mixins []Mixin `pulumi:"mixins"`
	// The fully qualified name of this interface, including package name followed by the interface's simple name.
	Name *string `pulumi:"name"`
	// Any metadata attached to the interface.
	Options []Option `pulumi:"options"`
	// Source context for the protocol buffer service represented by this message.
	SourceContext *SourceContext `pulumi:"sourceContext"`
	// The source syntax of the service.
	Syntax *ApiSyntax `pulumi:"syntax"`
	// A version string for this interface. If specified, must have the form `major-version.minor-version`, as in `1.10`. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses [semantic versioning](http://semver.org) where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the interface, which must end in `v`, as in `google.feature.v1`. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces.
	Version *string `pulumi:"version"`
}

Api is a light-weight descriptor for an API Interface. Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology.

type ApiArgs

type ApiArgs struct {
	// The methods of this interface, in unspecified order.
	Methods MethodArrayInput `pulumi:"methods"`
	// Included interfaces. See Mixin.
	Mixins MixinArrayInput `pulumi:"mixins"`
	// The fully qualified name of this interface, including package name followed by the interface's simple name.
	Name pulumi.StringPtrInput `pulumi:"name"`
	// Any metadata attached to the interface.
	Options OptionArrayInput `pulumi:"options"`
	// Source context for the protocol buffer service represented by this message.
	SourceContext SourceContextPtrInput `pulumi:"sourceContext"`
	// The source syntax of the service.
	Syntax ApiSyntaxPtrInput `pulumi:"syntax"`
	// A version string for this interface. If specified, must have the form `major-version.minor-version`, as in `1.10`. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses [semantic versioning](http://semver.org) where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the interface, which must end in `v`, as in `google.feature.v1`. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces.
	Version pulumi.StringPtrInput `pulumi:"version"`
}

Api is a light-weight descriptor for an API Interface. Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology.

func (ApiArgs) ElementType

func (ApiArgs) ElementType() reflect.Type

func (ApiArgs) ToApiOutput

func (i ApiArgs) ToApiOutput() ApiOutput

func (ApiArgs) ToApiOutputWithContext

func (i ApiArgs) ToApiOutputWithContext(ctx context.Context) ApiOutput

type ApiArray

type ApiArray []ApiInput

func (ApiArray) ElementType

func (ApiArray) ElementType() reflect.Type

func (ApiArray) ToApiArrayOutput

func (i ApiArray) ToApiArrayOutput() ApiArrayOutput

func (ApiArray) ToApiArrayOutputWithContext

func (i ApiArray) ToApiArrayOutputWithContext(ctx context.Context) ApiArrayOutput

type ApiArrayInput

type ApiArrayInput interface {
	pulumi.Input

	ToApiArrayOutput() ApiArrayOutput
	ToApiArrayOutputWithContext(context.Context) ApiArrayOutput
}

ApiArrayInput is an input type that accepts ApiArray and ApiArrayOutput values. You can construct a concrete instance of `ApiArrayInput` via:

ApiArray{ ApiArgs{...} }

type ApiArrayOutput

type ApiArrayOutput struct{ *pulumi.OutputState }

func (ApiArrayOutput) ElementType

func (ApiArrayOutput) ElementType() reflect.Type

func (ApiArrayOutput) Index

func (ApiArrayOutput) ToApiArrayOutput

func (o ApiArrayOutput) ToApiArrayOutput() ApiArrayOutput

func (ApiArrayOutput) ToApiArrayOutputWithContext

func (o ApiArrayOutput) ToApiArrayOutputWithContext(ctx context.Context) ApiArrayOutput

type ApiInput

type ApiInput interface {
	pulumi.Input

	ToApiOutput() ApiOutput
	ToApiOutputWithContext(context.Context) ApiOutput
}

ApiInput is an input type that accepts ApiArgs and ApiOutput values. You can construct a concrete instance of `ApiInput` via:

ApiArgs{...}

type ApiOutput

type ApiOutput struct{ *pulumi.OutputState }

Api is a light-weight descriptor for an API Interface. Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology.

func (ApiOutput) ElementType

func (ApiOutput) ElementType() reflect.Type

func (ApiOutput) Methods

func (o ApiOutput) Methods() MethodArrayOutput

The methods of this interface, in unspecified order.

func (ApiOutput) Mixins

func (o ApiOutput) Mixins() MixinArrayOutput

Included interfaces. See Mixin.

func (ApiOutput) Name

func (o ApiOutput) Name() pulumi.StringPtrOutput

The fully qualified name of this interface, including package name followed by the interface's simple name.

func (ApiOutput) Options

func (o ApiOutput) Options() OptionArrayOutput

Any metadata attached to the interface.

func (ApiOutput) SourceContext

func (o ApiOutput) SourceContext() SourceContextPtrOutput

Source context for the protocol buffer service represented by this message.

func (ApiOutput) Syntax

func (o ApiOutput) Syntax() ApiSyntaxPtrOutput

The source syntax of the service.

func (ApiOutput) ToApiOutput

func (o ApiOutput) ToApiOutput() ApiOutput

func (ApiOutput) ToApiOutputWithContext

func (o ApiOutput) ToApiOutputWithContext(ctx context.Context) ApiOutput

func (ApiOutput) Version

func (o ApiOutput) Version() pulumi.StringPtrOutput

A version string for this interface. If specified, must have the form `major-version.minor-version`, as in `1.10`. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses [semantic versioning](http://semver.org) where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the interface, which must end in `v`, as in `google.feature.v1`. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces.

type ApiResponse

type ApiResponse struct {
	// The methods of this interface, in unspecified order.
	Methods []MethodResponse `pulumi:"methods"`
	// Included interfaces. See Mixin.
	Mixins []MixinResponse `pulumi:"mixins"`
	// The fully qualified name of this interface, including package name followed by the interface's simple name.
	Name string `pulumi:"name"`
	// Any metadata attached to the interface.
	Options []OptionResponse `pulumi:"options"`
	// Source context for the protocol buffer service represented by this message.
	SourceContext SourceContextResponse `pulumi:"sourceContext"`
	// The source syntax of the service.
	Syntax string `pulumi:"syntax"`
	// A version string for this interface. If specified, must have the form `major-version.minor-version`, as in `1.10`. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses [semantic versioning](http://semver.org) where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the interface, which must end in `v`, as in `google.feature.v1`. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces.
	Version string `pulumi:"version"`
}

Api is a light-weight descriptor for an API Interface. Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology.

type ApiResponseArrayOutput

type ApiResponseArrayOutput struct{ *pulumi.OutputState }

func (ApiResponseArrayOutput) ElementType

func (ApiResponseArrayOutput) ElementType() reflect.Type

func (ApiResponseArrayOutput) Index

func (ApiResponseArrayOutput) ToApiResponseArrayOutput

func (o ApiResponseArrayOutput) ToApiResponseArrayOutput() ApiResponseArrayOutput

func (ApiResponseArrayOutput) ToApiResponseArrayOutputWithContext

func (o ApiResponseArrayOutput) ToApiResponseArrayOutputWithContext(ctx context.Context) ApiResponseArrayOutput

type ApiResponseOutput

type ApiResponseOutput struct{ *pulumi.OutputState }

Api is a light-weight descriptor for an API Interface. Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology.

func (ApiResponseOutput) ElementType

func (ApiResponseOutput) ElementType() reflect.Type

func (ApiResponseOutput) Methods

The methods of this interface, in unspecified order.

func (ApiResponseOutput) Mixins

Included interfaces. See Mixin.

func (ApiResponseOutput) Name

The fully qualified name of this interface, including package name followed by the interface's simple name.

func (ApiResponseOutput) Options

Any metadata attached to the interface.

func (ApiResponseOutput) SourceContext

Source context for the protocol buffer service represented by this message.

func (ApiResponseOutput) Syntax

The source syntax of the service.

func (ApiResponseOutput) ToApiResponseOutput

func (o ApiResponseOutput) ToApiResponseOutput() ApiResponseOutput

func (ApiResponseOutput) ToApiResponseOutputWithContext

func (o ApiResponseOutput) ToApiResponseOutputWithContext(ctx context.Context) ApiResponseOutput

func (ApiResponseOutput) Version

A version string for this interface. If specified, must have the form `major-version.minor-version`, as in `1.10`. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses [semantic versioning](http://semver.org) where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the interface, which must end in `v`, as in `google.feature.v1`. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces.

type ApiSyntax added in v0.4.0

type ApiSyntax string

The source syntax of the service.

func (ApiSyntax) ElementType added in v0.4.0

func (ApiSyntax) ElementType() reflect.Type

func (ApiSyntax) ToApiSyntaxOutput added in v0.6.0

func (e ApiSyntax) ToApiSyntaxOutput() ApiSyntaxOutput

func (ApiSyntax) ToApiSyntaxOutputWithContext added in v0.6.0

func (e ApiSyntax) ToApiSyntaxOutputWithContext(ctx context.Context) ApiSyntaxOutput

func (ApiSyntax) ToApiSyntaxPtrOutput added in v0.6.0

func (e ApiSyntax) ToApiSyntaxPtrOutput() ApiSyntaxPtrOutput

func (ApiSyntax) ToApiSyntaxPtrOutputWithContext added in v0.6.0

func (e ApiSyntax) ToApiSyntaxPtrOutputWithContext(ctx context.Context) ApiSyntaxPtrOutput

func (ApiSyntax) ToStringOutput added in v0.4.0

func (e ApiSyntax) ToStringOutput() pulumi.StringOutput

func (ApiSyntax) ToStringOutputWithContext added in v0.4.0

func (e ApiSyntax) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (ApiSyntax) ToStringPtrOutput added in v0.4.0

func (e ApiSyntax) ToStringPtrOutput() pulumi.StringPtrOutput

func (ApiSyntax) ToStringPtrOutputWithContext added in v0.4.0

func (e ApiSyntax) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type ApiSyntaxInput added in v0.6.0

type ApiSyntaxInput interface {
	pulumi.Input

	ToApiSyntaxOutput() ApiSyntaxOutput
	ToApiSyntaxOutputWithContext(context.Context) ApiSyntaxOutput
}

ApiSyntaxInput is an input type that accepts ApiSyntaxArgs and ApiSyntaxOutput values. You can construct a concrete instance of `ApiSyntaxInput` via:

ApiSyntaxArgs{...}

type ApiSyntaxOutput added in v0.6.0

type ApiSyntaxOutput struct{ *pulumi.OutputState }

func (ApiSyntaxOutput) ElementType added in v0.6.0

func (ApiSyntaxOutput) ElementType() reflect.Type

func (ApiSyntaxOutput) ToApiSyntaxOutput added in v0.6.0

func (o ApiSyntaxOutput) ToApiSyntaxOutput() ApiSyntaxOutput

func (ApiSyntaxOutput) ToApiSyntaxOutputWithContext added in v0.6.0

func (o ApiSyntaxOutput) ToApiSyntaxOutputWithContext(ctx context.Context) ApiSyntaxOutput

func (ApiSyntaxOutput) ToApiSyntaxPtrOutput added in v0.6.0

func (o ApiSyntaxOutput) ToApiSyntaxPtrOutput() ApiSyntaxPtrOutput

func (ApiSyntaxOutput) ToApiSyntaxPtrOutputWithContext added in v0.6.0

func (o ApiSyntaxOutput) ToApiSyntaxPtrOutputWithContext(ctx context.Context) ApiSyntaxPtrOutput

func (ApiSyntaxOutput) ToStringOutput added in v0.6.0

func (o ApiSyntaxOutput) ToStringOutput() pulumi.StringOutput

func (ApiSyntaxOutput) ToStringOutputWithContext added in v0.6.0

func (o ApiSyntaxOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (ApiSyntaxOutput) ToStringPtrOutput added in v0.6.0

func (o ApiSyntaxOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (ApiSyntaxOutput) ToStringPtrOutputWithContext added in v0.6.0

func (o ApiSyntaxOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type ApiSyntaxPtrInput added in v0.6.0

type ApiSyntaxPtrInput interface {
	pulumi.Input

	ToApiSyntaxPtrOutput() ApiSyntaxPtrOutput
	ToApiSyntaxPtrOutputWithContext(context.Context) ApiSyntaxPtrOutput
}

func ApiSyntaxPtr added in v0.6.0

func ApiSyntaxPtr(v string) ApiSyntaxPtrInput

type ApiSyntaxPtrOutput added in v0.6.0

type ApiSyntaxPtrOutput struct{ *pulumi.OutputState }

func (ApiSyntaxPtrOutput) Elem added in v0.6.0

func (ApiSyntaxPtrOutput) ElementType added in v0.6.0

func (ApiSyntaxPtrOutput) ElementType() reflect.Type

func (ApiSyntaxPtrOutput) ToApiSyntaxPtrOutput added in v0.6.0

func (o ApiSyntaxPtrOutput) ToApiSyntaxPtrOutput() ApiSyntaxPtrOutput

func (ApiSyntaxPtrOutput) ToApiSyntaxPtrOutputWithContext added in v0.6.0

func (o ApiSyntaxPtrOutput) ToApiSyntaxPtrOutputWithContext(ctx context.Context) ApiSyntaxPtrOutput

func (ApiSyntaxPtrOutput) ToStringPtrOutput added in v0.6.0

func (o ApiSyntaxPtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (ApiSyntaxPtrOutput) ToStringPtrOutputWithContext added in v0.6.0

func (o ApiSyntaxPtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type AuditConfig

type AuditConfig struct {
	// The configuration for logging of each type of permission.
	AuditLogConfigs []AuditLogConfig `pulumi:"auditLogConfigs"`
	// Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
	Service *string `pulumi:"service"`
}

Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.

type AuditConfigArgs

type AuditConfigArgs struct {
	// The configuration for logging of each type of permission.
	AuditLogConfigs AuditLogConfigArrayInput `pulumi:"auditLogConfigs"`
	// Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
	Service pulumi.StringPtrInput `pulumi:"service"`
}

Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.

func (AuditConfigArgs) ElementType

func (AuditConfigArgs) ElementType() reflect.Type

func (AuditConfigArgs) ToAuditConfigOutput

func (i AuditConfigArgs) ToAuditConfigOutput() AuditConfigOutput

func (AuditConfigArgs) ToAuditConfigOutputWithContext

func (i AuditConfigArgs) ToAuditConfigOutputWithContext(ctx context.Context) AuditConfigOutput

type AuditConfigArray

type AuditConfigArray []AuditConfigInput

func (AuditConfigArray) ElementType

func (AuditConfigArray) ElementType() reflect.Type

func (AuditConfigArray) ToAuditConfigArrayOutput

func (i AuditConfigArray) ToAuditConfigArrayOutput() AuditConfigArrayOutput

func (AuditConfigArray) ToAuditConfigArrayOutputWithContext

func (i AuditConfigArray) ToAuditConfigArrayOutputWithContext(ctx context.Context) AuditConfigArrayOutput

type AuditConfigArrayInput

type AuditConfigArrayInput interface {
	pulumi.Input

	ToAuditConfigArrayOutput() AuditConfigArrayOutput
	ToAuditConfigArrayOutputWithContext(context.Context) AuditConfigArrayOutput
}

AuditConfigArrayInput is an input type that accepts AuditConfigArray and AuditConfigArrayOutput values. You can construct a concrete instance of `AuditConfigArrayInput` via:

AuditConfigArray{ AuditConfigArgs{...} }

type AuditConfigArrayOutput

type AuditConfigArrayOutput struct{ *pulumi.OutputState }

func (AuditConfigArrayOutput) ElementType

func (AuditConfigArrayOutput) ElementType() reflect.Type

func (AuditConfigArrayOutput) Index

func (AuditConfigArrayOutput) ToAuditConfigArrayOutput

func (o AuditConfigArrayOutput) ToAuditConfigArrayOutput() AuditConfigArrayOutput

func (AuditConfigArrayOutput) ToAuditConfigArrayOutputWithContext

func (o AuditConfigArrayOutput) ToAuditConfigArrayOutputWithContext(ctx context.Context) AuditConfigArrayOutput

type AuditConfigInput

type AuditConfigInput interface {
	pulumi.Input

	ToAuditConfigOutput() AuditConfigOutput
	ToAuditConfigOutputWithContext(context.Context) AuditConfigOutput
}

AuditConfigInput is an input type that accepts AuditConfigArgs and AuditConfigOutput values. You can construct a concrete instance of `AuditConfigInput` via:

AuditConfigArgs{...}

type AuditConfigOutput

type AuditConfigOutput struct{ *pulumi.OutputState }

Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.

func (AuditConfigOutput) AuditLogConfigs

func (o AuditConfigOutput) AuditLogConfigs() AuditLogConfigArrayOutput

The configuration for logging of each type of permission.

func (AuditConfigOutput) ElementType

func (AuditConfigOutput) ElementType() reflect.Type

func (AuditConfigOutput) Service

Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.

func (AuditConfigOutput) ToAuditConfigOutput

func (o AuditConfigOutput) ToAuditConfigOutput() AuditConfigOutput

func (AuditConfigOutput) ToAuditConfigOutputWithContext

func (o AuditConfigOutput) ToAuditConfigOutputWithContext(ctx context.Context) AuditConfigOutput

type AuditConfigResponse

type AuditConfigResponse struct {
	// The configuration for logging of each type of permission.
	AuditLogConfigs []AuditLogConfigResponse `pulumi:"auditLogConfigs"`
	// Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
	Service string `pulumi:"service"`
}

Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.

type AuditConfigResponseArrayOutput

type AuditConfigResponseArrayOutput struct{ *pulumi.OutputState }

func (AuditConfigResponseArrayOutput) ElementType

func (AuditConfigResponseArrayOutput) Index

func (AuditConfigResponseArrayOutput) ToAuditConfigResponseArrayOutput

func (o AuditConfigResponseArrayOutput) ToAuditConfigResponseArrayOutput() AuditConfigResponseArrayOutput

func (AuditConfigResponseArrayOutput) ToAuditConfigResponseArrayOutputWithContext

func (o AuditConfigResponseArrayOutput) ToAuditConfigResponseArrayOutputWithContext(ctx context.Context) AuditConfigResponseArrayOutput

type AuditConfigResponseOutput

type AuditConfigResponseOutput struct{ *pulumi.OutputState }

Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.

func (AuditConfigResponseOutput) AuditLogConfigs

The configuration for logging of each type of permission.

func (AuditConfigResponseOutput) ElementType

func (AuditConfigResponseOutput) ElementType() reflect.Type

func (AuditConfigResponseOutput) Service

Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.

func (AuditConfigResponseOutput) ToAuditConfigResponseOutput

func (o AuditConfigResponseOutput) ToAuditConfigResponseOutput() AuditConfigResponseOutput

func (AuditConfigResponseOutput) ToAuditConfigResponseOutputWithContext

func (o AuditConfigResponseOutput) ToAuditConfigResponseOutputWithContext(ctx context.Context) AuditConfigResponseOutput

type AuditLogConfig

type AuditLogConfig struct {
	// Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
	ExemptedMembers []string `pulumi:"exemptedMembers"`
	// The log type that this config enables.
	LogType *AuditLogConfigLogType `pulumi:"logType"`
}

Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

type AuditLogConfigArgs

type AuditLogConfigArgs struct {
	// Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
	ExemptedMembers pulumi.StringArrayInput `pulumi:"exemptedMembers"`
	// The log type that this config enables.
	LogType AuditLogConfigLogTypePtrInput `pulumi:"logType"`
}

Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

func (AuditLogConfigArgs) ElementType

func (AuditLogConfigArgs) ElementType() reflect.Type

func (AuditLogConfigArgs) ToAuditLogConfigOutput

func (i AuditLogConfigArgs) ToAuditLogConfigOutput() AuditLogConfigOutput

func (AuditLogConfigArgs) ToAuditLogConfigOutputWithContext

func (i AuditLogConfigArgs) ToAuditLogConfigOutputWithContext(ctx context.Context) AuditLogConfigOutput

type AuditLogConfigArray

type AuditLogConfigArray []AuditLogConfigInput

func (AuditLogConfigArray) ElementType

func (AuditLogConfigArray) ElementType() reflect.Type

func (AuditLogConfigArray) ToAuditLogConfigArrayOutput

func (i AuditLogConfigArray) ToAuditLogConfigArrayOutput() AuditLogConfigArrayOutput

func (AuditLogConfigArray) ToAuditLogConfigArrayOutputWithContext

func (i AuditLogConfigArray) ToAuditLogConfigArrayOutputWithContext(ctx context.Context) AuditLogConfigArrayOutput

type AuditLogConfigArrayInput

type AuditLogConfigArrayInput interface {
	pulumi.Input

	ToAuditLogConfigArrayOutput() AuditLogConfigArrayOutput
	ToAuditLogConfigArrayOutputWithContext(context.Context) AuditLogConfigArrayOutput
}

AuditLogConfigArrayInput is an input type that accepts AuditLogConfigArray and AuditLogConfigArrayOutput values. You can construct a concrete instance of `AuditLogConfigArrayInput` via:

AuditLogConfigArray{ AuditLogConfigArgs{...} }

type AuditLogConfigArrayOutput

type AuditLogConfigArrayOutput struct{ *pulumi.OutputState }

func (AuditLogConfigArrayOutput) ElementType

func (AuditLogConfigArrayOutput) ElementType() reflect.Type

func (AuditLogConfigArrayOutput) Index

func (AuditLogConfigArrayOutput) ToAuditLogConfigArrayOutput

func (o AuditLogConfigArrayOutput) ToAuditLogConfigArrayOutput() AuditLogConfigArrayOutput

func (AuditLogConfigArrayOutput) ToAuditLogConfigArrayOutputWithContext

func (o AuditLogConfigArrayOutput) ToAuditLogConfigArrayOutputWithContext(ctx context.Context) AuditLogConfigArrayOutput

type AuditLogConfigInput

type AuditLogConfigInput interface {
	pulumi.Input

	ToAuditLogConfigOutput() AuditLogConfigOutput
	ToAuditLogConfigOutputWithContext(context.Context) AuditLogConfigOutput
}

AuditLogConfigInput is an input type that accepts AuditLogConfigArgs and AuditLogConfigOutput values. You can construct a concrete instance of `AuditLogConfigInput` via:

AuditLogConfigArgs{...}

type AuditLogConfigLogType added in v0.4.0

type AuditLogConfigLogType string

The log type that this config enables.

func (AuditLogConfigLogType) ElementType added in v0.4.0

func (AuditLogConfigLogType) ElementType() reflect.Type

func (AuditLogConfigLogType) ToAuditLogConfigLogTypeOutput added in v0.6.0

func (e AuditLogConfigLogType) ToAuditLogConfigLogTypeOutput() AuditLogConfigLogTypeOutput

func (AuditLogConfigLogType) ToAuditLogConfigLogTypeOutputWithContext added in v0.6.0

func (e AuditLogConfigLogType) ToAuditLogConfigLogTypeOutputWithContext(ctx context.Context) AuditLogConfigLogTypeOutput

func (AuditLogConfigLogType) ToAuditLogConfigLogTypePtrOutput added in v0.6.0

func (e AuditLogConfigLogType) ToAuditLogConfigLogTypePtrOutput() AuditLogConfigLogTypePtrOutput

func (AuditLogConfigLogType) ToAuditLogConfigLogTypePtrOutputWithContext added in v0.6.0

func (e AuditLogConfigLogType) ToAuditLogConfigLogTypePtrOutputWithContext(ctx context.Context) AuditLogConfigLogTypePtrOutput

func (AuditLogConfigLogType) ToStringOutput added in v0.4.0

func (e AuditLogConfigLogType) ToStringOutput() pulumi.StringOutput

func (AuditLogConfigLogType) ToStringOutputWithContext added in v0.4.0

func (e AuditLogConfigLogType) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (AuditLogConfigLogType) ToStringPtrOutput added in v0.4.0

func (e AuditLogConfigLogType) ToStringPtrOutput() pulumi.StringPtrOutput

func (AuditLogConfigLogType) ToStringPtrOutputWithContext added in v0.4.0

func (e AuditLogConfigLogType) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type AuditLogConfigLogTypeInput added in v0.6.0

type AuditLogConfigLogTypeInput interface {
	pulumi.Input

	ToAuditLogConfigLogTypeOutput() AuditLogConfigLogTypeOutput
	ToAuditLogConfigLogTypeOutputWithContext(context.Context) AuditLogConfigLogTypeOutput
}

AuditLogConfigLogTypeInput is an input type that accepts AuditLogConfigLogTypeArgs and AuditLogConfigLogTypeOutput values. You can construct a concrete instance of `AuditLogConfigLogTypeInput` via:

AuditLogConfigLogTypeArgs{...}

type AuditLogConfigLogTypeOutput added in v0.6.0

type AuditLogConfigLogTypeOutput struct{ *pulumi.OutputState }

func (AuditLogConfigLogTypeOutput) ElementType added in v0.6.0

func (AuditLogConfigLogTypeOutput) ToAuditLogConfigLogTypeOutput added in v0.6.0

func (o AuditLogConfigLogTypeOutput) ToAuditLogConfigLogTypeOutput() AuditLogConfigLogTypeOutput

func (AuditLogConfigLogTypeOutput) ToAuditLogConfigLogTypeOutputWithContext added in v0.6.0

func (o AuditLogConfigLogTypeOutput) ToAuditLogConfigLogTypeOutputWithContext(ctx context.Context) AuditLogConfigLogTypeOutput

func (AuditLogConfigLogTypeOutput) ToAuditLogConfigLogTypePtrOutput added in v0.6.0

func (o AuditLogConfigLogTypeOutput) ToAuditLogConfigLogTypePtrOutput() AuditLogConfigLogTypePtrOutput

func (AuditLogConfigLogTypeOutput) ToAuditLogConfigLogTypePtrOutputWithContext added in v0.6.0

func (o AuditLogConfigLogTypeOutput) ToAuditLogConfigLogTypePtrOutputWithContext(ctx context.Context) AuditLogConfigLogTypePtrOutput

func (AuditLogConfigLogTypeOutput) ToStringOutput added in v0.6.0

func (o AuditLogConfigLogTypeOutput) ToStringOutput() pulumi.StringOutput

func (AuditLogConfigLogTypeOutput) ToStringOutputWithContext added in v0.6.0

func (o AuditLogConfigLogTypeOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (AuditLogConfigLogTypeOutput) ToStringPtrOutput added in v0.6.0

func (o AuditLogConfigLogTypeOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (AuditLogConfigLogTypeOutput) ToStringPtrOutputWithContext added in v0.6.0

func (o AuditLogConfigLogTypeOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type AuditLogConfigLogTypePtrInput added in v0.6.0

type AuditLogConfigLogTypePtrInput interface {
	pulumi.Input

	ToAuditLogConfigLogTypePtrOutput() AuditLogConfigLogTypePtrOutput
	ToAuditLogConfigLogTypePtrOutputWithContext(context.Context) AuditLogConfigLogTypePtrOutput
}

func AuditLogConfigLogTypePtr added in v0.6.0

func AuditLogConfigLogTypePtr(v string) AuditLogConfigLogTypePtrInput

type AuditLogConfigLogTypePtrOutput added in v0.6.0

type AuditLogConfigLogTypePtrOutput struct{ *pulumi.OutputState }

func (AuditLogConfigLogTypePtrOutput) Elem added in v0.6.0

func (AuditLogConfigLogTypePtrOutput) ElementType added in v0.6.0

func (AuditLogConfigLogTypePtrOutput) ToAuditLogConfigLogTypePtrOutput added in v0.6.0

func (o AuditLogConfigLogTypePtrOutput) ToAuditLogConfigLogTypePtrOutput() AuditLogConfigLogTypePtrOutput

func (AuditLogConfigLogTypePtrOutput) ToAuditLogConfigLogTypePtrOutputWithContext added in v0.6.0

func (o AuditLogConfigLogTypePtrOutput) ToAuditLogConfigLogTypePtrOutputWithContext(ctx context.Context) AuditLogConfigLogTypePtrOutput

func (AuditLogConfigLogTypePtrOutput) ToStringPtrOutput added in v0.6.0

func (AuditLogConfigLogTypePtrOutput) ToStringPtrOutputWithContext added in v0.6.0

func (o AuditLogConfigLogTypePtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type AuditLogConfigOutput

type AuditLogConfigOutput struct{ *pulumi.OutputState }

Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

func (AuditLogConfigOutput) ElementType

func (AuditLogConfigOutput) ElementType() reflect.Type

func (AuditLogConfigOutput) ExemptedMembers

func (o AuditLogConfigOutput) ExemptedMembers() pulumi.StringArrayOutput

Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.

func (AuditLogConfigOutput) LogType

The log type that this config enables.

func (AuditLogConfigOutput) ToAuditLogConfigOutput

func (o AuditLogConfigOutput) ToAuditLogConfigOutput() AuditLogConfigOutput

func (AuditLogConfigOutput) ToAuditLogConfigOutputWithContext

func (o AuditLogConfigOutput) ToAuditLogConfigOutputWithContext(ctx context.Context) AuditLogConfigOutput

type AuditLogConfigResponse

type AuditLogConfigResponse struct {
	// Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
	ExemptedMembers []string `pulumi:"exemptedMembers"`
	// The log type that this config enables.
	LogType string `pulumi:"logType"`
}

Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

type AuditLogConfigResponseArrayOutput

type AuditLogConfigResponseArrayOutput struct{ *pulumi.OutputState }

func (AuditLogConfigResponseArrayOutput) ElementType

func (AuditLogConfigResponseArrayOutput) Index

func (AuditLogConfigResponseArrayOutput) ToAuditLogConfigResponseArrayOutput

func (o AuditLogConfigResponseArrayOutput) ToAuditLogConfigResponseArrayOutput() AuditLogConfigResponseArrayOutput

func (AuditLogConfigResponseArrayOutput) ToAuditLogConfigResponseArrayOutputWithContext

func (o AuditLogConfigResponseArrayOutput) ToAuditLogConfigResponseArrayOutputWithContext(ctx context.Context) AuditLogConfigResponseArrayOutput

type AuditLogConfigResponseOutput

type AuditLogConfigResponseOutput struct{ *pulumi.OutputState }

Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

func (AuditLogConfigResponseOutput) ElementType

func (AuditLogConfigResponseOutput) ExemptedMembers

Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.

func (AuditLogConfigResponseOutput) LogType

The log type that this config enables.

func (AuditLogConfigResponseOutput) ToAuditLogConfigResponseOutput

func (o AuditLogConfigResponseOutput) ToAuditLogConfigResponseOutput() AuditLogConfigResponseOutput

func (AuditLogConfigResponseOutput) ToAuditLogConfigResponseOutputWithContext

func (o AuditLogConfigResponseOutput) ToAuditLogConfigResponseOutputWithContext(ctx context.Context) AuditLogConfigResponseOutput

type AuthProvider

type AuthProvider struct {
	// The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, JWTs with audiences: - "https://[service.name]/[google.protobuf.Api.name]" - "https://[service.name]/" will be accepted. For example, if no audiences are in the setting, LibraryService API will accept JWTs with the following audiences: - https://library-example.googleapis.com/google.example.library.v1.LibraryService - https://library-example.googleapis.com/ Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com
	Audiences *string `pulumi:"audiences"`
	// Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec.
	AuthorizationUrl *string `pulumi:"authorizationUrl"`
	// The unique identifier of the auth provider. It will be referred to by `AuthRequirement.provider_id`. Example: "bookstore_auth".
	Id *string `pulumi:"id"`
	// Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com
	Issuer *string `pulumi:"issuer"`
	// URL of the provider's public key set to validate signature of the JWT. See [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). Optional if the key set document: - can be retrieved from [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html) of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs
	JwksUri *string `pulumi:"jwksUri"`
	// Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension [x-google-jwt-locations] (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations: - header: Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - query: access_token
	JwtLocations []JwtLocation `pulumi:"jwtLocations"`
}

Configuration for an authentication provider, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).

type AuthProviderArgs

type AuthProviderArgs struct {
	// The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, JWTs with audiences: - "https://[service.name]/[google.protobuf.Api.name]" - "https://[service.name]/" will be accepted. For example, if no audiences are in the setting, LibraryService API will accept JWTs with the following audiences: - https://library-example.googleapis.com/google.example.library.v1.LibraryService - https://library-example.googleapis.com/ Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com
	Audiences pulumi.StringPtrInput `pulumi:"audiences"`
	// Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec.
	AuthorizationUrl pulumi.StringPtrInput `pulumi:"authorizationUrl"`
	// The unique identifier of the auth provider. It will be referred to by `AuthRequirement.provider_id`. Example: "bookstore_auth".
	Id pulumi.StringPtrInput `pulumi:"id"`
	// Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com
	Issuer pulumi.StringPtrInput `pulumi:"issuer"`
	// URL of the provider's public key set to validate signature of the JWT. See [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). Optional if the key set document: - can be retrieved from [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html) of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs
	JwksUri pulumi.StringPtrInput `pulumi:"jwksUri"`
	// Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension [x-google-jwt-locations] (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations: - header: Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - query: access_token
	JwtLocations JwtLocationArrayInput `pulumi:"jwtLocations"`
}

Configuration for an authentication provider, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).

func (AuthProviderArgs) ElementType

func (AuthProviderArgs) ElementType() reflect.Type

func (AuthProviderArgs) ToAuthProviderOutput

func (i AuthProviderArgs) ToAuthProviderOutput() AuthProviderOutput

func (AuthProviderArgs) ToAuthProviderOutputWithContext

func (i AuthProviderArgs) ToAuthProviderOutputWithContext(ctx context.Context) AuthProviderOutput

type AuthProviderArray

type AuthProviderArray []AuthProviderInput

func (AuthProviderArray) ElementType

func (AuthProviderArray) ElementType() reflect.Type

func (AuthProviderArray) ToAuthProviderArrayOutput

func (i AuthProviderArray) ToAuthProviderArrayOutput() AuthProviderArrayOutput

func (AuthProviderArray) ToAuthProviderArrayOutputWithContext

func (i AuthProviderArray) ToAuthProviderArrayOutputWithContext(ctx context.Context) AuthProviderArrayOutput

type AuthProviderArrayInput

type AuthProviderArrayInput interface {
	pulumi.Input

	ToAuthProviderArrayOutput() AuthProviderArrayOutput
	ToAuthProviderArrayOutputWithContext(context.Context) AuthProviderArrayOutput
}

AuthProviderArrayInput is an input type that accepts AuthProviderArray and AuthProviderArrayOutput values. You can construct a concrete instance of `AuthProviderArrayInput` via:

AuthProviderArray{ AuthProviderArgs{...} }

type AuthProviderArrayOutput

type AuthProviderArrayOutput struct{ *pulumi.OutputState }

func (AuthProviderArrayOutput) ElementType

func (AuthProviderArrayOutput) ElementType() reflect.Type

func (AuthProviderArrayOutput) Index

func (AuthProviderArrayOutput) ToAuthProviderArrayOutput

func (o AuthProviderArrayOutput) ToAuthProviderArrayOutput() AuthProviderArrayOutput

func (AuthProviderArrayOutput) ToAuthProviderArrayOutputWithContext

func (o AuthProviderArrayOutput) ToAuthProviderArrayOutputWithContext(ctx context.Context) AuthProviderArrayOutput

type AuthProviderInput

type AuthProviderInput interface {
	pulumi.Input

	ToAuthProviderOutput() AuthProviderOutput
	ToAuthProviderOutputWithContext(context.Context) AuthProviderOutput
}

AuthProviderInput is an input type that accepts AuthProviderArgs and AuthProviderOutput values. You can construct a concrete instance of `AuthProviderInput` via:

AuthProviderArgs{...}

type AuthProviderOutput

type AuthProviderOutput struct{ *pulumi.OutputState }

Configuration for an authentication provider, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).

func (AuthProviderOutput) Audiences

The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, JWTs with audiences: - "https://[service.name]/[google.protobuf.Api.name]" - "https://[service.name]/" will be accepted. For example, if no audiences are in the setting, LibraryService API will accept JWTs with the following audiences: - https://library-example.googleapis.com/google.example.library.v1.LibraryService - https://library-example.googleapis.com/ Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com

func (AuthProviderOutput) AuthorizationUrl

func (o AuthProviderOutput) AuthorizationUrl() pulumi.StringPtrOutput

Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec.

func (AuthProviderOutput) ElementType

func (AuthProviderOutput) ElementType() reflect.Type

func (AuthProviderOutput) Id

The unique identifier of the auth provider. It will be referred to by `AuthRequirement.provider_id`. Example: "bookstore_auth".

func (AuthProviderOutput) Issuer

Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com

func (AuthProviderOutput) JwksUri

URL of the provider's public key set to validate signature of the JWT. See [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). Optional if the key set document: - can be retrieved from [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html) of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs

func (AuthProviderOutput) JwtLocations

func (o AuthProviderOutput) JwtLocations() JwtLocationArrayOutput

Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension [x-google-jwt-locations] (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations: - header: Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - query: access_token

func (AuthProviderOutput) ToAuthProviderOutput

func (o AuthProviderOutput) ToAuthProviderOutput() AuthProviderOutput

func (AuthProviderOutput) ToAuthProviderOutputWithContext

func (o AuthProviderOutput) ToAuthProviderOutputWithContext(ctx context.Context) AuthProviderOutput

type AuthProviderResponse

type AuthProviderResponse struct {
	// The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, JWTs with audiences: - "https://[service.name]/[google.protobuf.Api.name]" - "https://[service.name]/" will be accepted. For example, if no audiences are in the setting, LibraryService API will accept JWTs with the following audiences: - https://library-example.googleapis.com/google.example.library.v1.LibraryService - https://library-example.googleapis.com/ Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com
	Audiences string `pulumi:"audiences"`
	// Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec.
	AuthorizationUrl string `pulumi:"authorizationUrl"`
	// Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com
	Issuer string `pulumi:"issuer"`
	// URL of the provider's public key set to validate signature of the JWT. See [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). Optional if the key set document: - can be retrieved from [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html) of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs
	JwksUri string `pulumi:"jwksUri"`
	// Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension [x-google-jwt-locations] (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations: - header: Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - query: access_token
	JwtLocations []JwtLocationResponse `pulumi:"jwtLocations"`
}

Configuration for an authentication provider, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).

type AuthProviderResponseArrayOutput

type AuthProviderResponseArrayOutput struct{ *pulumi.OutputState }

func (AuthProviderResponseArrayOutput) ElementType

func (AuthProviderResponseArrayOutput) Index

func (AuthProviderResponseArrayOutput) ToAuthProviderResponseArrayOutput

func (o AuthProviderResponseArrayOutput) ToAuthProviderResponseArrayOutput() AuthProviderResponseArrayOutput

func (AuthProviderResponseArrayOutput) ToAuthProviderResponseArrayOutputWithContext

func (o AuthProviderResponseArrayOutput) ToAuthProviderResponseArrayOutputWithContext(ctx context.Context) AuthProviderResponseArrayOutput

type AuthProviderResponseOutput

type AuthProviderResponseOutput struct{ *pulumi.OutputState }

Configuration for an authentication provider, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).

func (AuthProviderResponseOutput) Audiences

The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, JWTs with audiences: - "https://[service.name]/[google.protobuf.Api.name]" - "https://[service.name]/" will be accepted. For example, if no audiences are in the setting, LibraryService API will accept JWTs with the following audiences: - https://library-example.googleapis.com/google.example.library.v1.LibraryService - https://library-example.googleapis.com/ Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com

func (AuthProviderResponseOutput) AuthorizationUrl

func (o AuthProviderResponseOutput) AuthorizationUrl() pulumi.StringOutput

Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec.

func (AuthProviderResponseOutput) ElementType

func (AuthProviderResponseOutput) ElementType() reflect.Type

func (AuthProviderResponseOutput) Issuer

Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com

func (AuthProviderResponseOutput) JwksUri

URL of the provider's public key set to validate signature of the JWT. See [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). Optional if the key set document: - can be retrieved from [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html) of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs

func (AuthProviderResponseOutput) JwtLocations

Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension [x-google-jwt-locations] (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations: - header: Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - query: access_token

func (AuthProviderResponseOutput) ToAuthProviderResponseOutput

func (o AuthProviderResponseOutput) ToAuthProviderResponseOutput() AuthProviderResponseOutput

func (AuthProviderResponseOutput) ToAuthProviderResponseOutputWithContext

func (o AuthProviderResponseOutput) ToAuthProviderResponseOutputWithContext(ctx context.Context) AuthProviderResponseOutput

type AuthRequirement

type AuthRequirement struct {
	// NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com
	Audiences *string `pulumi:"audiences"`
	// id from authentication provider. Example: provider_id: bookstore_auth
	ProviderId *string `pulumi:"providerId"`
}

User-defined authentication requirements, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).

type AuthRequirementArgs

type AuthRequirementArgs struct {
	// NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com
	Audiences pulumi.StringPtrInput `pulumi:"audiences"`
	// id from authentication provider. Example: provider_id: bookstore_auth
	ProviderId pulumi.StringPtrInput `pulumi:"providerId"`
}

User-defined authentication requirements, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).

func (AuthRequirementArgs) ElementType

func (AuthRequirementArgs) ElementType() reflect.Type

func (AuthRequirementArgs) ToAuthRequirementOutput

func (i AuthRequirementArgs) ToAuthRequirementOutput() AuthRequirementOutput

func (AuthRequirementArgs) ToAuthRequirementOutputWithContext

func (i AuthRequirementArgs) ToAuthRequirementOutputWithContext(ctx context.Context) AuthRequirementOutput

type AuthRequirementArray

type AuthRequirementArray []AuthRequirementInput

func (AuthRequirementArray) ElementType

func (AuthRequirementArray) ElementType() reflect.Type

func (AuthRequirementArray) ToAuthRequirementArrayOutput

func (i AuthRequirementArray) ToAuthRequirementArrayOutput() AuthRequirementArrayOutput

func (AuthRequirementArray) ToAuthRequirementArrayOutputWithContext

func (i AuthRequirementArray) ToAuthRequirementArrayOutputWithContext(ctx context.Context) AuthRequirementArrayOutput

type AuthRequirementArrayInput

type AuthRequirementArrayInput interface {
	pulumi.Input

	ToAuthRequirementArrayOutput() AuthRequirementArrayOutput
	ToAuthRequirementArrayOutputWithContext(context.Context) AuthRequirementArrayOutput
}

AuthRequirementArrayInput is an input type that accepts AuthRequirementArray and AuthRequirementArrayOutput values. You can construct a concrete instance of `AuthRequirementArrayInput` via:

AuthRequirementArray{ AuthRequirementArgs{...} }

type AuthRequirementArrayOutput

type AuthRequirementArrayOutput struct{ *pulumi.OutputState }

func (AuthRequirementArrayOutput) ElementType

func (AuthRequirementArrayOutput) ElementType() reflect.Type

func (AuthRequirementArrayOutput) Index

func (AuthRequirementArrayOutput) ToAuthRequirementArrayOutput

func (o AuthRequirementArrayOutput) ToAuthRequirementArrayOutput() AuthRequirementArrayOutput

func (AuthRequirementArrayOutput) ToAuthRequirementArrayOutputWithContext

func (o AuthRequirementArrayOutput) ToAuthRequirementArrayOutputWithContext(ctx context.Context) AuthRequirementArrayOutput

type AuthRequirementInput

type AuthRequirementInput interface {
	pulumi.Input

	ToAuthRequirementOutput() AuthRequirementOutput
	ToAuthRequirementOutputWithContext(context.Context) AuthRequirementOutput
}

AuthRequirementInput is an input type that accepts AuthRequirementArgs and AuthRequirementOutput values. You can construct a concrete instance of `AuthRequirementInput` via:

AuthRequirementArgs{...}

type AuthRequirementOutput

type AuthRequirementOutput struct{ *pulumi.OutputState }

User-defined authentication requirements, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).

func (AuthRequirementOutput) Audiences

NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com

func (AuthRequirementOutput) ElementType

func (AuthRequirementOutput) ElementType() reflect.Type

func (AuthRequirementOutput) ProviderId

id from authentication provider. Example: provider_id: bookstore_auth

func (AuthRequirementOutput) ToAuthRequirementOutput

func (o AuthRequirementOutput) ToAuthRequirementOutput() AuthRequirementOutput

func (AuthRequirementOutput) ToAuthRequirementOutputWithContext

func (o AuthRequirementOutput) ToAuthRequirementOutputWithContext(ctx context.Context) AuthRequirementOutput

type AuthRequirementResponse

type AuthRequirementResponse struct {
	// NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com
	Audiences string `pulumi:"audiences"`
	// id from authentication provider. Example: provider_id: bookstore_auth
	ProviderId string `pulumi:"providerId"`
}

User-defined authentication requirements, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).

type AuthRequirementResponseArrayOutput

type AuthRequirementResponseArrayOutput struct{ *pulumi.OutputState }

func (AuthRequirementResponseArrayOutput) ElementType

func (AuthRequirementResponseArrayOutput) Index

func (AuthRequirementResponseArrayOutput) ToAuthRequirementResponseArrayOutput

func (o AuthRequirementResponseArrayOutput) ToAuthRequirementResponseArrayOutput() AuthRequirementResponseArrayOutput

func (AuthRequirementResponseArrayOutput) ToAuthRequirementResponseArrayOutputWithContext

func (o AuthRequirementResponseArrayOutput) ToAuthRequirementResponseArrayOutputWithContext(ctx context.Context) AuthRequirementResponseArrayOutput

type AuthRequirementResponseOutput

type AuthRequirementResponseOutput struct{ *pulumi.OutputState }

User-defined authentication requirements, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).

func (AuthRequirementResponseOutput) Audiences

NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com

func (AuthRequirementResponseOutput) ElementType

func (AuthRequirementResponseOutput) ProviderId

id from authentication provider. Example: provider_id: bookstore_auth

func (AuthRequirementResponseOutput) ToAuthRequirementResponseOutput

func (o AuthRequirementResponseOutput) ToAuthRequirementResponseOutput() AuthRequirementResponseOutput

func (AuthRequirementResponseOutput) ToAuthRequirementResponseOutputWithContext

func (o AuthRequirementResponseOutput) ToAuthRequirementResponseOutputWithContext(ctx context.Context) AuthRequirementResponseOutput

type Authentication

type Authentication struct {
	// Defines a set of authentication providers that a service supports.
	Providers []AuthProvider `pulumi:"providers"`
	// A list of authentication rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order.
	Rules []AuthenticationRule `pulumi:"rules"`
}

`Authentication` defines the authentication configuration for API methods provided by an API service. Example: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth - selector: google.calendar.Delegate oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read

type AuthenticationArgs

type AuthenticationArgs struct {
	// Defines a set of authentication providers that a service supports.
	Providers AuthProviderArrayInput `pulumi:"providers"`
	// A list of authentication rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order.
	Rules AuthenticationRuleArrayInput `pulumi:"rules"`
}

`Authentication` defines the authentication configuration for API methods provided by an API service. Example: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth - selector: google.calendar.Delegate oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read

func (AuthenticationArgs) ElementType

func (AuthenticationArgs) ElementType() reflect.Type

func (AuthenticationArgs) ToAuthenticationOutput

func (i AuthenticationArgs) ToAuthenticationOutput() AuthenticationOutput

func (AuthenticationArgs) ToAuthenticationOutputWithContext

func (i AuthenticationArgs) ToAuthenticationOutputWithContext(ctx context.Context) AuthenticationOutput

func (AuthenticationArgs) ToAuthenticationPtrOutput

func (i AuthenticationArgs) ToAuthenticationPtrOutput() AuthenticationPtrOutput

func (AuthenticationArgs) ToAuthenticationPtrOutputWithContext

func (i AuthenticationArgs) ToAuthenticationPtrOutputWithContext(ctx context.Context) AuthenticationPtrOutput

type AuthenticationInput

type AuthenticationInput interface {
	pulumi.Input

	ToAuthenticationOutput() AuthenticationOutput
	ToAuthenticationOutputWithContext(context.Context) AuthenticationOutput
}

AuthenticationInput is an input type that accepts AuthenticationArgs and AuthenticationOutput values. You can construct a concrete instance of `AuthenticationInput` via:

AuthenticationArgs{...}

type AuthenticationOutput

type AuthenticationOutput struct{ *pulumi.OutputState }

`Authentication` defines the authentication configuration for API methods provided by an API service. Example: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth - selector: google.calendar.Delegate oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read

func (AuthenticationOutput) ElementType

func (AuthenticationOutput) ElementType() reflect.Type

func (AuthenticationOutput) Providers

Defines a set of authentication providers that a service supports.

func (AuthenticationOutput) Rules

A list of authentication rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order.

func (AuthenticationOutput) ToAuthenticationOutput

func (o AuthenticationOutput) ToAuthenticationOutput() AuthenticationOutput

func (AuthenticationOutput) ToAuthenticationOutputWithContext

func (o AuthenticationOutput) ToAuthenticationOutputWithContext(ctx context.Context) AuthenticationOutput

func (AuthenticationOutput) ToAuthenticationPtrOutput

func (o AuthenticationOutput) ToAuthenticationPtrOutput() AuthenticationPtrOutput

func (AuthenticationOutput) ToAuthenticationPtrOutputWithContext

func (o AuthenticationOutput) ToAuthenticationPtrOutputWithContext(ctx context.Context) AuthenticationPtrOutput

type AuthenticationPtrInput

type AuthenticationPtrInput interface {
	pulumi.Input

	ToAuthenticationPtrOutput() AuthenticationPtrOutput
	ToAuthenticationPtrOutputWithContext(context.Context) AuthenticationPtrOutput
}

AuthenticationPtrInput is an input type that accepts AuthenticationArgs, AuthenticationPtr and AuthenticationPtrOutput values. You can construct a concrete instance of `AuthenticationPtrInput` via:

        AuthenticationArgs{...}

or:

        nil

type AuthenticationPtrOutput

type AuthenticationPtrOutput struct{ *pulumi.OutputState }

func (AuthenticationPtrOutput) Elem

func (AuthenticationPtrOutput) ElementType

func (AuthenticationPtrOutput) ElementType() reflect.Type

func (AuthenticationPtrOutput) Providers

Defines a set of authentication providers that a service supports.

func (AuthenticationPtrOutput) Rules

A list of authentication rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order.

func (AuthenticationPtrOutput) ToAuthenticationPtrOutput

func (o AuthenticationPtrOutput) ToAuthenticationPtrOutput() AuthenticationPtrOutput

func (AuthenticationPtrOutput) ToAuthenticationPtrOutputWithContext

func (o AuthenticationPtrOutput) ToAuthenticationPtrOutputWithContext(ctx context.Context) AuthenticationPtrOutput

type AuthenticationResponse

type AuthenticationResponse struct {
	// Defines a set of authentication providers that a service supports.
	Providers []AuthProviderResponse `pulumi:"providers"`
	// A list of authentication rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order.
	Rules []AuthenticationRuleResponse `pulumi:"rules"`
}

`Authentication` defines the authentication configuration for API methods provided by an API service. Example: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth - selector: google.calendar.Delegate oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read

type AuthenticationResponseOutput

type AuthenticationResponseOutput struct{ *pulumi.OutputState }

`Authentication` defines the authentication configuration for API methods provided by an API service. Example: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth - selector: google.calendar.Delegate oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read

func (AuthenticationResponseOutput) ElementType

func (AuthenticationResponseOutput) Providers

Defines a set of authentication providers that a service supports.

func (AuthenticationResponseOutput) Rules

A list of authentication rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order.

func (AuthenticationResponseOutput) ToAuthenticationResponseOutput

func (o AuthenticationResponseOutput) ToAuthenticationResponseOutput() AuthenticationResponseOutput

func (AuthenticationResponseOutput) ToAuthenticationResponseOutputWithContext

func (o AuthenticationResponseOutput) ToAuthenticationResponseOutputWithContext(ctx context.Context) AuthenticationResponseOutput

type AuthenticationRule

type AuthenticationRule struct {
	// If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests.
	AllowWithoutCredential *bool `pulumi:"allowWithoutCredential"`
	// The requirements for OAuth credentials.
	Oauth *OAuthRequirements `pulumi:"oauth"`
	// Requirements for additional authentication providers.
	Requirements []AuthRequirement `pulumi:"requirements"`
	// Selects the methods to which this rule applies. Refer to selector for syntax details.
	Selector *string `pulumi:"selector"`
}

Authentication rules for the service. By default, if a method has any authentication requirements, every request must include a valid credential matching one of the requirements. It's an error to include more than one kind of credential in a single request. If a method doesn't have any auth requirements, request credentials will be ignored.

type AuthenticationRuleArgs

type AuthenticationRuleArgs struct {
	// If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests.
	AllowWithoutCredential pulumi.BoolPtrInput `pulumi:"allowWithoutCredential"`
	// The requirements for OAuth credentials.
	Oauth OAuthRequirementsPtrInput `pulumi:"oauth"`
	// Requirements for additional authentication providers.
	Requirements AuthRequirementArrayInput `pulumi:"requirements"`
	// Selects the methods to which this rule applies. Refer to selector for syntax details.
	Selector pulumi.StringPtrInput `pulumi:"selector"`
}

Authentication rules for the service. By default, if a method has any authentication requirements, every request must include a valid credential matching one of the requirements. It's an error to include more than one kind of credential in a single request. If a method doesn't have any auth requirements, request credentials will be ignored.

func (AuthenticationRuleArgs) ElementType

func (AuthenticationRuleArgs) ElementType() reflect.Type

func (AuthenticationRuleArgs) ToAuthenticationRuleOutput

func (i AuthenticationRuleArgs) ToAuthenticationRuleOutput() AuthenticationRuleOutput

func (AuthenticationRuleArgs) ToAuthenticationRuleOutputWithContext

func (i AuthenticationRuleArgs) ToAuthenticationRuleOutputWithContext(ctx context.Context) AuthenticationRuleOutput

type AuthenticationRuleArray

type AuthenticationRuleArray []AuthenticationRuleInput

func (AuthenticationRuleArray) ElementType

func (AuthenticationRuleArray) ElementType() reflect.Type

func (AuthenticationRuleArray) ToAuthenticationRuleArrayOutput

func (i AuthenticationRuleArray) ToAuthenticationRuleArrayOutput() AuthenticationRuleArrayOutput

func (AuthenticationRuleArray) ToAuthenticationRuleArrayOutputWithContext

func (i AuthenticationRuleArray) ToAuthenticationRuleArrayOutputWithContext(ctx context.Context) AuthenticationRuleArrayOutput

type AuthenticationRuleArrayInput

type AuthenticationRuleArrayInput interface {
	pulumi.Input

	ToAuthenticationRuleArrayOutput() AuthenticationRuleArrayOutput
	ToAuthenticationRuleArrayOutputWithContext(context.Context) AuthenticationRuleArrayOutput
}

AuthenticationRuleArrayInput is an input type that accepts AuthenticationRuleArray and AuthenticationRuleArrayOutput values. You can construct a concrete instance of `AuthenticationRuleArrayInput` via:

AuthenticationRuleArray{ AuthenticationRuleArgs{...} }

type AuthenticationRuleArrayOutput

type AuthenticationRuleArrayOutput struct{ *pulumi.OutputState }

func (AuthenticationRuleArrayOutput) ElementType

func (AuthenticationRuleArrayOutput) Index

func (AuthenticationRuleArrayOutput) ToAuthenticationRuleArrayOutput

func (o AuthenticationRuleArrayOutput) ToAuthenticationRuleArrayOutput() AuthenticationRuleArrayOutput

func (AuthenticationRuleArrayOutput) ToAuthenticationRuleArrayOutputWithContext

func (o AuthenticationRuleArrayOutput) ToAuthenticationRuleArrayOutputWithContext(ctx context.Context) AuthenticationRuleArrayOutput

type AuthenticationRuleInput

type AuthenticationRuleInput interface {
	pulumi.Input

	ToAuthenticationRuleOutput() AuthenticationRuleOutput
	ToAuthenticationRuleOutputWithContext(context.Context) AuthenticationRuleOutput
}

AuthenticationRuleInput is an input type that accepts AuthenticationRuleArgs and AuthenticationRuleOutput values. You can construct a concrete instance of `AuthenticationRuleInput` via:

AuthenticationRuleArgs{...}

type AuthenticationRuleOutput

type AuthenticationRuleOutput struct{ *pulumi.OutputState }

Authentication rules for the service. By default, if a method has any authentication requirements, every request must include a valid credential matching one of the requirements. It's an error to include more than one kind of credential in a single request. If a method doesn't have any auth requirements, request credentials will be ignored.

func (AuthenticationRuleOutput) AllowWithoutCredential

func (o AuthenticationRuleOutput) AllowWithoutCredential() pulumi.BoolPtrOutput

If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests.

func (AuthenticationRuleOutput) ElementType

func (AuthenticationRuleOutput) ElementType() reflect.Type

func (AuthenticationRuleOutput) Oauth

The requirements for OAuth credentials.

func (AuthenticationRuleOutput) Requirements

Requirements for additional authentication providers.

func (AuthenticationRuleOutput) Selector

Selects the methods to which this rule applies. Refer to selector for syntax details.

func (AuthenticationRuleOutput) ToAuthenticationRuleOutput

func (o AuthenticationRuleOutput) ToAuthenticationRuleOutput() AuthenticationRuleOutput

func (AuthenticationRuleOutput) ToAuthenticationRuleOutputWithContext

func (o AuthenticationRuleOutput) ToAuthenticationRuleOutputWithContext(ctx context.Context) AuthenticationRuleOutput

type AuthenticationRuleResponse

type AuthenticationRuleResponse struct {
	// If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests.
	AllowWithoutCredential bool `pulumi:"allowWithoutCredential"`
	// The requirements for OAuth credentials.
	Oauth OAuthRequirementsResponse `pulumi:"oauth"`
	// Requirements for additional authentication providers.
	Requirements []AuthRequirementResponse `pulumi:"requirements"`
	// Selects the methods to which this rule applies. Refer to selector for syntax details.
	Selector string `pulumi:"selector"`
}

Authentication rules for the service. By default, if a method has any authentication requirements, every request must include a valid credential matching one of the requirements. It's an error to include more than one kind of credential in a single request. If a method doesn't have any auth requirements, request credentials will be ignored.

type AuthenticationRuleResponseArrayOutput

type AuthenticationRuleResponseArrayOutput struct{ *pulumi.OutputState }

func (AuthenticationRuleResponseArrayOutput) ElementType

func (AuthenticationRuleResponseArrayOutput) Index

func (AuthenticationRuleResponseArrayOutput) ToAuthenticationRuleResponseArrayOutput

func (o AuthenticationRuleResponseArrayOutput) ToAuthenticationRuleResponseArrayOutput() AuthenticationRuleResponseArrayOutput

func (AuthenticationRuleResponseArrayOutput) ToAuthenticationRuleResponseArrayOutputWithContext

func (o AuthenticationRuleResponseArrayOutput) ToAuthenticationRuleResponseArrayOutputWithContext(ctx context.Context) AuthenticationRuleResponseArrayOutput

type AuthenticationRuleResponseOutput

type AuthenticationRuleResponseOutput struct{ *pulumi.OutputState }

Authentication rules for the service. By default, if a method has any authentication requirements, every request must include a valid credential matching one of the requirements. It's an error to include more than one kind of credential in a single request. If a method doesn't have any auth requirements, request credentials will be ignored.

func (AuthenticationRuleResponseOutput) AllowWithoutCredential

func (o AuthenticationRuleResponseOutput) AllowWithoutCredential() pulumi.BoolOutput

If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests.

func (AuthenticationRuleResponseOutput) ElementType

func (AuthenticationRuleResponseOutput) Oauth

The requirements for OAuth credentials.

func (AuthenticationRuleResponseOutput) Requirements

Requirements for additional authentication providers.

func (AuthenticationRuleResponseOutput) Selector

Selects the methods to which this rule applies. Refer to selector for syntax details.

func (AuthenticationRuleResponseOutput) ToAuthenticationRuleResponseOutput

func (o AuthenticationRuleResponseOutput) ToAuthenticationRuleResponseOutput() AuthenticationRuleResponseOutput

func (AuthenticationRuleResponseOutput) ToAuthenticationRuleResponseOutputWithContext

func (o AuthenticationRuleResponseOutput) ToAuthenticationRuleResponseOutputWithContext(ctx context.Context) AuthenticationRuleResponseOutput

type Backend

type Backend struct {
	// A list of API backend rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order.
	Rules []BackendRule `pulumi:"rules"`
}

`Backend` defines the backend configuration for a service.

type BackendArgs

type BackendArgs struct {
	// A list of API backend rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order.
	Rules BackendRuleArrayInput `pulumi:"rules"`
}

`Backend` defines the backend configuration for a service.

func (BackendArgs) ElementType

func (BackendArgs) ElementType() reflect.Type

func (BackendArgs) ToBackendOutput

func (i BackendArgs) ToBackendOutput() BackendOutput

func (BackendArgs) ToBackendOutputWithContext

func (i BackendArgs) ToBackendOutputWithContext(ctx context.Context) BackendOutput

func (BackendArgs) ToBackendPtrOutput

func (i BackendArgs) ToBackendPtrOutput() BackendPtrOutput

func (BackendArgs) ToBackendPtrOutputWithContext

func (i BackendArgs) ToBackendPtrOutputWithContext(ctx context.Context) BackendPtrOutput

type BackendInput

type BackendInput interface {
	pulumi.Input

	ToBackendOutput() BackendOutput
	ToBackendOutputWithContext(context.Context) BackendOutput
}

BackendInput is an input type that accepts BackendArgs and BackendOutput values. You can construct a concrete instance of `BackendInput` via:

BackendArgs{...}

type BackendOutput

type BackendOutput struct{ *pulumi.OutputState }

`Backend` defines the backend configuration for a service.

func (BackendOutput) ElementType

func (BackendOutput) ElementType() reflect.Type

func (BackendOutput) Rules

A list of API backend rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order.

func (BackendOutput) ToBackendOutput

func (o BackendOutput) ToBackendOutput() BackendOutput

func (BackendOutput) ToBackendOutputWithContext

func (o BackendOutput) ToBackendOutputWithContext(ctx context.Context) BackendOutput

func (BackendOutput) ToBackendPtrOutput

func (o BackendOutput) ToBackendPtrOutput() BackendPtrOutput

func (BackendOutput) ToBackendPtrOutputWithContext

func (o BackendOutput) ToBackendPtrOutputWithContext(ctx context.Context) BackendPtrOutput

type BackendPtrInput

type BackendPtrInput interface {
	pulumi.Input

	ToBackendPtrOutput() BackendPtrOutput
	ToBackendPtrOutputWithContext(context.Context) BackendPtrOutput
}

BackendPtrInput is an input type that accepts BackendArgs, BackendPtr and BackendPtrOutput values. You can construct a concrete instance of `BackendPtrInput` via:

        BackendArgs{...}

or:

        nil

func BackendPtr

func BackendPtr(v *BackendArgs) BackendPtrInput

type BackendPtrOutput

type BackendPtrOutput struct{ *pulumi.OutputState }

func (BackendPtrOutput) Elem

func (BackendPtrOutput) ElementType

func (BackendPtrOutput) ElementType() reflect.Type

func (BackendPtrOutput) Rules

A list of API backend rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order.

func (BackendPtrOutput) ToBackendPtrOutput

func (o BackendPtrOutput) ToBackendPtrOutput() BackendPtrOutput

func (BackendPtrOutput) ToBackendPtrOutputWithContext

func (o BackendPtrOutput) ToBackendPtrOutputWithContext(ctx context.Context) BackendPtrOutput

type BackendResponse

type BackendResponse struct {
	// A list of API backend rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order.
	Rules []BackendRuleResponse `pulumi:"rules"`
}

`Backend` defines the backend configuration for a service.

type BackendResponseOutput

type BackendResponseOutput struct{ *pulumi.OutputState }

`Backend` defines the backend configuration for a service.

func (BackendResponseOutput) ElementType

func (BackendResponseOutput) ElementType() reflect.Type

func (BackendResponseOutput) Rules

A list of API backend rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order.

func (BackendResponseOutput) ToBackendResponseOutput

func (o BackendResponseOutput) ToBackendResponseOutput() BackendResponseOutput

func (BackendResponseOutput) ToBackendResponseOutputWithContext

func (o BackendResponseOutput) ToBackendResponseOutputWithContext(ctx context.Context) BackendResponseOutput

type BackendRule

type BackendRule struct {
	// The address of the API backend. The scheme is used to determine the backend protocol and security. The following schemes are accepted: SCHEME PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// gRPC None grpcs:// gRPC TLS It is recommended to explicitly include a scheme. Leaving out the scheme may cause constrasting behaviors across platforms. If the port is unspecified, the default is: - 80 for schemes without TLS - 443 for schemes with TLS For HTTP backends, use protocol to specify the protocol version.
	Address *string `pulumi:"address"`
	// The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment.
	Deadline *float64 `pulumi:"deadline"`
	// When disable_auth is true, a JWT ID token won't be generated and the original "Authorization" HTTP header will be preserved. If the header is used to carry the original token and is expected by the backend, this field must be set to true to preserve the header.
	DisableAuth *bool `pulumi:"disableAuth"`
	// The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP "authorization" header, and sent to the backend.
	JwtAudience *string `pulumi:"jwtAudience"`
	// Deprecated, do not use.
	//
	// Deprecated: Deprecated, do not use.
	MinDeadline *float64 `pulumi:"minDeadline"`
	// The number of seconds to wait for the completion of a long running operation. The default is no deadline.
	OperationDeadline *float64 `pulumi:"operationDeadline"`
	// The map between request protocol and the backend address.
	OverridesByRequestProtocol map[string]string           `pulumi:"overridesByRequestProtocol"`
	PathTranslation            *BackendRulePathTranslation `pulumi:"pathTranslation"`
	// The protocol used for sending a request to the backend. The supported values are "http/1.1" and "h2". The default value is inferred from the scheme in the address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this field to "h2" for improved performance. Configuring this field to non-default values is only supported for secure HTTP backends. This field will be ignored for all other backends. See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on the supported values.
	Protocol *string `pulumi:"protocol"`
	// Selects the methods to which this rule applies. Refer to selector for syntax details.
	Selector *string `pulumi:"selector"`
}

A backend rule provides configuration for an individual API element.

type BackendRuleArgs

type BackendRuleArgs struct {
	// The address of the API backend. The scheme is used to determine the backend protocol and security. The following schemes are accepted: SCHEME PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// gRPC None grpcs:// gRPC TLS It is recommended to explicitly include a scheme. Leaving out the scheme may cause constrasting behaviors across platforms. If the port is unspecified, the default is: - 80 for schemes without TLS - 443 for schemes with TLS For HTTP backends, use protocol to specify the protocol version.
	Address pulumi.StringPtrInput `pulumi:"address"`
	// The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment.
	Deadline pulumi.Float64PtrInput `pulumi:"deadline"`
	// When disable_auth is true, a JWT ID token won't be generated and the original "Authorization" HTTP header will be preserved. If the header is used to carry the original token and is expected by the backend, this field must be set to true to preserve the header.
	DisableAuth pulumi.BoolPtrInput `pulumi:"disableAuth"`
	// The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP "authorization" header, and sent to the backend.
	JwtAudience pulumi.StringPtrInput `pulumi:"jwtAudience"`
	// Deprecated, do not use.
	//
	// Deprecated: Deprecated, do not use.
	MinDeadline pulumi.Float64PtrInput `pulumi:"minDeadline"`
	// The number of seconds to wait for the completion of a long running operation. The default is no deadline.
	OperationDeadline pulumi.Float64PtrInput `pulumi:"operationDeadline"`
	// The map between request protocol and the backend address.
	OverridesByRequestProtocol pulumi.StringMapInput              `pulumi:"overridesByRequestProtocol"`
	PathTranslation            BackendRulePathTranslationPtrInput `pulumi:"pathTranslation"`
	// The protocol used for sending a request to the backend. The supported values are "http/1.1" and "h2". The default value is inferred from the scheme in the address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this field to "h2" for improved performance. Configuring this field to non-default values is only supported for secure HTTP backends. This field will be ignored for all other backends. See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on the supported values.
	Protocol pulumi.StringPtrInput `pulumi:"protocol"`
	// Selects the methods to which this rule applies. Refer to selector for syntax details.
	Selector pulumi.StringPtrInput `pulumi:"selector"`
}

A backend rule provides configuration for an individual API element.

func (BackendRuleArgs) ElementType

func (BackendRuleArgs) ElementType() reflect.Type

func (BackendRuleArgs) ToBackendRuleOutput

func (i BackendRuleArgs) ToBackendRuleOutput() BackendRuleOutput

func (BackendRuleArgs) ToBackendRuleOutputWithContext

func (i BackendRuleArgs) ToBackendRuleOutputWithContext(ctx context.Context) BackendRuleOutput

type BackendRuleArray

type BackendRuleArray []BackendRuleInput

func (BackendRuleArray) ElementType

func (BackendRuleArray) ElementType() reflect.Type

func (BackendRuleArray) ToBackendRuleArrayOutput

func (i BackendRuleArray) ToBackendRuleArrayOutput() BackendRuleArrayOutput

func (BackendRuleArray) ToBackendRuleArrayOutputWithContext

func (i BackendRuleArray) ToBackendRuleArrayOutputWithContext(ctx context.Context) BackendRuleArrayOutput

type BackendRuleArrayInput

type BackendRuleArrayInput interface {
	pulumi.Input

	ToBackendRuleArrayOutput() BackendRuleArrayOutput
	ToBackendRuleArrayOutputWithContext(context.Context) BackendRuleArrayOutput
}

BackendRuleArrayInput is an input type that accepts BackendRuleArray and BackendRuleArrayOutput values. You can construct a concrete instance of `BackendRuleArrayInput` via:

BackendRuleArray{ BackendRuleArgs{...} }

type BackendRuleArrayOutput

type BackendRuleArrayOutput struct{ *pulumi.OutputState }

func (BackendRuleArrayOutput) ElementType

func (BackendRuleArrayOutput) ElementType() reflect.Type

func (BackendRuleArrayOutput) Index

func (BackendRuleArrayOutput) ToBackendRuleArrayOutput

func (o BackendRuleArrayOutput) ToBackendRuleArrayOutput() BackendRuleArrayOutput

func (BackendRuleArrayOutput) ToBackendRuleArrayOutputWithContext

func (o BackendRuleArrayOutput) ToBackendRuleArrayOutputWithContext(ctx context.Context) BackendRuleArrayOutput

type BackendRuleInput

type BackendRuleInput interface {
	pulumi.Input

	ToBackendRuleOutput() BackendRuleOutput
	ToBackendRuleOutputWithContext(context.Context) BackendRuleOutput
}

BackendRuleInput is an input type that accepts BackendRuleArgs and BackendRuleOutput values. You can construct a concrete instance of `BackendRuleInput` via:

BackendRuleArgs{...}

type BackendRuleOutput

type BackendRuleOutput struct{ *pulumi.OutputState }

A backend rule provides configuration for an individual API element.

func (BackendRuleOutput) Address

The address of the API backend. The scheme is used to determine the backend protocol and security. The following schemes are accepted: SCHEME PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// gRPC None grpcs:// gRPC TLS It is recommended to explicitly include a scheme. Leaving out the scheme may cause constrasting behaviors across platforms. If the port is unspecified, the default is: - 80 for schemes without TLS - 443 for schemes with TLS For HTTP backends, use protocol to specify the protocol version.

func (BackendRuleOutput) Deadline

The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment.

func (BackendRuleOutput) DisableAuth

func (o BackendRuleOutput) DisableAuth() pulumi.BoolPtrOutput

When disable_auth is true, a JWT ID token won't be generated and the original "Authorization" HTTP header will be preserved. If the header is used to carry the original token and is expected by the backend, this field must be set to true to preserve the header.

func (BackendRuleOutput) ElementType

func (BackendRuleOutput) ElementType() reflect.Type

func (BackendRuleOutput) JwtAudience

func (o BackendRuleOutput) JwtAudience() pulumi.StringPtrOutput

The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP "authorization" header, and sent to the backend.

func (BackendRuleOutput) MinDeadline deprecated

func (o BackendRuleOutput) MinDeadline() pulumi.Float64PtrOutput

Deprecated, do not use.

Deprecated: Deprecated, do not use.

func (BackendRuleOutput) OperationDeadline

func (o BackendRuleOutput) OperationDeadline() pulumi.Float64PtrOutput

The number of seconds to wait for the completion of a long running operation. The default is no deadline.

func (BackendRuleOutput) OverridesByRequestProtocol added in v0.29.0

func (o BackendRuleOutput) OverridesByRequestProtocol() pulumi.StringMapOutput

The map between request protocol and the backend address.

func (BackendRuleOutput) PathTranslation

func (BackendRuleOutput) Protocol

The protocol used for sending a request to the backend. The supported values are "http/1.1" and "h2". The default value is inferred from the scheme in the address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this field to "h2" for improved performance. Configuring this field to non-default values is only supported for secure HTTP backends. This field will be ignored for all other backends. See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on the supported values.

func (BackendRuleOutput) Selector

Selects the methods to which this rule applies. Refer to selector for syntax details.

func (BackendRuleOutput) ToBackendRuleOutput

func (o BackendRuleOutput) ToBackendRuleOutput() BackendRuleOutput

func (BackendRuleOutput) ToBackendRuleOutputWithContext

func (o BackendRuleOutput) ToBackendRuleOutputWithContext(ctx context.Context) BackendRuleOutput

type BackendRulePathTranslation added in v0.4.0

type BackendRulePathTranslation string

func (BackendRulePathTranslation) ElementType added in v0.4.0

func (BackendRulePathTranslation) ElementType() reflect.Type

func (BackendRulePathTranslation) ToBackendRulePathTranslationOutput added in v0.6.0

func (e BackendRulePathTranslation) ToBackendRulePathTranslationOutput() BackendRulePathTranslationOutput

func (BackendRulePathTranslation) ToBackendRulePathTranslationOutputWithContext added in v0.6.0

func (e BackendRulePathTranslation) ToBackendRulePathTranslationOutputWithContext(ctx context.Context) BackendRulePathTranslationOutput

func (BackendRulePathTranslation) ToBackendRulePathTranslationPtrOutput added in v0.6.0

func (e BackendRulePathTranslation) ToBackendRulePathTranslationPtrOutput() BackendRulePathTranslationPtrOutput

func (BackendRulePathTranslation) ToBackendRulePathTranslationPtrOutputWithContext added in v0.6.0

func (e BackendRulePathTranslation) ToBackendRulePathTranslationPtrOutputWithContext(ctx context.Context) BackendRulePathTranslationPtrOutput

func (BackendRulePathTranslation) ToStringOutput added in v0.4.0

func (e BackendRulePathTranslation) ToStringOutput() pulumi.StringOutput

func (BackendRulePathTranslation) ToStringOutputWithContext added in v0.4.0

func (e BackendRulePathTranslation) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (BackendRulePathTranslation) ToStringPtrOutput added in v0.4.0

func (e BackendRulePathTranslation) ToStringPtrOutput() pulumi.StringPtrOutput

func (BackendRulePathTranslation) ToStringPtrOutputWithContext added in v0.4.0

func (e BackendRulePathTranslation) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type BackendRulePathTranslationInput added in v0.6.0

type BackendRulePathTranslationInput interface {
	pulumi.Input

	ToBackendRulePathTranslationOutput() BackendRulePathTranslationOutput
	ToBackendRulePathTranslationOutputWithContext(context.Context) BackendRulePathTranslationOutput
}

BackendRulePathTranslationInput is an input type that accepts BackendRulePathTranslationArgs and BackendRulePathTranslationOutput values. You can construct a concrete instance of `BackendRulePathTranslationInput` via:

BackendRulePathTranslationArgs{...}

type BackendRulePathTranslationOutput added in v0.6.0

type BackendRulePathTranslationOutput struct{ *pulumi.OutputState }

func (BackendRulePathTranslationOutput) ElementType added in v0.6.0

func (BackendRulePathTranslationOutput) ToBackendRulePathTranslationOutput added in v0.6.0

func (o BackendRulePathTranslationOutput) ToBackendRulePathTranslationOutput() BackendRulePathTranslationOutput

func (BackendRulePathTranslationOutput) ToBackendRulePathTranslationOutputWithContext added in v0.6.0

func (o BackendRulePathTranslationOutput) ToBackendRulePathTranslationOutputWithContext(ctx context.Context) BackendRulePathTranslationOutput

func (BackendRulePathTranslationOutput) ToBackendRulePathTranslationPtrOutput added in v0.6.0

func (o BackendRulePathTranslationOutput) ToBackendRulePathTranslationPtrOutput() BackendRulePathTranslationPtrOutput

func (BackendRulePathTranslationOutput) ToBackendRulePathTranslationPtrOutputWithContext added in v0.6.0

func (o BackendRulePathTranslationOutput) ToBackendRulePathTranslationPtrOutputWithContext(ctx context.Context) BackendRulePathTranslationPtrOutput

func (BackendRulePathTranslationOutput) ToStringOutput added in v0.6.0

func (BackendRulePathTranslationOutput) ToStringOutputWithContext added in v0.6.0

func (o BackendRulePathTranslationOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (BackendRulePathTranslationOutput) ToStringPtrOutput added in v0.6.0

func (BackendRulePathTranslationOutput) ToStringPtrOutputWithContext added in v0.6.0

func (o BackendRulePathTranslationOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type BackendRulePathTranslationPtrInput added in v0.6.0

type BackendRulePathTranslationPtrInput interface {
	pulumi.Input

	ToBackendRulePathTranslationPtrOutput() BackendRulePathTranslationPtrOutput
	ToBackendRulePathTranslationPtrOutputWithContext(context.Context) BackendRulePathTranslationPtrOutput
}

func BackendRulePathTranslationPtr added in v0.6.0

func BackendRulePathTranslationPtr(v string) BackendRulePathTranslationPtrInput

type BackendRulePathTranslationPtrOutput added in v0.6.0

type BackendRulePathTranslationPtrOutput struct{ *pulumi.OutputState }

func (BackendRulePathTranslationPtrOutput) Elem added in v0.6.0

func (BackendRulePathTranslationPtrOutput) ElementType added in v0.6.0

func (BackendRulePathTranslationPtrOutput) ToBackendRulePathTranslationPtrOutput added in v0.6.0

func (o BackendRulePathTranslationPtrOutput) ToBackendRulePathTranslationPtrOutput() BackendRulePathTranslationPtrOutput

func (BackendRulePathTranslationPtrOutput) ToBackendRulePathTranslationPtrOutputWithContext added in v0.6.0

func (o BackendRulePathTranslationPtrOutput) ToBackendRulePathTranslationPtrOutputWithContext(ctx context.Context) BackendRulePathTranslationPtrOutput

func (BackendRulePathTranslationPtrOutput) ToStringPtrOutput added in v0.6.0

func (BackendRulePathTranslationPtrOutput) ToStringPtrOutputWithContext added in v0.6.0

func (o BackendRulePathTranslationPtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type BackendRuleResponse

type BackendRuleResponse struct {
	// The address of the API backend. The scheme is used to determine the backend protocol and security. The following schemes are accepted: SCHEME PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// gRPC None grpcs:// gRPC TLS It is recommended to explicitly include a scheme. Leaving out the scheme may cause constrasting behaviors across platforms. If the port is unspecified, the default is: - 80 for schemes without TLS - 443 for schemes with TLS For HTTP backends, use protocol to specify the protocol version.
	Address string `pulumi:"address"`
	// The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment.
	Deadline float64 `pulumi:"deadline"`
	// When disable_auth is true, a JWT ID token won't be generated and the original "Authorization" HTTP header will be preserved. If the header is used to carry the original token and is expected by the backend, this field must be set to true to preserve the header.
	DisableAuth bool `pulumi:"disableAuth"`
	// The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP "authorization" header, and sent to the backend.
	JwtAudience string `pulumi:"jwtAudience"`
	// Deprecated, do not use.
	//
	// Deprecated: Deprecated, do not use.
	MinDeadline float64 `pulumi:"minDeadline"`
	// The number of seconds to wait for the completion of a long running operation. The default is no deadline.
	OperationDeadline float64 `pulumi:"operationDeadline"`
	// The map between request protocol and the backend address.
	OverridesByRequestProtocol map[string]string `pulumi:"overridesByRequestProtocol"`
	PathTranslation            string            `pulumi:"pathTranslation"`
	// The protocol used for sending a request to the backend. The supported values are "http/1.1" and "h2". The default value is inferred from the scheme in the address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this field to "h2" for improved performance. Configuring this field to non-default values is only supported for secure HTTP backends. This field will be ignored for all other backends. See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on the supported values.
	Protocol string `pulumi:"protocol"`
	// Selects the methods to which this rule applies. Refer to selector for syntax details.
	Selector string `pulumi:"selector"`
}

A backend rule provides configuration for an individual API element.

type BackendRuleResponseArrayOutput

type BackendRuleResponseArrayOutput struct{ *pulumi.OutputState }

func (BackendRuleResponseArrayOutput) ElementType

func (BackendRuleResponseArrayOutput) Index

func (BackendRuleResponseArrayOutput) ToBackendRuleResponseArrayOutput

func (o BackendRuleResponseArrayOutput) ToBackendRuleResponseArrayOutput() BackendRuleResponseArrayOutput

func (BackendRuleResponseArrayOutput) ToBackendRuleResponseArrayOutputWithContext

func (o BackendRuleResponseArrayOutput) ToBackendRuleResponseArrayOutputWithContext(ctx context.Context) BackendRuleResponseArrayOutput

type BackendRuleResponseOutput

type BackendRuleResponseOutput struct{ *pulumi.OutputState }

A backend rule provides configuration for an individual API element.

func (BackendRuleResponseOutput) Address

The address of the API backend. The scheme is used to determine the backend protocol and security. The following schemes are accepted: SCHEME PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// gRPC None grpcs:// gRPC TLS It is recommended to explicitly include a scheme. Leaving out the scheme may cause constrasting behaviors across platforms. If the port is unspecified, the default is: - 80 for schemes without TLS - 443 for schemes with TLS For HTTP backends, use protocol to specify the protocol version.

func (BackendRuleResponseOutput) Deadline

The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment.

func (BackendRuleResponseOutput) DisableAuth

When disable_auth is true, a JWT ID token won't be generated and the original "Authorization" HTTP header will be preserved. If the header is used to carry the original token and is expected by the backend, this field must be set to true to preserve the header.

func (BackendRuleResponseOutput) ElementType

func (BackendRuleResponseOutput) ElementType() reflect.Type

func (BackendRuleResponseOutput) JwtAudience

The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP "authorization" header, and sent to the backend.

func (BackendRuleResponseOutput) MinDeadline deprecated

Deprecated, do not use.

Deprecated: Deprecated, do not use.

func (BackendRuleResponseOutput) OperationDeadline

func (o BackendRuleResponseOutput) OperationDeadline() pulumi.Float64Output

The number of seconds to wait for the completion of a long running operation. The default is no deadline.

func (BackendRuleResponseOutput) OverridesByRequestProtocol added in v0.29.0

func (o BackendRuleResponseOutput) OverridesByRequestProtocol() pulumi.StringMapOutput

The map between request protocol and the backend address.

func (BackendRuleResponseOutput) PathTranslation

func (o BackendRuleResponseOutput) PathTranslation() pulumi.StringOutput

func (BackendRuleResponseOutput) Protocol

The protocol used for sending a request to the backend. The supported values are "http/1.1" and "h2". The default value is inferred from the scheme in the address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this field to "h2" for improved performance. Configuring this field to non-default values is only supported for secure HTTP backends. This field will be ignored for all other backends. See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on the supported values.

func (BackendRuleResponseOutput) Selector

Selects the methods to which this rule applies. Refer to selector for syntax details.

func (BackendRuleResponseOutput) ToBackendRuleResponseOutput

func (o BackendRuleResponseOutput) ToBackendRuleResponseOutput() BackendRuleResponseOutput

func (BackendRuleResponseOutput) ToBackendRuleResponseOutputWithContext

func (o BackendRuleResponseOutput) ToBackendRuleResponseOutputWithContext(ctx context.Context) BackendRuleResponseOutput

type Billing

type Billing struct {
	// Billing configurations for sending metrics to the consumer project. There can be multiple consumer destinations per service, each one must have a different monitored resource type. A metric can be used in at most one consumer destination.
	ConsumerDestinations []BillingDestination `pulumi:"consumerDestinations"`
}

Billing related configuration of the service. The following example shows how to configure monitored resources and metrics for billing, `consumer_destinations` is the only supported destination and the monitored resources need at least one label key `cloud.googleapis.com/location` to indicate the location of the billing usage, using different monitored resources between monitoring and billing is recommended so they can be evolved independently: monitored_resources: - type: library.googleapis.com/billing_branch labels: - key: cloud.googleapis.com/location description: | Predefined label to support billing location restriction. - key: city description: | Custom label to define the city where the library branch is located in. - key: name description: Custom label to define the name of the library branch. metrics: - name: library.googleapis.com/book/borrowed_count metric_kind: DELTA value_type: INT64 unit: "1" billing: consumer_destinations: - monitored_resource: library.googleapis.com/billing_branch metrics: - library.googleapis.com/book/borrowed_count

type BillingArgs

type BillingArgs struct {
	// Billing configurations for sending metrics to the consumer project. There can be multiple consumer destinations per service, each one must have a different monitored resource type. A metric can be used in at most one consumer destination.
	ConsumerDestinations BillingDestinationArrayInput `pulumi:"consumerDestinations"`
}

Billing related configuration of the service. The following example shows how to configure monitored resources and metrics for billing, `consumer_destinations` is the only supported destination and the monitored resources need at least one label key `cloud.googleapis.com/location` to indicate the location of the billing usage, using different monitored resources between monitoring and billing is recommended so they can be evolved independently: monitored_resources: - type: library.googleapis.com/billing_branch labels: - key: cloud.googleapis.com/location description: | Predefined label to support billing location restriction. - key: city description: | Custom label to define the city where the library branch is located in. - key: name description: Custom label to define the name of the library branch. metrics: - name: library.googleapis.com/book/borrowed_count metric_kind: DELTA value_type: INT64 unit: "1" billing: consumer_destinations: - monitored_resource: library.googleapis.com/billing_branch metrics: - library.googleapis.com/book/borrowed_count

func (BillingArgs) ElementType

func (BillingArgs) ElementType() reflect.Type

func (BillingArgs) ToBillingOutput

func (i BillingArgs) ToBillingOutput() BillingOutput

func (BillingArgs) ToBillingOutputWithContext

func (i BillingArgs) ToBillingOutputWithContext(ctx context.Context) BillingOutput

func (BillingArgs) ToBillingPtrOutput

func (i BillingArgs) ToBillingPtrOutput() BillingPtrOutput

func (BillingArgs) ToBillingPtrOutputWithContext

func (i BillingArgs) ToBillingPtrOutputWithContext(ctx context.Context) BillingPtrOutput

type BillingDestination

type BillingDestination struct {
	// Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section.
	Metrics []string `pulumi:"metrics"`
	// The monitored resource type. The type must be defined in Service.monitored_resources section.
	MonitoredResource *string `pulumi:"monitoredResource"`
}

Configuration of a specific billing destination (Currently only support bill against consumer project).

type BillingDestinationArgs

type BillingDestinationArgs struct {
	// Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section.
	Metrics pulumi.StringArrayInput `pulumi:"metrics"`
	// The monitored resource type. The type must be defined in Service.monitored_resources section.
	MonitoredResource pulumi.StringPtrInput `pulumi:"monitoredResource"`
}

Configuration of a specific billing destination (Currently only support bill against consumer project).

func (BillingDestinationArgs) ElementType

func (BillingDestinationArgs) ElementType() reflect.Type

func (BillingDestinationArgs) ToBillingDestinationOutput

func (i BillingDestinationArgs) ToBillingDestinationOutput() BillingDestinationOutput

func (BillingDestinationArgs) ToBillingDestinationOutputWithContext

func (i BillingDestinationArgs) ToBillingDestinationOutputWithContext(ctx context.Context) BillingDestinationOutput

type BillingDestinationArray

type BillingDestinationArray []BillingDestinationInput

func (BillingDestinationArray) ElementType

func (BillingDestinationArray) ElementType() reflect.Type

func (BillingDestinationArray) ToBillingDestinationArrayOutput

func (i BillingDestinationArray) ToBillingDestinationArrayOutput() BillingDestinationArrayOutput

func (BillingDestinationArray) ToBillingDestinationArrayOutputWithContext

func (i BillingDestinationArray) ToBillingDestinationArrayOutputWithContext(ctx context.Context) BillingDestinationArrayOutput

type BillingDestinationArrayInput

type BillingDestinationArrayInput interface {
	pulumi.Input

	ToBillingDestinationArrayOutput() BillingDestinationArrayOutput
	ToBillingDestinationArrayOutputWithContext(context.Context) BillingDestinationArrayOutput
}

BillingDestinationArrayInput is an input type that accepts BillingDestinationArray and BillingDestinationArrayOutput values. You can construct a concrete instance of `BillingDestinationArrayInput` via:

BillingDestinationArray{ BillingDestinationArgs{...} }

type BillingDestinationArrayOutput

type BillingDestinationArrayOutput struct{ *pulumi.OutputState }

func (BillingDestinationArrayOutput) ElementType

func (BillingDestinationArrayOutput) Index

func (BillingDestinationArrayOutput) ToBillingDestinationArrayOutput

func (o BillingDestinationArrayOutput) ToBillingDestinationArrayOutput() BillingDestinationArrayOutput

func (BillingDestinationArrayOutput) ToBillingDestinationArrayOutputWithContext

func (o BillingDestinationArrayOutput) ToBillingDestinationArrayOutputWithContext(ctx context.Context) BillingDestinationArrayOutput

type BillingDestinationInput

type BillingDestinationInput interface {
	pulumi.Input

	ToBillingDestinationOutput() BillingDestinationOutput
	ToBillingDestinationOutputWithContext(context.Context) BillingDestinationOutput
}

BillingDestinationInput is an input type that accepts BillingDestinationArgs and BillingDestinationOutput values. You can construct a concrete instance of `BillingDestinationInput` via:

BillingDestinationArgs{...}

type BillingDestinationOutput

type BillingDestinationOutput struct{ *pulumi.OutputState }

Configuration of a specific billing destination (Currently only support bill against consumer project).

func (BillingDestinationOutput) ElementType

func (BillingDestinationOutput) ElementType() reflect.Type

func (BillingDestinationOutput) Metrics

Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section.

func (BillingDestinationOutput) MonitoredResource

func (o BillingDestinationOutput) MonitoredResource() pulumi.StringPtrOutput

The monitored resource type. The type must be defined in Service.monitored_resources section.

func (BillingDestinationOutput) ToBillingDestinationOutput

func (o BillingDestinationOutput) ToBillingDestinationOutput() BillingDestinationOutput

func (BillingDestinationOutput) ToBillingDestinationOutputWithContext

func (o BillingDestinationOutput) ToBillingDestinationOutputWithContext(ctx context.Context) BillingDestinationOutput

type BillingDestinationResponse

type BillingDestinationResponse struct {
	// Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section.
	Metrics []string `pulumi:"metrics"`
	// The monitored resource type. The type must be defined in Service.monitored_resources section.
	MonitoredResource string `pulumi:"monitoredResource"`
}

Configuration of a specific billing destination (Currently only support bill against consumer project).

type BillingDestinationResponseArrayOutput

type BillingDestinationResponseArrayOutput struct{ *pulumi.OutputState }

func (BillingDestinationResponseArrayOutput) ElementType

func (BillingDestinationResponseArrayOutput) Index

func (BillingDestinationResponseArrayOutput) ToBillingDestinationResponseArrayOutput

func (o BillingDestinationResponseArrayOutput) ToBillingDestinationResponseArrayOutput() BillingDestinationResponseArrayOutput

func (BillingDestinationResponseArrayOutput) ToBillingDestinationResponseArrayOutputWithContext

func (o BillingDestinationResponseArrayOutput) ToBillingDestinationResponseArrayOutputWithContext(ctx context.Context) BillingDestinationResponseArrayOutput

type BillingDestinationResponseOutput

type BillingDestinationResponseOutput struct{ *pulumi.OutputState }

Configuration of a specific billing destination (Currently only support bill against consumer project).

func (BillingDestinationResponseOutput) ElementType

func (BillingDestinationResponseOutput) Metrics

Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section.

func (BillingDestinationResponseOutput) MonitoredResource

The monitored resource type. The type must be defined in Service.monitored_resources section.

func (BillingDestinationResponseOutput) ToBillingDestinationResponseOutput

func (o BillingDestinationResponseOutput) ToBillingDestinationResponseOutput() BillingDestinationResponseOutput

func (BillingDestinationResponseOutput) ToBillingDestinationResponseOutputWithContext

func (o BillingDestinationResponseOutput) ToBillingDestinationResponseOutputWithContext(ctx context.Context) BillingDestinationResponseOutput

type BillingInput

type BillingInput interface {
	pulumi.Input

	ToBillingOutput() BillingOutput
	ToBillingOutputWithContext(context.Context) BillingOutput
}

BillingInput is an input type that accepts BillingArgs and BillingOutput values. You can construct a concrete instance of `BillingInput` via:

BillingArgs{...}

type BillingOutput

type BillingOutput struct{ *pulumi.OutputState }

Billing related configuration of the service. The following example shows how to configure monitored resources and metrics for billing, `consumer_destinations` is the only supported destination and the monitored resources need at least one label key `cloud.googleapis.com/location` to indicate the location of the billing usage, using different monitored resources between monitoring and billing is recommended so they can be evolved independently: monitored_resources: - type: library.googleapis.com/billing_branch labels: - key: cloud.googleapis.com/location description: | Predefined label to support billing location restriction. - key: city description: | Custom label to define the city where the library branch is located in. - key: name description: Custom label to define the name of the library branch. metrics: - name: library.googleapis.com/book/borrowed_count metric_kind: DELTA value_type: INT64 unit: "1" billing: consumer_destinations: - monitored_resource: library.googleapis.com/billing_branch metrics: - library.googleapis.com/book/borrowed_count

func (BillingOutput) ConsumerDestinations

func (o BillingOutput) ConsumerDestinations() BillingDestinationArrayOutput

Billing configurations for sending metrics to the consumer project. There can be multiple consumer destinations per service, each one must have a different monitored resource type. A metric can be used in at most one consumer destination.

func (BillingOutput) ElementType

func (BillingOutput) ElementType() reflect.Type

func (BillingOutput) ToBillingOutput

func (o BillingOutput) ToBillingOutput() BillingOutput

func (BillingOutput) ToBillingOutputWithContext

func (o BillingOutput) ToBillingOutputWithContext(ctx context.Context) BillingOutput

func (BillingOutput) ToBillingPtrOutput

func (o BillingOutput) ToBillingPtrOutput() BillingPtrOutput

func (BillingOutput) ToBillingPtrOutputWithContext

func (o BillingOutput) ToBillingPtrOutputWithContext(ctx context.Context) BillingPtrOutput

type BillingPtrInput

type BillingPtrInput interface {
	pulumi.Input

	ToBillingPtrOutput() BillingPtrOutput
	ToBillingPtrOutputWithContext(context.Context) BillingPtrOutput
}

BillingPtrInput is an input type that accepts BillingArgs, BillingPtr and BillingPtrOutput values. You can construct a concrete instance of `BillingPtrInput` via:

        BillingArgs{...}

or:

        nil

func BillingPtr

func BillingPtr(v *BillingArgs) BillingPtrInput

type BillingPtrOutput

type BillingPtrOutput struct{ *pulumi.OutputState }

func (BillingPtrOutput) ConsumerDestinations

func (o BillingPtrOutput) ConsumerDestinations() BillingDestinationArrayOutput

Billing configurations for sending metrics to the consumer project. There can be multiple consumer destinations per service, each one must have a different monitored resource type. A metric can be used in at most one consumer destination.

func (BillingPtrOutput) Elem

func (BillingPtrOutput) ElementType

func (BillingPtrOutput) ElementType() reflect.Type

func (BillingPtrOutput) ToBillingPtrOutput

func (o BillingPtrOutput) ToBillingPtrOutput() BillingPtrOutput

func (BillingPtrOutput) ToBillingPtrOutputWithContext

func (o BillingPtrOutput) ToBillingPtrOutputWithContext(ctx context.Context) BillingPtrOutput

type BillingResponse

type BillingResponse struct {
	// Billing configurations for sending metrics to the consumer project. There can be multiple consumer destinations per service, each one must have a different monitored resource type. A metric can be used in at most one consumer destination.
	ConsumerDestinations []BillingDestinationResponse `pulumi:"consumerDestinations"`
}

Billing related configuration of the service. The following example shows how to configure monitored resources and metrics for billing, `consumer_destinations` is the only supported destination and the monitored resources need at least one label key `cloud.googleapis.com/location` to indicate the location of the billing usage, using different monitored resources between monitoring and billing is recommended so they can be evolved independently: monitored_resources: - type: library.googleapis.com/billing_branch labels: - key: cloud.googleapis.com/location description: | Predefined label to support billing location restriction. - key: city description: | Custom label to define the city where the library branch is located in. - key: name description: Custom label to define the name of the library branch. metrics: - name: library.googleapis.com/book/borrowed_count metric_kind: DELTA value_type: INT64 unit: "1" billing: consumer_destinations: - monitored_resource: library.googleapis.com/billing_branch metrics: - library.googleapis.com/book/borrowed_count

type BillingResponseOutput

type BillingResponseOutput struct{ *pulumi.OutputState }

Billing related configuration of the service. The following example shows how to configure monitored resources and metrics for billing, `consumer_destinations` is the only supported destination and the monitored resources need at least one label key `cloud.googleapis.com/location` to indicate the location of the billing usage, using different monitored resources between monitoring and billing is recommended so they can be evolved independently: monitored_resources: - type: library.googleapis.com/billing_branch labels: - key: cloud.googleapis.com/location description: | Predefined label to support billing location restriction. - key: city description: | Custom label to define the city where the library branch is located in. - key: name description: Custom label to define the name of the library branch. metrics: - name: library.googleapis.com/book/borrowed_count metric_kind: DELTA value_type: INT64 unit: "1" billing: consumer_destinations: - monitored_resource: library.googleapis.com/billing_branch metrics: - library.googleapis.com/book/borrowed_count

func (BillingResponseOutput) ConsumerDestinations

Billing configurations for sending metrics to the consumer project. There can be multiple consumer destinations per service, each one must have a different monitored resource type. A metric can be used in at most one consumer destination.

func (BillingResponseOutput) ElementType

func (BillingResponseOutput) ElementType() reflect.Type

func (BillingResponseOutput) ToBillingResponseOutput

func (o BillingResponseOutput) ToBillingResponseOutput() BillingResponseOutput

func (BillingResponseOutput) ToBillingResponseOutputWithContext

func (o BillingResponseOutput) ToBillingResponseOutputWithContext(ctx context.Context) BillingResponseOutput

type Binding

type Binding struct {
	// The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
	Condition *Expr `pulumi:"condition"`
	// Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.
	Members []string `pulumi:"members"`
	// Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
	Role *string `pulumi:"role"`
}

Associates `members`, or principals, with a `role`.

type BindingArgs

type BindingArgs struct {
	// The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
	Condition ExprPtrInput `pulumi:"condition"`
	// Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.
	Members pulumi.StringArrayInput `pulumi:"members"`
	// Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
	Role pulumi.StringPtrInput `pulumi:"role"`
}

Associates `members`, or principals, with a `role`.

func (BindingArgs) ElementType

func (BindingArgs) ElementType() reflect.Type

func (BindingArgs) ToBindingOutput

func (i BindingArgs) ToBindingOutput() BindingOutput

func (BindingArgs) ToBindingOutputWithContext

func (i BindingArgs) ToBindingOutputWithContext(ctx context.Context) BindingOutput

type BindingArray

type BindingArray []BindingInput

func (BindingArray) ElementType

func (BindingArray) ElementType() reflect.Type

func (BindingArray) ToBindingArrayOutput

func (i BindingArray) ToBindingArrayOutput() BindingArrayOutput

func (BindingArray) ToBindingArrayOutputWithContext

func (i BindingArray) ToBindingArrayOutputWithContext(ctx context.Context) BindingArrayOutput

type BindingArrayInput

type BindingArrayInput interface {
	pulumi.Input

	ToBindingArrayOutput() BindingArrayOutput
	ToBindingArrayOutputWithContext(context.Context) BindingArrayOutput
}

BindingArrayInput is an input type that accepts BindingArray and BindingArrayOutput values. You can construct a concrete instance of `BindingArrayInput` via:

BindingArray{ BindingArgs{...} }

type BindingArrayOutput

type BindingArrayOutput struct{ *pulumi.OutputState }

func (BindingArrayOutput) ElementType

func (BindingArrayOutput) ElementType() reflect.Type

func (BindingArrayOutput) Index

func (BindingArrayOutput) ToBindingArrayOutput

func (o BindingArrayOutput) ToBindingArrayOutput() BindingArrayOutput

func (BindingArrayOutput) ToBindingArrayOutputWithContext

func (o BindingArrayOutput) ToBindingArrayOutputWithContext(ctx context.Context) BindingArrayOutput

type BindingInput

type BindingInput interface {
	pulumi.Input

	ToBindingOutput() BindingOutput
	ToBindingOutputWithContext(context.Context) BindingOutput
}

BindingInput is an input type that accepts BindingArgs and BindingOutput values. You can construct a concrete instance of `BindingInput` via:

BindingArgs{...}

type BindingOutput

type BindingOutput struct{ *pulumi.OutputState }

Associates `members`, or principals, with a `role`.

func (BindingOutput) Condition

func (o BindingOutput) Condition() ExprPtrOutput

The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

func (BindingOutput) ElementType

func (BindingOutput) ElementType() reflect.Type

func (BindingOutput) Members

Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.

func (BindingOutput) Role

Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

func (BindingOutput) ToBindingOutput

func (o BindingOutput) ToBindingOutput() BindingOutput

func (BindingOutput) ToBindingOutputWithContext

func (o BindingOutput) ToBindingOutputWithContext(ctx context.Context) BindingOutput

type BindingResponse

type BindingResponse struct {
	// The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
	Condition ExprResponse `pulumi:"condition"`
	// Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.
	Members []string `pulumi:"members"`
	// Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
	Role string `pulumi:"role"`
}

Associates `members`, or principals, with a `role`.

type BindingResponseArrayOutput

type BindingResponseArrayOutput struct{ *pulumi.OutputState }

func (BindingResponseArrayOutput) ElementType

func (BindingResponseArrayOutput) ElementType() reflect.Type

func (BindingResponseArrayOutput) Index

func (BindingResponseArrayOutput) ToBindingResponseArrayOutput

func (o BindingResponseArrayOutput) ToBindingResponseArrayOutput() BindingResponseArrayOutput

func (BindingResponseArrayOutput) ToBindingResponseArrayOutputWithContext

func (o BindingResponseArrayOutput) ToBindingResponseArrayOutputWithContext(ctx context.Context) BindingResponseArrayOutput

type BindingResponseOutput

type BindingResponseOutput struct{ *pulumi.OutputState }

Associates `members`, or principals, with a `role`.

func (BindingResponseOutput) Condition

The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

func (BindingResponseOutput) ElementType

func (BindingResponseOutput) ElementType() reflect.Type

func (BindingResponseOutput) Members

Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.

func (BindingResponseOutput) Role

Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

func (BindingResponseOutput) ToBindingResponseOutput

func (o BindingResponseOutput) ToBindingResponseOutput() BindingResponseOutput

func (BindingResponseOutput) ToBindingResponseOutputWithContext

func (o BindingResponseOutput) ToBindingResponseOutputWithContext(ctx context.Context) BindingResponseOutput

type ClientLibrarySettings added in v0.28.0

type ClientLibrarySettings struct {
	// Settings for C++ client libraries.
	CppSettings *CppSettings `pulumi:"cppSettings"`
	// Settings for .NET client libraries.
	DotnetSettings *DotnetSettings `pulumi:"dotnetSettings"`
	// Settings for Go client libraries.
	GoSettings *GoSettings `pulumi:"goSettings"`
	// Settings for legacy Java features, supported in the Service YAML.
	JavaSettings *JavaSettings `pulumi:"javaSettings"`
	// Launch stage of this version of the API.
	LaunchStage *ClientLibrarySettingsLaunchStage `pulumi:"launchStage"`
	// Settings for Node client libraries.
	NodeSettings *NodeSettings `pulumi:"nodeSettings"`
	// Settings for PHP client libraries.
	PhpSettings *PhpSettings `pulumi:"phpSettings"`
	// Settings for Python client libraries.
	PythonSettings *PythonSettings `pulumi:"pythonSettings"`
	// When using transport=rest, the client request will encode enums as numbers rather than strings.
	RestNumericEnums *bool `pulumi:"restNumericEnums"`
	// Settings for Ruby client libraries.
	RubySettings *RubySettings `pulumi:"rubySettings"`
	// Version of the API to apply these settings to. This is the full protobuf package for the API, ending in the version element. Examples: "google.cloud.speech.v1" and "google.spanner.admin.database.v1".
	Version *string `pulumi:"version"`
}

Details about how and where to publish client libraries.

type ClientLibrarySettingsArgs added in v0.28.0

type ClientLibrarySettingsArgs struct {
	// Settings for C++ client libraries.
	CppSettings CppSettingsPtrInput `pulumi:"cppSettings"`
	// Settings for .NET client libraries.
	DotnetSettings DotnetSettingsPtrInput `pulumi:"dotnetSettings"`
	// Settings for Go client libraries.
	GoSettings GoSettingsPtrInput `pulumi:"goSettings"`
	// Settings for legacy Java features, supported in the Service YAML.
	JavaSettings JavaSettingsPtrInput `pulumi:"javaSettings"`
	// Launch stage of this version of the API.
	LaunchStage ClientLibrarySettingsLaunchStagePtrInput `pulumi:"launchStage"`
	// Settings for Node client libraries.
	NodeSettings NodeSettingsPtrInput `pulumi:"nodeSettings"`
	// Settings for PHP client libraries.
	PhpSettings PhpSettingsPtrInput `pulumi:"phpSettings"`
	// Settings for Python client libraries.
	PythonSettings PythonSettingsPtrInput `pulumi:"pythonSettings"`
	// When using transport=rest, the client request will encode enums as numbers rather than strings.
	RestNumericEnums pulumi.BoolPtrInput `pulumi:"restNumericEnums"`
	// Settings for Ruby client libraries.
	RubySettings RubySettingsPtrInput `pulumi:"rubySettings"`
	// Version of the API to apply these settings to. This is the full protobuf package for the API, ending in the version element. Examples: "google.cloud.speech.v1" and "google.spanner.admin.database.v1".
	Version pulumi.StringPtrInput `pulumi:"version"`
}

Details about how and where to publish client libraries.

func (ClientLibrarySettingsArgs) ElementType added in v0.28.0

func (ClientLibrarySettingsArgs) ElementType() reflect.Type

func (ClientLibrarySettingsArgs) ToClientLibrarySettingsOutput added in v0.28.0

func (i ClientLibrarySettingsArgs) ToClientLibrarySettingsOutput() ClientLibrarySettingsOutput

func (ClientLibrarySettingsArgs) ToClientLibrarySettingsOutputWithContext added in v0.28.0

func (i ClientLibrarySettingsArgs) ToClientLibrarySettingsOutputWithContext(ctx context.Context) ClientLibrarySettingsOutput

type ClientLibrarySettingsArray added in v0.28.0

type ClientLibrarySettingsArray []ClientLibrarySettingsInput

func (ClientLibrarySettingsArray) ElementType added in v0.28.0

func (ClientLibrarySettingsArray) ElementType() reflect.Type

func (ClientLibrarySettingsArray) ToClientLibrarySettingsArrayOutput added in v0.28.0

func (i ClientLibrarySettingsArray) ToClientLibrarySettingsArrayOutput() ClientLibrarySettingsArrayOutput

func (ClientLibrarySettingsArray) ToClientLibrarySettingsArrayOutputWithContext added in v0.28.0

func (i ClientLibrarySettingsArray) ToClientLibrarySettingsArrayOutputWithContext(ctx context.Context) ClientLibrarySettingsArrayOutput

type ClientLibrarySettingsArrayInput added in v0.28.0

type ClientLibrarySettingsArrayInput interface {
	pulumi.Input

	ToClientLibrarySettingsArrayOutput() ClientLibrarySettingsArrayOutput
	ToClientLibrarySettingsArrayOutputWithContext(context.Context) ClientLibrarySettingsArrayOutput
}

ClientLibrarySettingsArrayInput is an input type that accepts ClientLibrarySettingsArray and ClientLibrarySettingsArrayOutput values. You can construct a concrete instance of `ClientLibrarySettingsArrayInput` via:

ClientLibrarySettingsArray{ ClientLibrarySettingsArgs{...} }

type ClientLibrarySettingsArrayOutput added in v0.28.0

type ClientLibrarySettingsArrayOutput struct{ *pulumi.OutputState }

func (ClientLibrarySettingsArrayOutput) ElementType added in v0.28.0

func (ClientLibrarySettingsArrayOutput) Index added in v0.28.0

func (ClientLibrarySettingsArrayOutput) ToClientLibrarySettingsArrayOutput added in v0.28.0

func (o ClientLibrarySettingsArrayOutput) ToClientLibrarySettingsArrayOutput() ClientLibrarySettingsArrayOutput

func (ClientLibrarySettingsArrayOutput) ToClientLibrarySettingsArrayOutputWithContext added in v0.28.0

func (o ClientLibrarySettingsArrayOutput) ToClientLibrarySettingsArrayOutputWithContext(ctx context.Context) ClientLibrarySettingsArrayOutput

type ClientLibrarySettingsInput added in v0.28.0

type ClientLibrarySettingsInput interface {
	pulumi.Input

	ToClientLibrarySettingsOutput() ClientLibrarySettingsOutput
	ToClientLibrarySettingsOutputWithContext(context.Context) ClientLibrarySettingsOutput
}

ClientLibrarySettingsInput is an input type that accepts ClientLibrarySettingsArgs and ClientLibrarySettingsOutput values. You can construct a concrete instance of `ClientLibrarySettingsInput` via:

ClientLibrarySettingsArgs{...}

type ClientLibrarySettingsLaunchStage added in v0.28.0

type ClientLibrarySettingsLaunchStage string

Launch stage of this version of the API.

func (ClientLibrarySettingsLaunchStage) ElementType added in v0.28.0

func (ClientLibrarySettingsLaunchStage) ToClientLibrarySettingsLaunchStageOutput added in v0.28.0

func (e ClientLibrarySettingsLaunchStage) ToClientLibrarySettingsLaunchStageOutput() ClientLibrarySettingsLaunchStageOutput

func (ClientLibrarySettingsLaunchStage) ToClientLibrarySettingsLaunchStageOutputWithContext added in v0.28.0

func (e ClientLibrarySettingsLaunchStage) ToClientLibrarySettingsLaunchStageOutputWithContext(ctx context.Context) ClientLibrarySettingsLaunchStageOutput

func (ClientLibrarySettingsLaunchStage) ToClientLibrarySettingsLaunchStagePtrOutput added in v0.28.0

func (e ClientLibrarySettingsLaunchStage) ToClientLibrarySettingsLaunchStagePtrOutput() ClientLibrarySettingsLaunchStagePtrOutput

func (ClientLibrarySettingsLaunchStage) ToClientLibrarySettingsLaunchStagePtrOutputWithContext added in v0.28.0

func (e ClientLibrarySettingsLaunchStage) ToClientLibrarySettingsLaunchStagePtrOutputWithContext(ctx context.Context) ClientLibrarySettingsLaunchStagePtrOutput

func (ClientLibrarySettingsLaunchStage) ToStringOutput added in v0.28.0

func (ClientLibrarySettingsLaunchStage) ToStringOutputWithContext added in v0.28.0

func (e ClientLibrarySettingsLaunchStage) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (ClientLibrarySettingsLaunchStage) ToStringPtrOutput added in v0.28.0

func (ClientLibrarySettingsLaunchStage) ToStringPtrOutputWithContext added in v0.28.0

func (e ClientLibrarySettingsLaunchStage) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type ClientLibrarySettingsLaunchStageInput added in v0.28.0

type ClientLibrarySettingsLaunchStageInput interface {
	pulumi.Input

	ToClientLibrarySettingsLaunchStageOutput() ClientLibrarySettingsLaunchStageOutput
	ToClientLibrarySettingsLaunchStageOutputWithContext(context.Context) ClientLibrarySettingsLaunchStageOutput
}

ClientLibrarySettingsLaunchStageInput is an input type that accepts ClientLibrarySettingsLaunchStageArgs and ClientLibrarySettingsLaunchStageOutput values. You can construct a concrete instance of `ClientLibrarySettingsLaunchStageInput` via:

ClientLibrarySettingsLaunchStageArgs{...}

type ClientLibrarySettingsLaunchStageOutput added in v0.28.0

type ClientLibrarySettingsLaunchStageOutput struct{ *pulumi.OutputState }

func (ClientLibrarySettingsLaunchStageOutput) ElementType added in v0.28.0

func (ClientLibrarySettingsLaunchStageOutput) ToClientLibrarySettingsLaunchStageOutput added in v0.28.0

func (o ClientLibrarySettingsLaunchStageOutput) ToClientLibrarySettingsLaunchStageOutput() ClientLibrarySettingsLaunchStageOutput

func (ClientLibrarySettingsLaunchStageOutput) ToClientLibrarySettingsLaunchStageOutputWithContext added in v0.28.0

func (o ClientLibrarySettingsLaunchStageOutput) ToClientLibrarySettingsLaunchStageOutputWithContext(ctx context.Context) ClientLibrarySettingsLaunchStageOutput

func (ClientLibrarySettingsLaunchStageOutput) ToClientLibrarySettingsLaunchStagePtrOutput added in v0.28.0

func (o ClientLibrarySettingsLaunchStageOutput) ToClientLibrarySettingsLaunchStagePtrOutput() ClientLibrarySettingsLaunchStagePtrOutput

func (ClientLibrarySettingsLaunchStageOutput) ToClientLibrarySettingsLaunchStagePtrOutputWithContext added in v0.28.0

func (o ClientLibrarySettingsLaunchStageOutput) ToClientLibrarySettingsLaunchStagePtrOutputWithContext(ctx context.Context) ClientLibrarySettingsLaunchStagePtrOutput

func (ClientLibrarySettingsLaunchStageOutput) ToStringOutput added in v0.28.0

func (ClientLibrarySettingsLaunchStageOutput) ToStringOutputWithContext added in v0.28.0

func (ClientLibrarySettingsLaunchStageOutput) ToStringPtrOutput added in v0.28.0

func (ClientLibrarySettingsLaunchStageOutput) ToStringPtrOutputWithContext added in v0.28.0

func (o ClientLibrarySettingsLaunchStageOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type ClientLibrarySettingsLaunchStagePtrInput added in v0.28.0

type ClientLibrarySettingsLaunchStagePtrInput interface {
	pulumi.Input

	ToClientLibrarySettingsLaunchStagePtrOutput() ClientLibrarySettingsLaunchStagePtrOutput
	ToClientLibrarySettingsLaunchStagePtrOutputWithContext(context.Context) ClientLibrarySettingsLaunchStagePtrOutput
}

func ClientLibrarySettingsLaunchStagePtr added in v0.28.0

func ClientLibrarySettingsLaunchStagePtr(v string) ClientLibrarySettingsLaunchStagePtrInput

type ClientLibrarySettingsLaunchStagePtrOutput added in v0.28.0

type ClientLibrarySettingsLaunchStagePtrOutput struct{ *pulumi.OutputState }

func (ClientLibrarySettingsLaunchStagePtrOutput) Elem added in v0.28.0

func (ClientLibrarySettingsLaunchStagePtrOutput) ElementType added in v0.28.0

func (ClientLibrarySettingsLaunchStagePtrOutput) ToClientLibrarySettingsLaunchStagePtrOutput added in v0.28.0

func (o ClientLibrarySettingsLaunchStagePtrOutput) ToClientLibrarySettingsLaunchStagePtrOutput() ClientLibrarySettingsLaunchStagePtrOutput

func (ClientLibrarySettingsLaunchStagePtrOutput) ToClientLibrarySettingsLaunchStagePtrOutputWithContext added in v0.28.0

func (o ClientLibrarySettingsLaunchStagePtrOutput) ToClientLibrarySettingsLaunchStagePtrOutputWithContext(ctx context.Context) ClientLibrarySettingsLaunchStagePtrOutput

func (ClientLibrarySettingsLaunchStagePtrOutput) ToStringPtrOutput added in v0.28.0

func (ClientLibrarySettingsLaunchStagePtrOutput) ToStringPtrOutputWithContext added in v0.28.0

type ClientLibrarySettingsOutput added in v0.28.0

type ClientLibrarySettingsOutput struct{ *pulumi.OutputState }

Details about how and where to publish client libraries.

func (ClientLibrarySettingsOutput) CppSettings added in v0.28.0

Settings for C++ client libraries.

func (ClientLibrarySettingsOutput) DotnetSettings added in v0.28.0

Settings for .NET client libraries.

func (ClientLibrarySettingsOutput) ElementType added in v0.28.0

func (ClientLibrarySettingsOutput) GoSettings added in v0.28.0

Settings for Go client libraries.

func (ClientLibrarySettingsOutput) JavaSettings added in v0.28.0

Settings for legacy Java features, supported in the Service YAML.

func (ClientLibrarySettingsOutput) LaunchStage added in v0.28.0

Launch stage of this version of the API.

func (ClientLibrarySettingsOutput) NodeSettings added in v0.28.0

Settings for Node client libraries.

func (ClientLibrarySettingsOutput) PhpSettings added in v0.28.0

Settings for PHP client libraries.

func (ClientLibrarySettingsOutput) PythonSettings added in v0.28.0

Settings for Python client libraries.

func (ClientLibrarySettingsOutput) RestNumericEnums added in v0.28.0

func (o ClientLibrarySettingsOutput) RestNumericEnums() pulumi.BoolPtrOutput

When using transport=rest, the client request will encode enums as numbers rather than strings.

func (ClientLibrarySettingsOutput) RubySettings added in v0.28.0

Settings for Ruby client libraries.

func (ClientLibrarySettingsOutput) ToClientLibrarySettingsOutput added in v0.28.0

func (o ClientLibrarySettingsOutput) ToClientLibrarySettingsOutput() ClientLibrarySettingsOutput

func (ClientLibrarySettingsOutput) ToClientLibrarySettingsOutputWithContext added in v0.28.0

func (o ClientLibrarySettingsOutput) ToClientLibrarySettingsOutputWithContext(ctx context.Context) ClientLibrarySettingsOutput

func (ClientLibrarySettingsOutput) Version added in v0.28.0

Version of the API to apply these settings to. This is the full protobuf package for the API, ending in the version element. Examples: "google.cloud.speech.v1" and "google.spanner.admin.database.v1".

type ClientLibrarySettingsResponse added in v0.28.0

type ClientLibrarySettingsResponse struct {
	// Settings for C++ client libraries.
	CppSettings CppSettingsResponse `pulumi:"cppSettings"`
	// Settings for .NET client libraries.
	DotnetSettings DotnetSettingsResponse `pulumi:"dotnetSettings"`
	// Settings for Go client libraries.
	GoSettings GoSettingsResponse `pulumi:"goSettings"`
	// Settings for legacy Java features, supported in the Service YAML.
	JavaSettings JavaSettingsResponse `pulumi:"javaSettings"`
	// Launch stage of this version of the API.
	LaunchStage string `pulumi:"launchStage"`
	// Settings for Node client libraries.
	NodeSettings NodeSettingsResponse `pulumi:"nodeSettings"`
	// Settings for PHP client libraries.
	PhpSettings PhpSettingsResponse `pulumi:"phpSettings"`
	// Settings for Python client libraries.
	PythonSettings PythonSettingsResponse `pulumi:"pythonSettings"`
	// When using transport=rest, the client request will encode enums as numbers rather than strings.
	RestNumericEnums bool `pulumi:"restNumericEnums"`
	// Settings for Ruby client libraries.
	RubySettings RubySettingsResponse `pulumi:"rubySettings"`
	// Version of the API to apply these settings to. This is the full protobuf package for the API, ending in the version element. Examples: "google.cloud.speech.v1" and "google.spanner.admin.database.v1".
	Version string `pulumi:"version"`
}

Details about how and where to publish client libraries.

type ClientLibrarySettingsResponseArrayOutput added in v0.28.0

type ClientLibrarySettingsResponseArrayOutput struct{ *pulumi.OutputState }

func (ClientLibrarySettingsResponseArrayOutput) ElementType added in v0.28.0

func (ClientLibrarySettingsResponseArrayOutput) Index added in v0.28.0

func (ClientLibrarySettingsResponseArrayOutput) ToClientLibrarySettingsResponseArrayOutput added in v0.28.0

func (o ClientLibrarySettingsResponseArrayOutput) ToClientLibrarySettingsResponseArrayOutput() ClientLibrarySettingsResponseArrayOutput

func (ClientLibrarySettingsResponseArrayOutput) ToClientLibrarySettingsResponseArrayOutputWithContext added in v0.28.0

func (o ClientLibrarySettingsResponseArrayOutput) ToClientLibrarySettingsResponseArrayOutputWithContext(ctx context.Context) ClientLibrarySettingsResponseArrayOutput

type ClientLibrarySettingsResponseOutput added in v0.28.0

type ClientLibrarySettingsResponseOutput struct{ *pulumi.OutputState }

Details about how and where to publish client libraries.

func (ClientLibrarySettingsResponseOutput) CppSettings added in v0.28.0

Settings for C++ client libraries.

func (ClientLibrarySettingsResponseOutput) DotnetSettings added in v0.28.0

Settings for .NET client libraries.

func (ClientLibrarySettingsResponseOutput) ElementType added in v0.28.0

func (ClientLibrarySettingsResponseOutput) GoSettings added in v0.28.0

Settings for Go client libraries.

func (ClientLibrarySettingsResponseOutput) JavaSettings added in v0.28.0

Settings for legacy Java features, supported in the Service YAML.

func (ClientLibrarySettingsResponseOutput) LaunchStage added in v0.28.0

Launch stage of this version of the API.

func (ClientLibrarySettingsResponseOutput) NodeSettings added in v0.28.0

Settings for Node client libraries.

func (ClientLibrarySettingsResponseOutput) PhpSettings added in v0.28.0

Settings for PHP client libraries.

func (ClientLibrarySettingsResponseOutput) PythonSettings added in v0.28.0

Settings for Python client libraries.

func (ClientLibrarySettingsResponseOutput) RestNumericEnums added in v0.28.0

When using transport=rest, the client request will encode enums as numbers rather than strings.

func (ClientLibrarySettingsResponseOutput) RubySettings added in v0.28.0

Settings for Ruby client libraries.

func (ClientLibrarySettingsResponseOutput) ToClientLibrarySettingsResponseOutput added in v0.28.0

func (o ClientLibrarySettingsResponseOutput) ToClientLibrarySettingsResponseOutput() ClientLibrarySettingsResponseOutput

func (ClientLibrarySettingsResponseOutput) ToClientLibrarySettingsResponseOutputWithContext added in v0.28.0

func (o ClientLibrarySettingsResponseOutput) ToClientLibrarySettingsResponseOutputWithContext(ctx context.Context) ClientLibrarySettingsResponseOutput

func (ClientLibrarySettingsResponseOutput) Version added in v0.28.0

Version of the API to apply these settings to. This is the full protobuf package for the API, ending in the version element. Examples: "google.cloud.speech.v1" and "google.spanner.admin.database.v1".

type CommonLanguageSettings added in v0.28.0

type CommonLanguageSettings struct {
	// The destination where API teams want this client library to be published.
	Destinations []CommonLanguageSettingsDestinationsItem `pulumi:"destinations"`
	// Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest
	ReferenceDocsUri *string `pulumi:"referenceDocsUri"`
}

Required information for every language.

type CommonLanguageSettingsArgs added in v0.28.0

type CommonLanguageSettingsArgs struct {
	// The destination where API teams want this client library to be published.
	Destinations CommonLanguageSettingsDestinationsItemArrayInput `pulumi:"destinations"`
	// Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest
	ReferenceDocsUri pulumi.StringPtrInput `pulumi:"referenceDocsUri"`
}

Required information for every language.

func (CommonLanguageSettingsArgs) ElementType added in v0.28.0

func (CommonLanguageSettingsArgs) ElementType() reflect.Type

func (CommonLanguageSettingsArgs) ToCommonLanguageSettingsOutput added in v0.28.0

func (i CommonLanguageSettingsArgs) ToCommonLanguageSettingsOutput() CommonLanguageSettingsOutput

func (CommonLanguageSettingsArgs) ToCommonLanguageSettingsOutputWithContext added in v0.28.0

func (i CommonLanguageSettingsArgs) ToCommonLanguageSettingsOutputWithContext(ctx context.Context) CommonLanguageSettingsOutput

func (CommonLanguageSettingsArgs) ToCommonLanguageSettingsPtrOutput added in v0.28.0

func (i CommonLanguageSettingsArgs) ToCommonLanguageSettingsPtrOutput() CommonLanguageSettingsPtrOutput

func (CommonLanguageSettingsArgs) ToCommonLanguageSettingsPtrOutputWithContext added in v0.28.0

func (i CommonLanguageSettingsArgs) ToCommonLanguageSettingsPtrOutputWithContext(ctx context.Context) CommonLanguageSettingsPtrOutput

type CommonLanguageSettingsDestinationsItem added in v0.28.0

type CommonLanguageSettingsDestinationsItem string

func (CommonLanguageSettingsDestinationsItem) ElementType added in v0.28.0

func (CommonLanguageSettingsDestinationsItem) ToCommonLanguageSettingsDestinationsItemOutput added in v0.28.0

func (e CommonLanguageSettingsDestinationsItem) ToCommonLanguageSettingsDestinationsItemOutput() CommonLanguageSettingsDestinationsItemOutput

func (CommonLanguageSettingsDestinationsItem) ToCommonLanguageSettingsDestinationsItemOutputWithContext added in v0.28.0

func (e CommonLanguageSettingsDestinationsItem) ToCommonLanguageSettingsDestinationsItemOutputWithContext(ctx context.Context) CommonLanguageSettingsDestinationsItemOutput

func (CommonLanguageSettingsDestinationsItem) ToCommonLanguageSettingsDestinationsItemPtrOutput added in v0.28.0

func (e CommonLanguageSettingsDestinationsItem) ToCommonLanguageSettingsDestinationsItemPtrOutput() CommonLanguageSettingsDestinationsItemPtrOutput

func (CommonLanguageSettingsDestinationsItem) ToCommonLanguageSettingsDestinationsItemPtrOutputWithContext added in v0.28.0

func (e CommonLanguageSettingsDestinationsItem) ToCommonLanguageSettingsDestinationsItemPtrOutputWithContext(ctx context.Context) CommonLanguageSettingsDestinationsItemPtrOutput

func (CommonLanguageSettingsDestinationsItem) ToStringOutput added in v0.28.0

func (CommonLanguageSettingsDestinationsItem) ToStringOutputWithContext added in v0.28.0

func (CommonLanguageSettingsDestinationsItem) ToStringPtrOutput added in v0.28.0

func (CommonLanguageSettingsDestinationsItem) ToStringPtrOutputWithContext added in v0.28.0

func (e CommonLanguageSettingsDestinationsItem) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type CommonLanguageSettingsDestinationsItemArray added in v0.28.0

type CommonLanguageSettingsDestinationsItemArray []CommonLanguageSettingsDestinationsItem

func (CommonLanguageSettingsDestinationsItemArray) ElementType added in v0.28.0

func (CommonLanguageSettingsDestinationsItemArray) ToCommonLanguageSettingsDestinationsItemArrayOutput added in v0.28.0

func (i CommonLanguageSettingsDestinationsItemArray) ToCommonLanguageSettingsDestinationsItemArrayOutput() CommonLanguageSettingsDestinationsItemArrayOutput

func (CommonLanguageSettingsDestinationsItemArray) ToCommonLanguageSettingsDestinationsItemArrayOutputWithContext added in v0.28.0

func (i CommonLanguageSettingsDestinationsItemArray) ToCommonLanguageSettingsDestinationsItemArrayOutputWithContext(ctx context.Context) CommonLanguageSettingsDestinationsItemArrayOutput

type CommonLanguageSettingsDestinationsItemArrayInput added in v0.28.0

type CommonLanguageSettingsDestinationsItemArrayInput interface {
	pulumi.Input

	ToCommonLanguageSettingsDestinationsItemArrayOutput() CommonLanguageSettingsDestinationsItemArrayOutput
	ToCommonLanguageSettingsDestinationsItemArrayOutputWithContext(context.Context) CommonLanguageSettingsDestinationsItemArrayOutput
}

CommonLanguageSettingsDestinationsItemArrayInput is an input type that accepts CommonLanguageSettingsDestinationsItemArray and CommonLanguageSettingsDestinationsItemArrayOutput values. You can construct a concrete instance of `CommonLanguageSettingsDestinationsItemArrayInput` via:

CommonLanguageSettingsDestinationsItemArray{ CommonLanguageSettingsDestinationsItemArgs{...} }

type CommonLanguageSettingsDestinationsItemArrayOutput added in v0.28.0

type CommonLanguageSettingsDestinationsItemArrayOutput struct{ *pulumi.OutputState }

func (CommonLanguageSettingsDestinationsItemArrayOutput) ElementType added in v0.28.0

func (CommonLanguageSettingsDestinationsItemArrayOutput) Index added in v0.28.0

func (CommonLanguageSettingsDestinationsItemArrayOutput) ToCommonLanguageSettingsDestinationsItemArrayOutput added in v0.28.0

func (o CommonLanguageSettingsDestinationsItemArrayOutput) ToCommonLanguageSettingsDestinationsItemArrayOutput() CommonLanguageSettingsDestinationsItemArrayOutput

func (CommonLanguageSettingsDestinationsItemArrayOutput) ToCommonLanguageSettingsDestinationsItemArrayOutputWithContext added in v0.28.0

func (o CommonLanguageSettingsDestinationsItemArrayOutput) ToCommonLanguageSettingsDestinationsItemArrayOutputWithContext(ctx context.Context) CommonLanguageSettingsDestinationsItemArrayOutput

type CommonLanguageSettingsDestinationsItemInput added in v0.28.0

type CommonLanguageSettingsDestinationsItemInput interface {
	pulumi.Input

	ToCommonLanguageSettingsDestinationsItemOutput() CommonLanguageSettingsDestinationsItemOutput
	ToCommonLanguageSettingsDestinationsItemOutputWithContext(context.Context) CommonLanguageSettingsDestinationsItemOutput
}

CommonLanguageSettingsDestinationsItemInput is an input type that accepts CommonLanguageSettingsDestinationsItemArgs and CommonLanguageSettingsDestinationsItemOutput values. You can construct a concrete instance of `CommonLanguageSettingsDestinationsItemInput` via:

CommonLanguageSettingsDestinationsItemArgs{...}

type CommonLanguageSettingsDestinationsItemOutput added in v0.28.0

type CommonLanguageSettingsDestinationsItemOutput struct{ *pulumi.OutputState }

func (CommonLanguageSettingsDestinationsItemOutput) ElementType added in v0.28.0

func (CommonLanguageSettingsDestinationsItemOutput) ToCommonLanguageSettingsDestinationsItemOutput added in v0.28.0

func (o CommonLanguageSettingsDestinationsItemOutput) ToCommonLanguageSettingsDestinationsItemOutput() CommonLanguageSettingsDestinationsItemOutput

func (CommonLanguageSettingsDestinationsItemOutput) ToCommonLanguageSettingsDestinationsItemOutputWithContext added in v0.28.0

func (o CommonLanguageSettingsDestinationsItemOutput) ToCommonLanguageSettingsDestinationsItemOutputWithContext(ctx context.Context) CommonLanguageSettingsDestinationsItemOutput

func (CommonLanguageSettingsDestinationsItemOutput) ToCommonLanguageSettingsDestinationsItemPtrOutput added in v0.28.0

func (o CommonLanguageSettingsDestinationsItemOutput) ToCommonLanguageSettingsDestinationsItemPtrOutput() CommonLanguageSettingsDestinationsItemPtrOutput

func (CommonLanguageSettingsDestinationsItemOutput) ToCommonLanguageSettingsDestinationsItemPtrOutputWithContext added in v0.28.0

func (o CommonLanguageSettingsDestinationsItemOutput) ToCommonLanguageSettingsDestinationsItemPtrOutputWithContext(ctx context.Context) CommonLanguageSettingsDestinationsItemPtrOutput

func (CommonLanguageSettingsDestinationsItemOutput) ToStringOutput added in v0.28.0

func (CommonLanguageSettingsDestinationsItemOutput) ToStringOutputWithContext added in v0.28.0

func (CommonLanguageSettingsDestinationsItemOutput) ToStringPtrOutput added in v0.28.0

func (CommonLanguageSettingsDestinationsItemOutput) ToStringPtrOutputWithContext added in v0.28.0

type CommonLanguageSettingsDestinationsItemPtrInput added in v0.28.0

type CommonLanguageSettingsDestinationsItemPtrInput interface {
	pulumi.Input

	ToCommonLanguageSettingsDestinationsItemPtrOutput() CommonLanguageSettingsDestinationsItemPtrOutput
	ToCommonLanguageSettingsDestinationsItemPtrOutputWithContext(context.Context) CommonLanguageSettingsDestinationsItemPtrOutput
}

func CommonLanguageSettingsDestinationsItemPtr added in v0.28.0

func CommonLanguageSettingsDestinationsItemPtr(v string) CommonLanguageSettingsDestinationsItemPtrInput

type CommonLanguageSettingsDestinationsItemPtrOutput added in v0.28.0

type CommonLanguageSettingsDestinationsItemPtrOutput struct{ *pulumi.OutputState }

func (CommonLanguageSettingsDestinationsItemPtrOutput) Elem added in v0.28.0

func (CommonLanguageSettingsDestinationsItemPtrOutput) ElementType added in v0.28.0

func (CommonLanguageSettingsDestinationsItemPtrOutput) ToCommonLanguageSettingsDestinationsItemPtrOutput added in v0.28.0

func (o CommonLanguageSettingsDestinationsItemPtrOutput) ToCommonLanguageSettingsDestinationsItemPtrOutput() CommonLanguageSettingsDestinationsItemPtrOutput

func (CommonLanguageSettingsDestinationsItemPtrOutput) ToCommonLanguageSettingsDestinationsItemPtrOutputWithContext added in v0.28.0

func (o CommonLanguageSettingsDestinationsItemPtrOutput) ToCommonLanguageSettingsDestinationsItemPtrOutputWithContext(ctx context.Context) CommonLanguageSettingsDestinationsItemPtrOutput

func (CommonLanguageSettingsDestinationsItemPtrOutput) ToStringPtrOutput added in v0.28.0

func (CommonLanguageSettingsDestinationsItemPtrOutput) ToStringPtrOutputWithContext added in v0.28.0

type CommonLanguageSettingsInput added in v0.28.0

type CommonLanguageSettingsInput interface {
	pulumi.Input

	ToCommonLanguageSettingsOutput() CommonLanguageSettingsOutput
	ToCommonLanguageSettingsOutputWithContext(context.Context) CommonLanguageSettingsOutput
}

CommonLanguageSettingsInput is an input type that accepts CommonLanguageSettingsArgs and CommonLanguageSettingsOutput values. You can construct a concrete instance of `CommonLanguageSettingsInput` via:

CommonLanguageSettingsArgs{...}

type CommonLanguageSettingsOutput added in v0.28.0

type CommonLanguageSettingsOutput struct{ *pulumi.OutputState }

Required information for every language.

func (CommonLanguageSettingsOutput) Destinations added in v0.28.0

The destination where API teams want this client library to be published.

func (CommonLanguageSettingsOutput) ElementType added in v0.28.0

func (CommonLanguageSettingsOutput) ReferenceDocsUri added in v0.28.0

Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest

func (CommonLanguageSettingsOutput) ToCommonLanguageSettingsOutput added in v0.28.0

func (o CommonLanguageSettingsOutput) ToCommonLanguageSettingsOutput() CommonLanguageSettingsOutput

func (CommonLanguageSettingsOutput) ToCommonLanguageSettingsOutputWithContext added in v0.28.0

func (o CommonLanguageSettingsOutput) ToCommonLanguageSettingsOutputWithContext(ctx context.Context) CommonLanguageSettingsOutput

func (CommonLanguageSettingsOutput) ToCommonLanguageSettingsPtrOutput added in v0.28.0

func (o CommonLanguageSettingsOutput) ToCommonLanguageSettingsPtrOutput() CommonLanguageSettingsPtrOutput

func (CommonLanguageSettingsOutput) ToCommonLanguageSettingsPtrOutputWithContext added in v0.28.0

func (o CommonLanguageSettingsOutput) ToCommonLanguageSettingsPtrOutputWithContext(ctx context.Context) CommonLanguageSettingsPtrOutput

type CommonLanguageSettingsPtrInput added in v0.28.0

type CommonLanguageSettingsPtrInput interface {
	pulumi.Input

	ToCommonLanguageSettingsPtrOutput() CommonLanguageSettingsPtrOutput
	ToCommonLanguageSettingsPtrOutputWithContext(context.Context) CommonLanguageSettingsPtrOutput
}

CommonLanguageSettingsPtrInput is an input type that accepts CommonLanguageSettingsArgs, CommonLanguageSettingsPtr and CommonLanguageSettingsPtrOutput values. You can construct a concrete instance of `CommonLanguageSettingsPtrInput` via:

        CommonLanguageSettingsArgs{...}

or:

        nil

func CommonLanguageSettingsPtr added in v0.28.0

func CommonLanguageSettingsPtr(v *CommonLanguageSettingsArgs) CommonLanguageSettingsPtrInput

type CommonLanguageSettingsPtrOutput added in v0.28.0

type CommonLanguageSettingsPtrOutput struct{ *pulumi.OutputState }

func (CommonLanguageSettingsPtrOutput) Destinations added in v0.28.0

The destination where API teams want this client library to be published.

func (CommonLanguageSettingsPtrOutput) Elem added in v0.28.0

func (CommonLanguageSettingsPtrOutput) ElementType added in v0.28.0

func (CommonLanguageSettingsPtrOutput) ReferenceDocsUri added in v0.28.0

Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest

func (CommonLanguageSettingsPtrOutput) ToCommonLanguageSettingsPtrOutput added in v0.28.0

func (o CommonLanguageSettingsPtrOutput) ToCommonLanguageSettingsPtrOutput() CommonLanguageSettingsPtrOutput

func (CommonLanguageSettingsPtrOutput) ToCommonLanguageSettingsPtrOutputWithContext added in v0.28.0

func (o CommonLanguageSettingsPtrOutput) ToCommonLanguageSettingsPtrOutputWithContext(ctx context.Context) CommonLanguageSettingsPtrOutput

type CommonLanguageSettingsResponse added in v0.28.0

type CommonLanguageSettingsResponse struct {
	// The destination where API teams want this client library to be published.
	Destinations []string `pulumi:"destinations"`
	// Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest
	ReferenceDocsUri string `pulumi:"referenceDocsUri"`
}

Required information for every language.

type CommonLanguageSettingsResponseOutput added in v0.28.0

type CommonLanguageSettingsResponseOutput struct{ *pulumi.OutputState }

Required information for every language.

func (CommonLanguageSettingsResponseOutput) Destinations added in v0.28.0

The destination where API teams want this client library to be published.

func (CommonLanguageSettingsResponseOutput) ElementType added in v0.28.0

func (CommonLanguageSettingsResponseOutput) ReferenceDocsUri added in v0.28.0

Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest

func (CommonLanguageSettingsResponseOutput) ToCommonLanguageSettingsResponseOutput added in v0.28.0

func (o CommonLanguageSettingsResponseOutput) ToCommonLanguageSettingsResponseOutput() CommonLanguageSettingsResponseOutput

func (CommonLanguageSettingsResponseOutput) ToCommonLanguageSettingsResponseOutputWithContext added in v0.28.0

func (o CommonLanguageSettingsResponseOutput) ToCommonLanguageSettingsResponseOutputWithContext(ctx context.Context) CommonLanguageSettingsResponseOutput

type Config added in v0.3.0

type Config struct {
	pulumi.CustomResourceState

	// A list of API interfaces exported by this service. Only the `name` field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files.
	Apis ApiResponseArrayOutput `pulumi:"apis"`
	// Auth configuration.
	Authentication AuthenticationResponseOutput `pulumi:"authentication"`
	// API backend configuration.
	Backend BackendResponseOutput `pulumi:"backend"`
	// Billing configuration.
	Billing BillingResponseOutput `pulumi:"billing"`
	// Obsolete. Do not use. This field has no semantic meaning. The service config compiler always sets this field to `3`.
	ConfigVersion pulumi.IntOutput `pulumi:"configVersion"`
	// Context configuration.
	Context ContextResponseOutput `pulumi:"context"`
	// Configuration for the service control plane.
	Control ControlResponseOutput `pulumi:"control"`
	// Custom error configuration.
	CustomError CustomErrorResponseOutput `pulumi:"customError"`
	// Additional API documentation.
	Documentation DocumentationResponseOutput `pulumi:"documentation"`
	// Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs.
	Endpoints EndpointResponseArrayOutput `pulumi:"endpoints"`
	// A list of all enum types included in this API service. Enums referenced directly or indirectly by the `apis` are automatically included. Enums which are not referenced but shall be included should be listed here by name by the configuration author. Example: enums: - name: google.someapi.v1.SomeEnum
	Enums EnumResponseArrayOutput `pulumi:"enums"`
	// HTTP configuration.
	Http HttpResponseOutput `pulumi:"http"`
	// Logging configuration.
	Logging LoggingResponseOutput `pulumi:"logging"`
	// Defines the logs used by this service.
	Logs LogDescriptorResponseArrayOutput `pulumi:"logs"`
	// Defines the metrics used by this service.
	Metrics MetricDescriptorResponseArrayOutput `pulumi:"metrics"`
	// Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.
	MonitoredResources MonitoredResourceDescriptorResponseArrayOutput `pulumi:"monitoredResources"`
	// Monitoring configuration.
	Monitoring MonitoringResponseOutput `pulumi:"monitoring"`
	// The service name, which is a DNS-like logical identifier for the service, such as `calendar.googleapis.com`. The service name typically goes through DNS verification to make sure the owner of the service also owns the DNS name.
	Name pulumi.StringOutput `pulumi:"name"`
	// The Google project that owns this service.
	ProducerProjectId pulumi.StringOutput `pulumi:"producerProjectId"`
	// Settings for [Google Cloud Client libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) generated from APIs defined as protocol buffers.
	Publishing PublishingResponseOutput `pulumi:"publishing"`
	// Quota configuration.
	Quota       QuotaResponseOutput `pulumi:"quota"`
	ServiceName pulumi.StringOutput `pulumi:"serviceName"`
	// The source information for this configuration if available.
	SourceInfo SourceInfoResponseOutput `pulumi:"sourceInfo"`
	// System parameter configuration.
	SystemParameters SystemParametersResponseOutput `pulumi:"systemParameters"`
	// A list of all proto message types included in this API service. It serves similar purpose as [google.api.Service.types], except that these types are not needed by user-defined APIs. Therefore, they will not show up in the generated discovery doc. This field should only be used to define system APIs in ESF.
	SystemTypes TypeResponseArrayOutput `pulumi:"systemTypes"`
	// The product title for this service, it is the name displayed in Google Cloud Console.
	Title pulumi.StringOutput `pulumi:"title"`
	// A list of all proto message types included in this API service. Types referenced directly or indirectly by the `apis` are automatically included. Messages which are not referenced but shall be included, such as types used by the `google.protobuf.Any` type, should be listed here by name by the configuration author. Example: types: - name: google.protobuf.Int32
	Types TypeResponseArrayOutput `pulumi:"types"`
	// Configuration controlling usage of this service.
	Usage UsageResponseOutput `pulumi:"usage"`
}

Creates a new service configuration (version) for a managed service. This method only stores the service configuration. To roll out the service configuration to backend systems please call CreateServiceRollout. Only the 100 most recent service configurations and ones referenced by existing rollouts are kept for each service. The rest will be deleted eventually. Note - this resource's API doesn't support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.

func GetConfig added in v0.3.0

func GetConfig(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ConfigState, opts ...pulumi.ResourceOption) (*Config, error)

GetConfig gets an existing Config resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewConfig added in v0.3.0

func NewConfig(ctx *pulumi.Context,
	name string, args *ConfigArgs, opts ...pulumi.ResourceOption) (*Config, error)

NewConfig registers a new resource with the given unique name, arguments, and options.

func (*Config) ElementType added in v0.3.0

func (*Config) ElementType() reflect.Type

func (*Config) ToConfigOutput added in v0.3.0

func (i *Config) ToConfigOutput() ConfigOutput

func (*Config) ToConfigOutputWithContext added in v0.3.0

func (i *Config) ToConfigOutputWithContext(ctx context.Context) ConfigOutput

type ConfigArgs added in v0.3.0

type ConfigArgs struct {
	// A list of API interfaces exported by this service. Only the `name` field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files.
	Apis ApiArrayInput
	// Auth configuration.
	Authentication AuthenticationPtrInput
	// API backend configuration.
	Backend BackendPtrInput
	// Billing configuration.
	Billing BillingPtrInput
	// Obsolete. Do not use. This field has no semantic meaning. The service config compiler always sets this field to `3`.
	ConfigVersion pulumi.IntPtrInput
	// Context configuration.
	Context ContextPtrInput
	// Configuration for the service control plane.
	Control ControlPtrInput
	// Custom error configuration.
	CustomError CustomErrorPtrInput
	// Additional API documentation.
	Documentation DocumentationPtrInput
	// Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs.
	Endpoints EndpointArrayInput
	// A list of all enum types included in this API service. Enums referenced directly or indirectly by the `apis` are automatically included. Enums which are not referenced but shall be included should be listed here by name by the configuration author. Example: enums: - name: google.someapi.v1.SomeEnum
	Enums EnumArrayInput
	// HTTP configuration.
	Http HttpPtrInput
	// A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose. Must be no longer than 63 characters and only lower case letters, digits, '.', '_' and '-' are allowed. If empty, the server may choose to generate one instead.
	Id pulumi.StringPtrInput
	// Logging configuration.
	Logging LoggingPtrInput
	// Defines the logs used by this service.
	Logs LogDescriptorArrayInput
	// Defines the metrics used by this service.
	Metrics MetricDescriptorArrayInput
	// Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.
	MonitoredResources MonitoredResourceDescriptorArrayInput
	// Monitoring configuration.
	Monitoring MonitoringPtrInput
	// The service name, which is a DNS-like logical identifier for the service, such as `calendar.googleapis.com`. The service name typically goes through DNS verification to make sure the owner of the service also owns the DNS name.
	Name pulumi.StringPtrInput
	// The Google project that owns this service.
	ProducerProjectId pulumi.StringPtrInput
	// Settings for [Google Cloud Client libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) generated from APIs defined as protocol buffers.
	Publishing PublishingPtrInput
	// Quota configuration.
	Quota       QuotaPtrInput
	ServiceName pulumi.StringInput
	// System parameter configuration.
	SystemParameters SystemParametersPtrInput
	// A list of all proto message types included in this API service. It serves similar purpose as [google.api.Service.types], except that these types are not needed by user-defined APIs. Therefore, they will not show up in the generated discovery doc. This field should only be used to define system APIs in ESF.
	SystemTypes TypeArrayInput
	// The product title for this service, it is the name displayed in Google Cloud Console.
	Title pulumi.StringPtrInput
	// A list of all proto message types included in this API service. Types referenced directly or indirectly by the `apis` are automatically included. Messages which are not referenced but shall be included, such as types used by the `google.protobuf.Any` type, should be listed here by name by the configuration author. Example: types: - name: google.protobuf.Int32
	Types TypeArrayInput
	// Configuration controlling usage of this service.
	Usage UsagePtrInput
}

The set of arguments for constructing a Config resource.

func (ConfigArgs) ElementType added in v0.3.0

func (ConfigArgs) ElementType() reflect.Type

type ConfigInput added in v0.3.0

type ConfigInput interface {
	pulumi.Input

	ToConfigOutput() ConfigOutput
	ToConfigOutputWithContext(ctx context.Context) ConfigOutput
}

type ConfigOutput added in v0.3.0

type ConfigOutput struct{ *pulumi.OutputState }

func (ConfigOutput) Apis added in v0.19.0

A list of API interfaces exported by this service. Only the `name` field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files.

func (ConfigOutput) Authentication added in v0.19.0

func (o ConfigOutput) Authentication() AuthenticationResponseOutput

Auth configuration.

func (ConfigOutput) Backend added in v0.19.0

func (o ConfigOutput) Backend() BackendResponseOutput

API backend configuration.

func (ConfigOutput) Billing added in v0.19.0

func (o ConfigOutput) Billing() BillingResponseOutput

Billing configuration.

func (ConfigOutput) ConfigVersion added in v0.19.0

func (o ConfigOutput) ConfigVersion() pulumi.IntOutput

Obsolete. Do not use. This field has no semantic meaning. The service config compiler always sets this field to `3`.

func (ConfigOutput) Context added in v0.19.0

func (o ConfigOutput) Context() ContextResponseOutput

Context configuration.

func (ConfigOutput) Control added in v0.19.0

func (o ConfigOutput) Control() ControlResponseOutput

Configuration for the service control plane.

func (ConfigOutput) CustomError added in v0.19.0

func (o ConfigOutput) CustomError() CustomErrorResponseOutput

Custom error configuration.

func (ConfigOutput) Documentation added in v0.19.0

func (o ConfigOutput) Documentation() DocumentationResponseOutput

Additional API documentation.

func (ConfigOutput) ElementType added in v0.3.0

func (ConfigOutput) ElementType() reflect.Type

func (ConfigOutput) Endpoints added in v0.19.0

Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs.

func (ConfigOutput) Enums added in v0.19.0

A list of all enum types included in this API service. Enums referenced directly or indirectly by the `apis` are automatically included. Enums which are not referenced but shall be included should be listed here by name by the configuration author. Example: enums: - name: google.someapi.v1.SomeEnum

func (ConfigOutput) Http added in v0.19.0

HTTP configuration.

func (ConfigOutput) Logging added in v0.19.0

func (o ConfigOutput) Logging() LoggingResponseOutput

Logging configuration.

func (ConfigOutput) Logs added in v0.19.0

Defines the logs used by this service.

func (ConfigOutput) Metrics added in v0.19.0

Defines the metrics used by this service.

func (ConfigOutput) MonitoredResources added in v0.19.0

Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.

func (ConfigOutput) Monitoring added in v0.19.0

func (o ConfigOutput) Monitoring() MonitoringResponseOutput

Monitoring configuration.

func (ConfigOutput) Name added in v0.19.0

func (o ConfigOutput) Name() pulumi.StringOutput

The service name, which is a DNS-like logical identifier for the service, such as `calendar.googleapis.com`. The service name typically goes through DNS verification to make sure the owner of the service also owns the DNS name.

func (ConfigOutput) ProducerProjectId added in v0.19.0

func (o ConfigOutput) ProducerProjectId() pulumi.StringOutput

The Google project that owns this service.

func (ConfigOutput) Publishing added in v0.28.0

func (o ConfigOutput) Publishing() PublishingResponseOutput

Settings for [Google Cloud Client libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) generated from APIs defined as protocol buffers.

func (ConfigOutput) Quota added in v0.19.0

Quota configuration.

func (ConfigOutput) ServiceName added in v0.21.0

func (o ConfigOutput) ServiceName() pulumi.StringOutput

func (ConfigOutput) SourceInfo added in v0.19.0

func (o ConfigOutput) SourceInfo() SourceInfoResponseOutput

The source information for this configuration if available.

func (ConfigOutput) SystemParameters added in v0.19.0

func (o ConfigOutput) SystemParameters() SystemParametersResponseOutput

System parameter configuration.

func (ConfigOutput) SystemTypes added in v0.19.0

func (o ConfigOutput) SystemTypes() TypeResponseArrayOutput

A list of all proto message types included in this API service. It serves similar purpose as [google.api.Service.types], except that these types are not needed by user-defined APIs. Therefore, they will not show up in the generated discovery doc. This field should only be used to define system APIs in ESF.

func (ConfigOutput) Title added in v0.19.0

func (o ConfigOutput) Title() pulumi.StringOutput

The product title for this service, it is the name displayed in Google Cloud Console.

func (ConfigOutput) ToConfigOutput added in v0.3.0

func (o ConfigOutput) ToConfigOutput() ConfigOutput

func (ConfigOutput) ToConfigOutputWithContext added in v0.3.0

func (o ConfigOutput) ToConfigOutputWithContext(ctx context.Context) ConfigOutput

func (ConfigOutput) Types added in v0.19.0

A list of all proto message types included in this API service. Types referenced directly or indirectly by the `apis` are automatically included. Messages which are not referenced but shall be included, such as types used by the `google.protobuf.Any` type, should be listed here by name by the configuration author. Example: types: - name: google.protobuf.Int32

func (ConfigOutput) Usage added in v0.19.0

Configuration controlling usage of this service.

type ConfigState added in v0.3.0

type ConfigState struct {
}

func (ConfigState) ElementType added in v0.3.0

func (ConfigState) ElementType() reflect.Type

type Context

type Context struct {
	// A list of RPC context rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order.
	Rules []ContextRule `pulumi:"rules"`
}

`Context` defines which contexts an API requests. Example: context: rules: - selector: "*" requested: - google.rpc.context.ProjectContext - google.rpc.context.OriginContext The above specifies that all methods in the API request `google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. Available context types are defined in package `google.rpc.context`. This also provides mechanism to allowlist any protobuf message extension that can be sent in grpc metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. For example, list any service specific protobuf types that can appear in grpc metadata as follows in your yaml file: Example: context: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allowed_request_extensions: - google.foo.v1.NewExtension allowed_response_extensions: - google.foo.v1.NewExtension You can also specify extension ID instead of fully qualified extension name here.

type ContextArgs

type ContextArgs struct {
	// A list of RPC context rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order.
	Rules ContextRuleArrayInput `pulumi:"rules"`
}

`Context` defines which contexts an API requests. Example: context: rules: - selector: "*" requested: - google.rpc.context.ProjectContext - google.rpc.context.OriginContext The above specifies that all methods in the API request `google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. Available context types are defined in package `google.rpc.context`. This also provides mechanism to allowlist any protobuf message extension that can be sent in grpc metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. For example, list any service specific protobuf types that can appear in grpc metadata as follows in your yaml file: Example: context: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allowed_request_extensions: - google.foo.v1.NewExtension allowed_response_extensions: - google.foo.v1.NewExtension You can also specify extension ID instead of fully qualified extension name here.

func (ContextArgs) ElementType

func (ContextArgs) ElementType() reflect.Type

func (ContextArgs) ToContextOutput

func (i ContextArgs) ToContextOutput() ContextOutput

func (ContextArgs) ToContextOutputWithContext

func (i ContextArgs) ToContextOutputWithContext(ctx context.Context) ContextOutput

func (ContextArgs) ToContextPtrOutput

func (i ContextArgs) ToContextPtrOutput() ContextPtrOutput

func (ContextArgs) ToContextPtrOutputWithContext

func (i ContextArgs) ToContextPtrOutputWithContext(ctx context.Context) ContextPtrOutput

type ContextInput

type ContextInput interface {
	pulumi.Input

	ToContextOutput() ContextOutput
	ToContextOutputWithContext(context.Context) ContextOutput
}

ContextInput is an input type that accepts ContextArgs and ContextOutput values. You can construct a concrete instance of `ContextInput` via:

ContextArgs{...}

type ContextOutput

type ContextOutput struct{ *pulumi.OutputState }

`Context` defines which contexts an API requests. Example: context: rules: - selector: "*" requested: - google.rpc.context.ProjectContext - google.rpc.context.OriginContext The above specifies that all methods in the API request `google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. Available context types are defined in package `google.rpc.context`. This also provides mechanism to allowlist any protobuf message extension that can be sent in grpc metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. For example, list any service specific protobuf types that can appear in grpc metadata as follows in your yaml file: Example: context: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allowed_request_extensions: - google.foo.v1.NewExtension allowed_response_extensions: - google.foo.v1.NewExtension You can also specify extension ID instead of fully qualified extension name here.

func (ContextOutput) ElementType

func (ContextOutput) ElementType() reflect.Type

func (ContextOutput) Rules

A list of RPC context rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order.

func (ContextOutput) ToContextOutput

func (o ContextOutput) ToContextOutput() ContextOutput

func (ContextOutput) ToContextOutputWithContext

func (o ContextOutput) ToContextOutputWithContext(ctx context.Context) ContextOutput

func (ContextOutput) ToContextPtrOutput

func (o ContextOutput) ToContextPtrOutput() ContextPtrOutput

func (ContextOutput) ToContextPtrOutputWithContext

func (o ContextOutput) ToContextPtrOutputWithContext(ctx context.Context) ContextPtrOutput

type ContextPtrInput

type ContextPtrInput interface {
	pulumi.Input

	ToContextPtrOutput() ContextPtrOutput
	ToContextPtrOutputWithContext(context.Context) ContextPtrOutput
}

ContextPtrInput is an input type that accepts ContextArgs, ContextPtr and ContextPtrOutput values. You can construct a concrete instance of `ContextPtrInput` via:

        ContextArgs{...}

or:

        nil

func ContextPtr

func ContextPtr(v *ContextArgs) ContextPtrInput

type ContextPtrOutput

type ContextPtrOutput struct{ *pulumi.OutputState }

func (ContextPtrOutput) Elem

func (ContextPtrOutput) ElementType

func (ContextPtrOutput) ElementType() reflect.Type

func (ContextPtrOutput) Rules

A list of RPC context rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order.

func (ContextPtrOutput) ToContextPtrOutput

func (o ContextPtrOutput) ToContextPtrOutput() ContextPtrOutput

func (ContextPtrOutput) ToContextPtrOutputWithContext

func (o ContextPtrOutput) ToContextPtrOutputWithContext(ctx context.Context) ContextPtrOutput

type ContextResponse

type ContextResponse struct {
	// A list of RPC context rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order.
	Rules []ContextRuleResponse `pulumi:"rules"`
}

`Context` defines which contexts an API requests. Example: context: rules: - selector: "*" requested: - google.rpc.context.ProjectContext - google.rpc.context.OriginContext The above specifies that all methods in the API request `google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. Available context types are defined in package `google.rpc.context`. This also provides mechanism to allowlist any protobuf message extension that can be sent in grpc metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. For example, list any service specific protobuf types that can appear in grpc metadata as follows in your yaml file: Example: context: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allowed_request_extensions: - google.foo.v1.NewExtension allowed_response_extensions: - google.foo.v1.NewExtension You can also specify extension ID instead of fully qualified extension name here.

type ContextResponseOutput

type ContextResponseOutput struct{ *pulumi.OutputState }

`Context` defines which contexts an API requests. Example: context: rules: - selector: "*" requested: - google.rpc.context.ProjectContext - google.rpc.context.OriginContext The above specifies that all methods in the API request `google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. Available context types are defined in package `google.rpc.context`. This also provides mechanism to allowlist any protobuf message extension that can be sent in grpc metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. For example, list any service specific protobuf types that can appear in grpc metadata as follows in your yaml file: Example: context: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allowed_request_extensions: - google.foo.v1.NewExtension allowed_response_extensions: - google.foo.v1.NewExtension You can also specify extension ID instead of fully qualified extension name here.

func (ContextResponseOutput) ElementType

func (ContextResponseOutput) ElementType() reflect.Type

func (ContextResponseOutput) Rules

A list of RPC context rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order.

func (ContextResponseOutput) ToContextResponseOutput

func (o ContextResponseOutput) ToContextResponseOutput() ContextResponseOutput

func (ContextResponseOutput) ToContextResponseOutputWithContext

func (o ContextResponseOutput) ToContextResponseOutputWithContext(ctx context.Context) ContextResponseOutput

type ContextRule

type ContextRule struct {
	// A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.
	AllowedRequestExtensions []string `pulumi:"allowedRequestExtensions"`
	// A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.
	AllowedResponseExtensions []string `pulumi:"allowedResponseExtensions"`
	// A list of full type names of provided contexts.
	Provided []string `pulumi:"provided"`
	// A list of full type names of requested contexts.
	Requested []string `pulumi:"requested"`
	// Selects the methods to which this rule applies. Refer to selector for syntax details.
	Selector *string `pulumi:"selector"`
}

A context rule provides information about the context for an individual API element.

type ContextRuleArgs

type ContextRuleArgs struct {
	// A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.
	AllowedRequestExtensions pulumi.StringArrayInput `pulumi:"allowedRequestExtensions"`
	// A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.
	AllowedResponseExtensions pulumi.StringArrayInput `pulumi:"allowedResponseExtensions"`
	// A list of full type names of provided contexts.
	Provided pulumi.StringArrayInput `pulumi:"provided"`
	// A list of full type names of requested contexts.
	Requested pulumi.StringArrayInput `pulumi:"requested"`
	// Selects the methods to which this rule applies. Refer to selector for syntax details.
	Selector pulumi.StringPtrInput `pulumi:"selector"`
}

A context rule provides information about the context for an individual API element.

func (ContextRuleArgs) ElementType

func (ContextRuleArgs) ElementType() reflect.Type

func (ContextRuleArgs) ToContextRuleOutput

func (i ContextRuleArgs) ToContextRuleOutput() ContextRuleOutput

func (ContextRuleArgs) ToContextRuleOutputWithContext

func (i ContextRuleArgs) ToContextRuleOutputWithContext(ctx context.Context) ContextRuleOutput

type ContextRuleArray

type ContextRuleArray []ContextRuleInput

func (ContextRuleArray) ElementType

func (ContextRuleArray) ElementType() reflect.Type

func (ContextRuleArray) ToContextRuleArrayOutput

func (i ContextRuleArray) ToContextRuleArrayOutput() ContextRuleArrayOutput

func (ContextRuleArray) ToContextRuleArrayOutputWithContext

func (i ContextRuleArray) ToContextRuleArrayOutputWithContext(ctx context.Context) ContextRuleArrayOutput

type ContextRuleArrayInput

type ContextRuleArrayInput interface {
	pulumi.Input

	ToContextRuleArrayOutput() ContextRuleArrayOutput
	ToContextRuleArrayOutputWithContext(context.Context) ContextRuleArrayOutput
}

ContextRuleArrayInput is an input type that accepts ContextRuleArray and ContextRuleArrayOutput values. You can construct a concrete instance of `ContextRuleArrayInput` via:

ContextRuleArray{ ContextRuleArgs{...} }

type ContextRuleArrayOutput

type ContextRuleArrayOutput struct{ *pulumi.OutputState }

func (ContextRuleArrayOutput) ElementType

func (ContextRuleArrayOutput) ElementType() reflect.Type

func (ContextRuleArrayOutput) Index

func (ContextRuleArrayOutput) ToContextRuleArrayOutput

func (o ContextRuleArrayOutput) ToContextRuleArrayOutput() ContextRuleArrayOutput

func (ContextRuleArrayOutput) ToContextRuleArrayOutputWithContext

func (o ContextRuleArrayOutput) ToContextRuleArrayOutputWithContext(ctx context.Context) ContextRuleArrayOutput

type ContextRuleInput

type ContextRuleInput interface {
	pulumi.Input

	ToContextRuleOutput() ContextRuleOutput
	ToContextRuleOutputWithContext(context.Context) ContextRuleOutput
}

ContextRuleInput is an input type that accepts ContextRuleArgs and ContextRuleOutput values. You can construct a concrete instance of `ContextRuleInput` via:

ContextRuleArgs{...}

type ContextRuleOutput

type ContextRuleOutput struct{ *pulumi.OutputState }

A context rule provides information about the context for an individual API element.

func (ContextRuleOutput) AllowedRequestExtensions

func (o ContextRuleOutput) AllowedRequestExtensions() pulumi.StringArrayOutput

A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.

func (ContextRuleOutput) AllowedResponseExtensions

func (o ContextRuleOutput) AllowedResponseExtensions() pulumi.StringArrayOutput

A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.

func (ContextRuleOutput) ElementType

func (ContextRuleOutput) ElementType() reflect.Type

func (ContextRuleOutput) Provided

A list of full type names of provided contexts.

func (ContextRuleOutput) Requested

A list of full type names of requested contexts.

func (ContextRuleOutput) Selector

Selects the methods to which this rule applies. Refer to selector for syntax details.

func (ContextRuleOutput) ToContextRuleOutput

func (o ContextRuleOutput) ToContextRuleOutput() ContextRuleOutput

func (ContextRuleOutput) ToContextRuleOutputWithContext

func (o ContextRuleOutput) ToContextRuleOutputWithContext(ctx context.Context) ContextRuleOutput

type ContextRuleResponse

type ContextRuleResponse struct {
	// A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.
	AllowedRequestExtensions []string `pulumi:"allowedRequestExtensions"`
	// A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.
	AllowedResponseExtensions []string `pulumi:"allowedResponseExtensions"`
	// A list of full type names of provided contexts.
	Provided []string `pulumi:"provided"`
	// A list of full type names of requested contexts.
	Requested []string `pulumi:"requested"`
	// Selects the methods to which this rule applies. Refer to selector for syntax details.
	Selector string `pulumi:"selector"`
}

A context rule provides information about the context for an individual API element.

type ContextRuleResponseArrayOutput

type ContextRuleResponseArrayOutput struct{ *pulumi.OutputState }

func (ContextRuleResponseArrayOutput) ElementType

func (ContextRuleResponseArrayOutput) Index

func (ContextRuleResponseArrayOutput) ToContextRuleResponseArrayOutput

func (o ContextRuleResponseArrayOutput) ToContextRuleResponseArrayOutput() ContextRuleResponseArrayOutput

func (ContextRuleResponseArrayOutput) ToContextRuleResponseArrayOutputWithContext

func (o ContextRuleResponseArrayOutput) ToContextRuleResponseArrayOutputWithContext(ctx context.Context) ContextRuleResponseArrayOutput

type ContextRuleResponseOutput

type ContextRuleResponseOutput struct{ *pulumi.OutputState }

A context rule provides information about the context for an individual API element.

func (ContextRuleResponseOutput) AllowedRequestExtensions

func (o ContextRuleResponseOutput) AllowedRequestExtensions() pulumi.StringArrayOutput

A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.

func (ContextRuleResponseOutput) AllowedResponseExtensions

func (o ContextRuleResponseOutput) AllowedResponseExtensions() pulumi.StringArrayOutput

A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.

func (ContextRuleResponseOutput) ElementType

func (ContextRuleResponseOutput) ElementType() reflect.Type

func (ContextRuleResponseOutput) Provided

A list of full type names of provided contexts.

func (ContextRuleResponseOutput) Requested

A list of full type names of requested contexts.

func (ContextRuleResponseOutput) Selector

Selects the methods to which this rule applies. Refer to selector for syntax details.

func (ContextRuleResponseOutput) ToContextRuleResponseOutput

func (o ContextRuleResponseOutput) ToContextRuleResponseOutput() ContextRuleResponseOutput

func (ContextRuleResponseOutput) ToContextRuleResponseOutputWithContext

func (o ContextRuleResponseOutput) ToContextRuleResponseOutputWithContext(ctx context.Context) ContextRuleResponseOutput

type Control

type Control struct {
	// The service controller environment to use. If empty, no control plane feature (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com
	Environment *string `pulumi:"environment"`
	// Defines policies applying to the API methods of the service.
	MethodPolicies []MethodPolicy `pulumi:"methodPolicies"`
}

Selects and configures the service controller used by the service. Example: control: environment: servicecontrol.googleapis.com

type ControlArgs

type ControlArgs struct {
	// The service controller environment to use. If empty, no control plane feature (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com
	Environment pulumi.StringPtrInput `pulumi:"environment"`
	// Defines policies applying to the API methods of the service.
	MethodPolicies MethodPolicyArrayInput `pulumi:"methodPolicies"`
}

Selects and configures the service controller used by the service. Example: control: environment: servicecontrol.googleapis.com

func (ControlArgs) ElementType

func (ControlArgs) ElementType() reflect.Type

func (ControlArgs) ToControlOutput

func (i ControlArgs) ToControlOutput() ControlOutput

func (ControlArgs) ToControlOutputWithContext

func (i ControlArgs) ToControlOutputWithContext(ctx context.Context) ControlOutput

func (ControlArgs) ToControlPtrOutput

func (i ControlArgs) ToControlPtrOutput() ControlPtrOutput

func (ControlArgs) ToControlPtrOutputWithContext

func (i ControlArgs) ToControlPtrOutputWithContext(ctx context.Context) ControlPtrOutput

type ControlInput

type ControlInput interface {
	pulumi.Input

	ToControlOutput() ControlOutput
	ToControlOutputWithContext(context.Context) ControlOutput
}

ControlInput is an input type that accepts ControlArgs and ControlOutput values. You can construct a concrete instance of `ControlInput` via:

ControlArgs{...}

type ControlOutput

type ControlOutput struct{ *pulumi.OutputState }

Selects and configures the service controller used by the service. Example: control: environment: servicecontrol.googleapis.com

func (ControlOutput) ElementType

func (ControlOutput) ElementType() reflect.Type

func (ControlOutput) Environment

func (o ControlOutput) Environment() pulumi.StringPtrOutput

The service controller environment to use. If empty, no control plane feature (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com

func (ControlOutput) MethodPolicies added in v0.32.0

func (o ControlOutput) MethodPolicies() MethodPolicyArrayOutput

Defines policies applying to the API methods of the service.

func (ControlOutput) ToControlOutput

func (o ControlOutput) ToControlOutput() ControlOutput

func (ControlOutput) ToControlOutputWithContext

func (o ControlOutput) ToControlOutputWithContext(ctx context.Context) ControlOutput

func (ControlOutput) ToControlPtrOutput

func (o ControlOutput) ToControlPtrOutput() ControlPtrOutput

func (ControlOutput) ToControlPtrOutputWithContext

func (o ControlOutput) ToControlPtrOutputWithContext(ctx context.Context) ControlPtrOutput

type ControlPtrInput

type ControlPtrInput interface {
	pulumi.Input

	ToControlPtrOutput() ControlPtrOutput
	ToControlPtrOutputWithContext(context.Context) ControlPtrOutput
}

ControlPtrInput is an input type that accepts ControlArgs, ControlPtr and ControlPtrOutput values. You can construct a concrete instance of `ControlPtrInput` via:

        ControlArgs{...}

or:

        nil

func ControlPtr

func ControlPtr(v *ControlArgs) ControlPtrInput

type ControlPtrOutput

type ControlPtrOutput struct{ *pulumi.OutputState }

func (ControlPtrOutput) Elem

func (ControlPtrOutput) ElementType

func (ControlPtrOutput) ElementType() reflect.Type

func (ControlPtrOutput) Environment

func (o ControlPtrOutput) Environment() pulumi.StringPtrOutput

The service controller environment to use. If empty, no control plane feature (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com

func (ControlPtrOutput) MethodPolicies added in v0.32.0

func (o ControlPtrOutput) MethodPolicies() MethodPolicyArrayOutput

Defines policies applying to the API methods of the service.

func (ControlPtrOutput) ToControlPtrOutput

func (o ControlPtrOutput) ToControlPtrOutput() ControlPtrOutput

func (ControlPtrOutput) ToControlPtrOutputWithContext

func (o ControlPtrOutput) ToControlPtrOutputWithContext(ctx context.Context) ControlPtrOutput

type ControlResponse

type ControlResponse struct {
	// The service controller environment to use. If empty, no control plane feature (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com
	Environment string `pulumi:"environment"`
	// Defines policies applying to the API methods of the service.
	MethodPolicies []MethodPolicyResponse `pulumi:"methodPolicies"`
}

Selects and configures the service controller used by the service. Example: control: environment: servicecontrol.googleapis.com

type ControlResponseOutput

type ControlResponseOutput struct{ *pulumi.OutputState }

Selects and configures the service controller used by the service. Example: control: environment: servicecontrol.googleapis.com

func (ControlResponseOutput) ElementType

func (ControlResponseOutput) ElementType() reflect.Type

func (ControlResponseOutput) Environment

func (o ControlResponseOutput) Environment() pulumi.StringOutput

The service controller environment to use. If empty, no control plane feature (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com

func (ControlResponseOutput) MethodPolicies added in v0.32.0

Defines policies applying to the API methods of the service.

func (ControlResponseOutput) ToControlResponseOutput

func (o ControlResponseOutput) ToControlResponseOutput() ControlResponseOutput

func (ControlResponseOutput) ToControlResponseOutputWithContext

func (o ControlResponseOutput) ToControlResponseOutputWithContext(ctx context.Context) ControlResponseOutput

type CppSettings added in v0.28.0

type CppSettings struct {
	// Some settings.
	Common *CommonLanguageSettings `pulumi:"common"`
}

Settings for C++ client libraries.

type CppSettingsArgs added in v0.28.0

type CppSettingsArgs struct {
	// Some settings.
	Common CommonLanguageSettingsPtrInput `pulumi:"common"`
}

Settings for C++ client libraries.

func (CppSettingsArgs) ElementType added in v0.28.0

func (CppSettingsArgs) ElementType() reflect.Type

func (CppSettingsArgs) ToCppSettingsOutput added in v0.28.0

func (i CppSettingsArgs) ToCppSettingsOutput() CppSettingsOutput

func (CppSettingsArgs) ToCppSettingsOutputWithContext added in v0.28.0

func (i CppSettingsArgs) ToCppSettingsOutputWithContext(ctx context.Context) CppSettingsOutput

func (CppSettingsArgs) ToCppSettingsPtrOutput added in v0.28.0

func (i CppSettingsArgs) ToCppSettingsPtrOutput() CppSettingsPtrOutput

func (CppSettingsArgs) ToCppSettingsPtrOutputWithContext added in v0.28.0

func (i CppSettingsArgs) ToCppSettingsPtrOutputWithContext(ctx context.Context) CppSettingsPtrOutput

type CppSettingsInput added in v0.28.0

type CppSettingsInput interface {
	pulumi.Input

	ToCppSettingsOutput() CppSettingsOutput
	ToCppSettingsOutputWithContext(context.Context) CppSettingsOutput
}

CppSettingsInput is an input type that accepts CppSettingsArgs and CppSettingsOutput values. You can construct a concrete instance of `CppSettingsInput` via:

CppSettingsArgs{...}

type CppSettingsOutput added in v0.28.0

type CppSettingsOutput struct{ *pulumi.OutputState }

Settings for C++ client libraries.

func (CppSettingsOutput) Common added in v0.28.0

Some settings.

func (CppSettingsOutput) ElementType added in v0.28.0

func (CppSettingsOutput) ElementType() reflect.Type

func (CppSettingsOutput) ToCppSettingsOutput added in v0.28.0

func (o CppSettingsOutput) ToCppSettingsOutput() CppSettingsOutput

func (CppSettingsOutput) ToCppSettingsOutputWithContext added in v0.28.0

func (o CppSettingsOutput) ToCppSettingsOutputWithContext(ctx context.Context) CppSettingsOutput

func (CppSettingsOutput) ToCppSettingsPtrOutput added in v0.28.0

func (o CppSettingsOutput) ToCppSettingsPtrOutput() CppSettingsPtrOutput

func (CppSettingsOutput) ToCppSettingsPtrOutputWithContext added in v0.28.0

func (o CppSettingsOutput) ToCppSettingsPtrOutputWithContext(ctx context.Context) CppSettingsPtrOutput

type CppSettingsPtrInput added in v0.28.0

type CppSettingsPtrInput interface {
	pulumi.Input

	ToCppSettingsPtrOutput() CppSettingsPtrOutput
	ToCppSettingsPtrOutputWithContext(context.Context) CppSettingsPtrOutput
}

CppSettingsPtrInput is an input type that accepts CppSettingsArgs, CppSettingsPtr and CppSettingsPtrOutput values. You can construct a concrete instance of `CppSettingsPtrInput` via:

        CppSettingsArgs{...}

or:

        nil

func CppSettingsPtr added in v0.28.0

func CppSettingsPtr(v *CppSettingsArgs) CppSettingsPtrInput

type CppSettingsPtrOutput added in v0.28.0

type CppSettingsPtrOutput struct{ *pulumi.OutputState }

func (CppSettingsPtrOutput) Common added in v0.28.0

Some settings.

func (CppSettingsPtrOutput) Elem added in v0.28.0

func (CppSettingsPtrOutput) ElementType added in v0.28.0

func (CppSettingsPtrOutput) ElementType() reflect.Type

func (CppSettingsPtrOutput) ToCppSettingsPtrOutput added in v0.28.0

func (o CppSettingsPtrOutput) ToCppSettingsPtrOutput() CppSettingsPtrOutput

func (CppSettingsPtrOutput) ToCppSettingsPtrOutputWithContext added in v0.28.0

func (o CppSettingsPtrOutput) ToCppSettingsPtrOutputWithContext(ctx context.Context) CppSettingsPtrOutput

type CppSettingsResponse added in v0.28.0

type CppSettingsResponse struct {
	// Some settings.
	Common CommonLanguageSettingsResponse `pulumi:"common"`
}

Settings for C++ client libraries.

type CppSettingsResponseOutput added in v0.28.0

type CppSettingsResponseOutput struct{ *pulumi.OutputState }

Settings for C++ client libraries.

func (CppSettingsResponseOutput) Common added in v0.28.0

Some settings.

func (CppSettingsResponseOutput) ElementType added in v0.28.0

func (CppSettingsResponseOutput) ElementType() reflect.Type

func (CppSettingsResponseOutput) ToCppSettingsResponseOutput added in v0.28.0

func (o CppSettingsResponseOutput) ToCppSettingsResponseOutput() CppSettingsResponseOutput

func (CppSettingsResponseOutput) ToCppSettingsResponseOutputWithContext added in v0.28.0

func (o CppSettingsResponseOutput) ToCppSettingsResponseOutputWithContext(ctx context.Context) CppSettingsResponseOutput

type CustomError

type CustomError struct {
	// The list of custom error rules that apply to individual API messages. **NOTE:** All service configuration rules follow "last one wins" order.
	Rules []CustomErrorRule `pulumi:"rules"`
	// The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.
	Types []string `pulumi:"types"`
}

Customize service error responses. For example, list any service specific protobuf types that can appear in error detail lists of error responses. Example: custom_error: types: - google.foo.v1.CustomError - google.foo.v1.AnotherError

type CustomErrorArgs

type CustomErrorArgs struct {
	// The list of custom error rules that apply to individual API messages. **NOTE:** All service configuration rules follow "last one wins" order.
	Rules CustomErrorRuleArrayInput `pulumi:"rules"`
	// The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.
	Types pulumi.StringArrayInput `pulumi:"types"`
}

Customize service error responses. For example, list any service specific protobuf types that can appear in error detail lists of error responses. Example: custom_error: types: - google.foo.v1.CustomError - google.foo.v1.AnotherError

func (CustomErrorArgs) ElementType

func (CustomErrorArgs) ElementType() reflect.Type

func (CustomErrorArgs) ToCustomErrorOutput

func (i CustomErrorArgs) ToCustomErrorOutput() CustomErrorOutput

func (CustomErrorArgs) ToCustomErrorOutputWithContext

func (i CustomErrorArgs) ToCustomErrorOutputWithContext(ctx context.Context) CustomErrorOutput

func (CustomErrorArgs) ToCustomErrorPtrOutput

func (i CustomErrorArgs) ToCustomErrorPtrOutput() CustomErrorPtrOutput

func (CustomErrorArgs) ToCustomErrorPtrOutputWithContext

func (i CustomErrorArgs) ToCustomErrorPtrOutputWithContext(ctx context.Context) CustomErrorPtrOutput

type CustomErrorInput

type CustomErrorInput interface {
	pulumi.Input

	ToCustomErrorOutput() CustomErrorOutput
	ToCustomErrorOutputWithContext(context.Context) CustomErrorOutput
}

CustomErrorInput is an input type that accepts CustomErrorArgs and CustomErrorOutput values. You can construct a concrete instance of `CustomErrorInput` via:

CustomErrorArgs{...}

type CustomErrorOutput

type CustomErrorOutput struct{ *pulumi.OutputState }

Customize service error responses. For example, list any service specific protobuf types that can appear in error detail lists of error responses. Example: custom_error: types: - google.foo.v1.CustomError - google.foo.v1.AnotherError

func (CustomErrorOutput) ElementType

func (CustomErrorOutput) ElementType() reflect.Type

func (CustomErrorOutput) Rules

The list of custom error rules that apply to individual API messages. **NOTE:** All service configuration rules follow "last one wins" order.

func (CustomErrorOutput) ToCustomErrorOutput

func (o CustomErrorOutput) ToCustomErrorOutput() CustomErrorOutput

func (CustomErrorOutput) ToCustomErrorOutputWithContext

func (o CustomErrorOutput) ToCustomErrorOutputWithContext(ctx context.Context) CustomErrorOutput

func (CustomErrorOutput) ToCustomErrorPtrOutput

func (o CustomErrorOutput) ToCustomErrorPtrOutput() CustomErrorPtrOutput

func (CustomErrorOutput) ToCustomErrorPtrOutputWithContext

func (o CustomErrorOutput) ToCustomErrorPtrOutputWithContext(ctx context.Context) CustomErrorPtrOutput

func (CustomErrorOutput) Types

The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.

type CustomErrorPtrInput

type CustomErrorPtrInput interface {
	pulumi.Input

	ToCustomErrorPtrOutput() CustomErrorPtrOutput
	ToCustomErrorPtrOutputWithContext(context.Context) CustomErrorPtrOutput
}

CustomErrorPtrInput is an input type that accepts CustomErrorArgs, CustomErrorPtr and CustomErrorPtrOutput values. You can construct a concrete instance of `CustomErrorPtrInput` via:

        CustomErrorArgs{...}

or:

        nil

func CustomErrorPtr

func CustomErrorPtr(v *CustomErrorArgs) CustomErrorPtrInput

type CustomErrorPtrOutput

type CustomErrorPtrOutput struct{ *pulumi.OutputState }

func (CustomErrorPtrOutput) Elem

func (CustomErrorPtrOutput) ElementType

func (CustomErrorPtrOutput) ElementType() reflect.Type

func (CustomErrorPtrOutput) Rules

The list of custom error rules that apply to individual API messages. **NOTE:** All service configuration rules follow "last one wins" order.

func (CustomErrorPtrOutput) ToCustomErrorPtrOutput

func (o CustomErrorPtrOutput) ToCustomErrorPtrOutput() CustomErrorPtrOutput

func (CustomErrorPtrOutput) ToCustomErrorPtrOutputWithContext

func (o CustomErrorPtrOutput) ToCustomErrorPtrOutputWithContext(ctx context.Context) CustomErrorPtrOutput

func (CustomErrorPtrOutput) Types

The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.

type CustomErrorResponse

type CustomErrorResponse struct {
	// The list of custom error rules that apply to individual API messages. **NOTE:** All service configuration rules follow "last one wins" order.
	Rules []CustomErrorRuleResponse `pulumi:"rules"`
	// The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.
	Types []string `pulumi:"types"`
}

Customize service error responses. For example, list any service specific protobuf types that can appear in error detail lists of error responses. Example: custom_error: types: - google.foo.v1.CustomError - google.foo.v1.AnotherError

type CustomErrorResponseOutput

type CustomErrorResponseOutput struct{ *pulumi.OutputState }

Customize service error responses. For example, list any service specific protobuf types that can appear in error detail lists of error responses. Example: custom_error: types: - google.foo.v1.CustomError - google.foo.v1.AnotherError

func (CustomErrorResponseOutput) ElementType

func (CustomErrorResponseOutput) ElementType() reflect.Type

func (CustomErrorResponseOutput) Rules

The list of custom error rules that apply to individual API messages. **NOTE:** All service configuration rules follow "last one wins" order.

func (CustomErrorResponseOutput) ToCustomErrorResponseOutput

func (o CustomErrorResponseOutput) ToCustomErrorResponseOutput() CustomErrorResponseOutput

func (CustomErrorResponseOutput) ToCustomErrorResponseOutputWithContext

func (o CustomErrorResponseOutput) ToCustomErrorResponseOutputWithContext(ctx context.Context) CustomErrorResponseOutput

func (CustomErrorResponseOutput) Types

The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.

type CustomErrorRule

type CustomErrorRule struct {
	// Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload.
	IsErrorType *bool `pulumi:"isErrorType"`
	// Selects messages to which this rule applies. Refer to selector for syntax details.
	Selector *string `pulumi:"selector"`
}

A custom error rule.

type CustomErrorRuleArgs

type CustomErrorRuleArgs struct {
	// Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload.
	IsErrorType pulumi.BoolPtrInput `pulumi:"isErrorType"`
	// Selects messages to which this rule applies. Refer to selector for syntax details.
	Selector pulumi.StringPtrInput `pulumi:"selector"`
}

A custom error rule.

func (CustomErrorRuleArgs) ElementType

func (CustomErrorRuleArgs) ElementType() reflect.Type

func (CustomErrorRuleArgs) ToCustomErrorRuleOutput

func (i CustomErrorRuleArgs) ToCustomErrorRuleOutput() CustomErrorRuleOutput

func (CustomErrorRuleArgs) ToCustomErrorRuleOutputWithContext

func (i CustomErrorRuleArgs) ToCustomErrorRuleOutputWithContext(ctx context.Context) CustomErrorRuleOutput

type CustomErrorRuleArray

type CustomErrorRuleArray []CustomErrorRuleInput

func (CustomErrorRuleArray) ElementType

func (CustomErrorRuleArray) ElementType() reflect.Type

func (CustomErrorRuleArray) ToCustomErrorRuleArrayOutput

func (i CustomErrorRuleArray) ToCustomErrorRuleArrayOutput() CustomErrorRuleArrayOutput

func (CustomErrorRuleArray) ToCustomErrorRuleArrayOutputWithContext

func (i CustomErrorRuleArray) ToCustomErrorRuleArrayOutputWithContext(ctx context.Context) CustomErrorRuleArrayOutput

type CustomErrorRuleArrayInput

type CustomErrorRuleArrayInput interface {
	pulumi.Input

	ToCustomErrorRuleArrayOutput() CustomErrorRuleArrayOutput
	ToCustomErrorRuleArrayOutputWithContext(context.Context) CustomErrorRuleArrayOutput
}

CustomErrorRuleArrayInput is an input type that accepts CustomErrorRuleArray and CustomErrorRuleArrayOutput values. You can construct a concrete instance of `CustomErrorRuleArrayInput` via:

CustomErrorRuleArray{ CustomErrorRuleArgs{...} }

type CustomErrorRuleArrayOutput

type CustomErrorRuleArrayOutput struct{ *pulumi.OutputState }

func (CustomErrorRuleArrayOutput) ElementType

func (CustomErrorRuleArrayOutput) ElementType() reflect.Type

func (CustomErrorRuleArrayOutput) Index

func (CustomErrorRuleArrayOutput) ToCustomErrorRuleArrayOutput

func (o CustomErrorRuleArrayOutput) ToCustomErrorRuleArrayOutput() CustomErrorRuleArrayOutput

func (CustomErrorRuleArrayOutput) ToCustomErrorRuleArrayOutputWithContext

func (o CustomErrorRuleArrayOutput) ToCustomErrorRuleArrayOutputWithContext(ctx context.Context) CustomErrorRuleArrayOutput

type CustomErrorRuleInput

type CustomErrorRuleInput interface {
	pulumi.Input

	ToCustomErrorRuleOutput() CustomErrorRuleOutput
	ToCustomErrorRuleOutputWithContext(context.Context) CustomErrorRuleOutput
}

CustomErrorRuleInput is an input type that accepts CustomErrorRuleArgs and CustomErrorRuleOutput values. You can construct a concrete instance of `CustomErrorRuleInput` via:

CustomErrorRuleArgs{...}

type CustomErrorRuleOutput

type CustomErrorRuleOutput struct{ *pulumi.OutputState }

A custom error rule.

func (CustomErrorRuleOutput) ElementType

func (CustomErrorRuleOutput) ElementType() reflect.Type

func (CustomErrorRuleOutput) IsErrorType

func (o CustomErrorRuleOutput) IsErrorType() pulumi.BoolPtrOutput

Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload.

func (CustomErrorRuleOutput) Selector

Selects messages to which this rule applies. Refer to selector for syntax details.

func (CustomErrorRuleOutput) ToCustomErrorRuleOutput

func (o CustomErrorRuleOutput) ToCustomErrorRuleOutput() CustomErrorRuleOutput

func (CustomErrorRuleOutput) ToCustomErrorRuleOutputWithContext

func (o CustomErrorRuleOutput) ToCustomErrorRuleOutputWithContext(ctx context.Context) CustomErrorRuleOutput

type CustomErrorRuleResponse

type CustomErrorRuleResponse struct {
	// Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload.
	IsErrorType bool `pulumi:"isErrorType"`
	// Selects messages to which this rule applies. Refer to selector for syntax details.
	Selector string `pulumi:"selector"`
}

A custom error rule.

type CustomErrorRuleResponseArrayOutput

type CustomErrorRuleResponseArrayOutput struct{ *pulumi.OutputState }

func (CustomErrorRuleResponseArrayOutput) ElementType

func (CustomErrorRuleResponseArrayOutput) Index

func (CustomErrorRuleResponseArrayOutput) ToCustomErrorRuleResponseArrayOutput

func (o CustomErrorRuleResponseArrayOutput) ToCustomErrorRuleResponseArrayOutput() CustomErrorRuleResponseArrayOutput

func (CustomErrorRuleResponseArrayOutput) ToCustomErrorRuleResponseArrayOutputWithContext

func (o CustomErrorRuleResponseArrayOutput) ToCustomErrorRuleResponseArrayOutputWithContext(ctx context.Context) CustomErrorRuleResponseArrayOutput

type CustomErrorRuleResponseOutput

type CustomErrorRuleResponseOutput struct{ *pulumi.OutputState }

A custom error rule.

func (CustomErrorRuleResponseOutput) ElementType

func (CustomErrorRuleResponseOutput) IsErrorType

Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload.

func (CustomErrorRuleResponseOutput) Selector

Selects messages to which this rule applies. Refer to selector for syntax details.

func (CustomErrorRuleResponseOutput) ToCustomErrorRuleResponseOutput

func (o CustomErrorRuleResponseOutput) ToCustomErrorRuleResponseOutput() CustomErrorRuleResponseOutput

func (CustomErrorRuleResponseOutput) ToCustomErrorRuleResponseOutputWithContext

func (o CustomErrorRuleResponseOutput) ToCustomErrorRuleResponseOutputWithContext(ctx context.Context) CustomErrorRuleResponseOutput

type CustomHttpPattern

type CustomHttpPattern struct {
	// The name of this custom HTTP verb.
	Kind *string `pulumi:"kind"`
	// The path matched by this custom verb.
	Path *string `pulumi:"path"`
}

A custom pattern is used for defining custom HTTP verb.

type CustomHttpPatternArgs

type CustomHttpPatternArgs struct {
	// The name of this custom HTTP verb.
	Kind pulumi.StringPtrInput `pulumi:"kind"`
	// The path matched by this custom verb.
	Path pulumi.StringPtrInput `pulumi:"path"`
}

A custom pattern is used for defining custom HTTP verb.

func (CustomHttpPatternArgs) ElementType

func (CustomHttpPatternArgs) ElementType() reflect.Type

func (CustomHttpPatternArgs) ToCustomHttpPatternOutput

func (i CustomHttpPatternArgs) ToCustomHttpPatternOutput() CustomHttpPatternOutput

func (CustomHttpPatternArgs) ToCustomHttpPatternOutputWithContext

func (i CustomHttpPatternArgs) ToCustomHttpPatternOutputWithContext(ctx context.Context) CustomHttpPatternOutput

func (CustomHttpPatternArgs) ToCustomHttpPatternPtrOutput

func (i CustomHttpPatternArgs) ToCustomHttpPatternPtrOutput() CustomHttpPatternPtrOutput

func (CustomHttpPatternArgs) ToCustomHttpPatternPtrOutputWithContext

func (i CustomHttpPatternArgs) ToCustomHttpPatternPtrOutputWithContext(ctx context.Context) CustomHttpPatternPtrOutput

type CustomHttpPatternInput

type CustomHttpPatternInput interface {
	pulumi.Input

	ToCustomHttpPatternOutput() CustomHttpPatternOutput
	ToCustomHttpPatternOutputWithContext(context.Context) CustomHttpPatternOutput
}

CustomHttpPatternInput is an input type that accepts CustomHttpPatternArgs and CustomHttpPatternOutput values. You can construct a concrete instance of `CustomHttpPatternInput` via:

CustomHttpPatternArgs{...}

type CustomHttpPatternOutput

type CustomHttpPatternOutput struct{ *pulumi.OutputState }

A custom pattern is used for defining custom HTTP verb.

func (CustomHttpPatternOutput) ElementType

func (CustomHttpPatternOutput) ElementType() reflect.Type

func (CustomHttpPatternOutput) Kind

The name of this custom HTTP verb.

func (CustomHttpPatternOutput) Path

The path matched by this custom verb.

func (CustomHttpPatternOutput) ToCustomHttpPatternOutput

func (o CustomHttpPatternOutput) ToCustomHttpPatternOutput() CustomHttpPatternOutput

func (CustomHttpPatternOutput) ToCustomHttpPatternOutputWithContext

func (o CustomHttpPatternOutput) ToCustomHttpPatternOutputWithContext(ctx context.Context) CustomHttpPatternOutput

func (CustomHttpPatternOutput) ToCustomHttpPatternPtrOutput

func (o CustomHttpPatternOutput) ToCustomHttpPatternPtrOutput() CustomHttpPatternPtrOutput

func (CustomHttpPatternOutput) ToCustomHttpPatternPtrOutputWithContext

func (o CustomHttpPatternOutput) ToCustomHttpPatternPtrOutputWithContext(ctx context.Context) CustomHttpPatternPtrOutput

type CustomHttpPatternPtrInput

type CustomHttpPatternPtrInput interface {
	pulumi.Input

	ToCustomHttpPatternPtrOutput() CustomHttpPatternPtrOutput
	ToCustomHttpPatternPtrOutputWithContext(context.Context) CustomHttpPatternPtrOutput
}

CustomHttpPatternPtrInput is an input type that accepts CustomHttpPatternArgs, CustomHttpPatternPtr and CustomHttpPatternPtrOutput values. You can construct a concrete instance of `CustomHttpPatternPtrInput` via:

        CustomHttpPatternArgs{...}

or:

        nil

type CustomHttpPatternPtrOutput

type CustomHttpPatternPtrOutput struct{ *pulumi.OutputState }

func (CustomHttpPatternPtrOutput) Elem

func (CustomHttpPatternPtrOutput) ElementType

func (CustomHttpPatternPtrOutput) ElementType() reflect.Type

func (CustomHttpPatternPtrOutput) Kind

The name of this custom HTTP verb.

func (CustomHttpPatternPtrOutput) Path

The path matched by this custom verb.

func (CustomHttpPatternPtrOutput) ToCustomHttpPatternPtrOutput

func (o CustomHttpPatternPtrOutput) ToCustomHttpPatternPtrOutput() CustomHttpPatternPtrOutput

func (CustomHttpPatternPtrOutput) ToCustomHttpPatternPtrOutputWithContext

func (o CustomHttpPatternPtrOutput) ToCustomHttpPatternPtrOutputWithContext(ctx context.Context) CustomHttpPatternPtrOutput

type CustomHttpPatternResponse

type CustomHttpPatternResponse struct {
	// The name of this custom HTTP verb.
	Kind string `pulumi:"kind"`
	// The path matched by this custom verb.
	Path string `pulumi:"path"`
}

A custom pattern is used for defining custom HTTP verb.

type CustomHttpPatternResponseOutput

type CustomHttpPatternResponseOutput struct{ *pulumi.OutputState }

A custom pattern is used for defining custom HTTP verb.

func (CustomHttpPatternResponseOutput) ElementType

func (CustomHttpPatternResponseOutput) Kind

The name of this custom HTTP verb.

func (CustomHttpPatternResponseOutput) Path

The path matched by this custom verb.

func (CustomHttpPatternResponseOutput) ToCustomHttpPatternResponseOutput

func (o CustomHttpPatternResponseOutput) ToCustomHttpPatternResponseOutput() CustomHttpPatternResponseOutput

func (CustomHttpPatternResponseOutput) ToCustomHttpPatternResponseOutputWithContext

func (o CustomHttpPatternResponseOutput) ToCustomHttpPatternResponseOutputWithContext(ctx context.Context) CustomHttpPatternResponseOutput

type DeleteServiceStrategy

type DeleteServiceStrategy struct {
}

Strategy used to delete a service. This strategy is a placeholder only used by the system generated rollout to delete a service.

type DeleteServiceStrategyArgs

type DeleteServiceStrategyArgs struct {
}

Strategy used to delete a service. This strategy is a placeholder only used by the system generated rollout to delete a service.

func (DeleteServiceStrategyArgs) ElementType

func (DeleteServiceStrategyArgs) ElementType() reflect.Type

func (DeleteServiceStrategyArgs) ToDeleteServiceStrategyOutput

func (i DeleteServiceStrategyArgs) ToDeleteServiceStrategyOutput() DeleteServiceStrategyOutput

func (DeleteServiceStrategyArgs) ToDeleteServiceStrategyOutputWithContext

func (i DeleteServiceStrategyArgs) ToDeleteServiceStrategyOutputWithContext(ctx context.Context) DeleteServiceStrategyOutput

func (DeleteServiceStrategyArgs) ToDeleteServiceStrategyPtrOutput

func (i DeleteServiceStrategyArgs) ToDeleteServiceStrategyPtrOutput() DeleteServiceStrategyPtrOutput

func (DeleteServiceStrategyArgs) ToDeleteServiceStrategyPtrOutputWithContext

func (i DeleteServiceStrategyArgs) ToDeleteServiceStrategyPtrOutputWithContext(ctx context.Context) DeleteServiceStrategyPtrOutput

type DeleteServiceStrategyInput

type DeleteServiceStrategyInput interface {
	pulumi.Input

	ToDeleteServiceStrategyOutput() DeleteServiceStrategyOutput
	ToDeleteServiceStrategyOutputWithContext(context.Context) DeleteServiceStrategyOutput
}

DeleteServiceStrategyInput is an input type that accepts DeleteServiceStrategyArgs and DeleteServiceStrategyOutput values. You can construct a concrete instance of `DeleteServiceStrategyInput` via:

DeleteServiceStrategyArgs{...}

type DeleteServiceStrategyOutput

type DeleteServiceStrategyOutput struct{ *pulumi.OutputState }

Strategy used to delete a service. This strategy is a placeholder only used by the system generated rollout to delete a service.

func (DeleteServiceStrategyOutput) ElementType

func (DeleteServiceStrategyOutput) ToDeleteServiceStrategyOutput

func (o DeleteServiceStrategyOutput) ToDeleteServiceStrategyOutput() DeleteServiceStrategyOutput

func (DeleteServiceStrategyOutput) ToDeleteServiceStrategyOutputWithContext

func (o DeleteServiceStrategyOutput) ToDeleteServiceStrategyOutputWithContext(ctx context.Context) DeleteServiceStrategyOutput

func (DeleteServiceStrategyOutput) ToDeleteServiceStrategyPtrOutput

func (o DeleteServiceStrategyOutput) ToDeleteServiceStrategyPtrOutput() DeleteServiceStrategyPtrOutput

func (DeleteServiceStrategyOutput) ToDeleteServiceStrategyPtrOutputWithContext

func (o DeleteServiceStrategyOutput) ToDeleteServiceStrategyPtrOutputWithContext(ctx context.Context) DeleteServiceStrategyPtrOutput

type DeleteServiceStrategyPtrInput

type DeleteServiceStrategyPtrInput interface {
	pulumi.Input

	ToDeleteServiceStrategyPtrOutput() DeleteServiceStrategyPtrOutput
	ToDeleteServiceStrategyPtrOutputWithContext(context.Context) DeleteServiceStrategyPtrOutput
}

DeleteServiceStrategyPtrInput is an input type that accepts DeleteServiceStrategyArgs, DeleteServiceStrategyPtr and DeleteServiceStrategyPtrOutput values. You can construct a concrete instance of `DeleteServiceStrategyPtrInput` via:

        DeleteServiceStrategyArgs{...}

or:

        nil

type DeleteServiceStrategyPtrOutput

type DeleteServiceStrategyPtrOutput struct{ *pulumi.OutputState }

func (DeleteServiceStrategyPtrOutput) Elem

func (DeleteServiceStrategyPtrOutput) ElementType

func (DeleteServiceStrategyPtrOutput) ToDeleteServiceStrategyPtrOutput

func (o DeleteServiceStrategyPtrOutput) ToDeleteServiceStrategyPtrOutput() DeleteServiceStrategyPtrOutput

func (DeleteServiceStrategyPtrOutput) ToDeleteServiceStrategyPtrOutputWithContext

func (o DeleteServiceStrategyPtrOutput) ToDeleteServiceStrategyPtrOutputWithContext(ctx context.Context) DeleteServiceStrategyPtrOutput

type DeleteServiceStrategyResponse

type DeleteServiceStrategyResponse struct {
}

Strategy used to delete a service. This strategy is a placeholder only used by the system generated rollout to delete a service.

type DeleteServiceStrategyResponseOutput

type DeleteServiceStrategyResponseOutput struct{ *pulumi.OutputState }

Strategy used to delete a service. This strategy is a placeholder only used by the system generated rollout to delete a service.

func (DeleteServiceStrategyResponseOutput) ElementType

func (DeleteServiceStrategyResponseOutput) ToDeleteServiceStrategyResponseOutput

func (o DeleteServiceStrategyResponseOutput) ToDeleteServiceStrategyResponseOutput() DeleteServiceStrategyResponseOutput

func (DeleteServiceStrategyResponseOutput) ToDeleteServiceStrategyResponseOutputWithContext

func (o DeleteServiceStrategyResponseOutput) ToDeleteServiceStrategyResponseOutputWithContext(ctx context.Context) DeleteServiceStrategyResponseOutput

type Documentation

type Documentation struct {
	// The URL to the root of documentation.
	DocumentationRootUrl *string `pulumi:"documentationRootUrl"`
	// Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both `overview` field and `pages` field.
	Overview *string `pulumi:"overview"`
	// The top level pages for the documentation set.
	Pages []Page `pulumi:"pages"`
	// A list of documentation rules that apply to individual API elements. **NOTE:** All service configuration rules follow "last one wins" order.
	Rules []DocumentationRule `pulumi:"rules"`
	// Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries
	SectionOverrides []Page `pulumi:"sectionOverrides"`
	// Specifies the service root url if the default one (the service name from the yaml file) is not suitable. This can be seen in any fully specified service urls as well as sections that show a base that other urls are relative to.
	ServiceRootUrl *string `pulumi:"serviceRootUrl"`
	// A short description of what the service does. The summary must be plain text. It becomes the overview of the service displayed in Google Cloud Console. NOTE: This field is equivalent to the standard field `description`.
	Summary *string `pulumi:"summary"`
}

`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.

type DocumentationArgs

type DocumentationArgs struct {
	// The URL to the root of documentation.
	DocumentationRootUrl pulumi.StringPtrInput `pulumi:"documentationRootUrl"`
	// Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both `overview` field and `pages` field.
	Overview pulumi.StringPtrInput `pulumi:"overview"`
	// The top level pages for the documentation set.
	Pages PageArrayInput `pulumi:"pages"`
	// A list of documentation rules that apply to individual API elements. **NOTE:** All service configuration rules follow "last one wins" order.
	Rules DocumentationRuleArrayInput `pulumi:"rules"`
	// Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries
	SectionOverrides PageArrayInput `pulumi:"sectionOverrides"`
	// Specifies the service root url if the default one (the service name from the yaml file) is not suitable. This can be seen in any fully specified service urls as well as sections that show a base that other urls are relative to.
	ServiceRootUrl pulumi.StringPtrInput `pulumi:"serviceRootUrl"`
	// A short description of what the service does. The summary must be plain text. It becomes the overview of the service displayed in Google Cloud Console. NOTE: This field is equivalent to the standard field `description`.
	Summary pulumi.StringPtrInput `pulumi:"summary"`
}

`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.

func (DocumentationArgs) ElementType

func (DocumentationArgs) ElementType() reflect.Type

func (DocumentationArgs) ToDocumentationOutput

func (i DocumentationArgs) ToDocumentationOutput() DocumentationOutput

func (DocumentationArgs) ToDocumentationOutputWithContext

func (i DocumentationArgs) ToDocumentationOutputWithContext(ctx context.Context) DocumentationOutput

func (DocumentationArgs) ToDocumentationPtrOutput

func (i DocumentationArgs) ToDocumentationPtrOutput() DocumentationPtrOutput

func (DocumentationArgs) ToDocumentationPtrOutputWithContext

func (i DocumentationArgs) ToDocumentationPtrOutputWithContext(ctx context.Context) DocumentationPtrOutput

type DocumentationInput

type DocumentationInput interface {
	pulumi.Input

	ToDocumentationOutput() DocumentationOutput
	ToDocumentationOutputWithContext(context.Context) DocumentationOutput
}

DocumentationInput is an input type that accepts DocumentationArgs and DocumentationOutput values. You can construct a concrete instance of `DocumentationInput` via:

DocumentationArgs{...}

type DocumentationOutput

type DocumentationOutput struct{ *pulumi.OutputState }

`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.

func (DocumentationOutput) DocumentationRootUrl

func (o DocumentationOutput) DocumentationRootUrl() pulumi.StringPtrOutput

The URL to the root of documentation.

func (DocumentationOutput) ElementType

func (DocumentationOutput) ElementType() reflect.Type

func (DocumentationOutput) Overview

Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both `overview` field and `pages` field.

func (DocumentationOutput) Pages

The top level pages for the documentation set.

func (DocumentationOutput) Rules

A list of documentation rules that apply to individual API elements. **NOTE:** All service configuration rules follow "last one wins" order.

func (DocumentationOutput) SectionOverrides added in v0.32.0

func (o DocumentationOutput) SectionOverrides() PageArrayOutput

Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries

func (DocumentationOutput) ServiceRootUrl

func (o DocumentationOutput) ServiceRootUrl() pulumi.StringPtrOutput

Specifies the service root url if the default one (the service name from the yaml file) is not suitable. This can be seen in any fully specified service urls as well as sections that show a base that other urls are relative to.

func (DocumentationOutput) Summary

A short description of what the service does. The summary must be plain text. It becomes the overview of the service displayed in Google Cloud Console. NOTE: This field is equivalent to the standard field `description`.

func (DocumentationOutput) ToDocumentationOutput

func (o DocumentationOutput) ToDocumentationOutput() DocumentationOutput

func (DocumentationOutput) ToDocumentationOutputWithContext

func (o DocumentationOutput) ToDocumentationOutputWithContext(ctx context.Context) DocumentationOutput

func (DocumentationOutput) ToDocumentationPtrOutput

func (o DocumentationOutput) ToDocumentationPtrOutput() DocumentationPtrOutput

func (DocumentationOutput) ToDocumentationPtrOutputWithContext

func (o DocumentationOutput) ToDocumentationPtrOutputWithContext(ctx context.Context) DocumentationPtrOutput

type DocumentationPtrInput

type DocumentationPtrInput interface {
	pulumi.Input

	ToDocumentationPtrOutput() DocumentationPtrOutput
	ToDocumentationPtrOutputWithContext(context.Context) DocumentationPtrOutput
}

DocumentationPtrInput is an input type that accepts DocumentationArgs, DocumentationPtr and DocumentationPtrOutput values. You can construct a concrete instance of `DocumentationPtrInput` via:

        DocumentationArgs{...}

or:

        nil

type DocumentationPtrOutput

type DocumentationPtrOutput struct{ *pulumi.OutputState }

func (DocumentationPtrOutput) DocumentationRootUrl

func (o DocumentationPtrOutput) DocumentationRootUrl() pulumi.StringPtrOutput

The URL to the root of documentation.

func (DocumentationPtrOutput) Elem

func (DocumentationPtrOutput) ElementType

func (DocumentationPtrOutput) ElementType() reflect.Type

func (DocumentationPtrOutput) Overview

Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both `overview` field and `pages` field.

func (DocumentationPtrOutput) Pages

The top level pages for the documentation set.

func (DocumentationPtrOutput) Rules

A list of documentation rules that apply to individual API elements. **NOTE:** All service configuration rules follow "last one wins" order.

func (DocumentationPtrOutput) SectionOverrides added in v0.32.0

func (o DocumentationPtrOutput) SectionOverrides() PageArrayOutput

Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries

func (DocumentationPtrOutput) ServiceRootUrl

func (o DocumentationPtrOutput) ServiceRootUrl() pulumi.StringPtrOutput

Specifies the service root url if the default one (the service name from the yaml file) is not suitable. This can be seen in any fully specified service urls as well as sections that show a base that other urls are relative to.

func (DocumentationPtrOutput) Summary

A short description of what the service does. The summary must be plain text. It becomes the overview of the service displayed in Google Cloud Console. NOTE: This field is equivalent to the standard field `description`.

func (DocumentationPtrOutput) ToDocumentationPtrOutput

func (o DocumentationPtrOutput) ToDocumentationPtrOutput() DocumentationPtrOutput

func (DocumentationPtrOutput) ToDocumentationPtrOutputWithContext

func (o DocumentationPtrOutput) ToDocumentationPtrOutputWithContext(ctx context.Context) DocumentationPtrOutput

type DocumentationResponse

type DocumentationResponse struct {
	// The URL to the root of documentation.
	DocumentationRootUrl string `pulumi:"documentationRootUrl"`
	// Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both `overview` field and `pages` field.
	Overview string `pulumi:"overview"`
	// The top level pages for the documentation set.
	Pages []PageResponse `pulumi:"pages"`
	// A list of documentation rules that apply to individual API elements. **NOTE:** All service configuration rules follow "last one wins" order.
	Rules []DocumentationRuleResponse `pulumi:"rules"`
	// Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries
	SectionOverrides []PageResponse `pulumi:"sectionOverrides"`
	// Specifies the service root url if the default one (the service name from the yaml file) is not suitable. This can be seen in any fully specified service urls as well as sections that show a base that other urls are relative to.
	ServiceRootUrl string `pulumi:"serviceRootUrl"`
	// A short description of what the service does. The summary must be plain text. It becomes the overview of the service displayed in Google Cloud Console. NOTE: This field is equivalent to the standard field `description`.
	Summary string `pulumi:"summary"`
}

`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.

type DocumentationResponseOutput

type DocumentationResponseOutput struct{ *pulumi.OutputState }

`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.

func (DocumentationResponseOutput) DocumentationRootUrl

func (o DocumentationResponseOutput) DocumentationRootUrl() pulumi.StringOutput

The URL to the root of documentation.

func (DocumentationResponseOutput) ElementType

func (DocumentationResponseOutput) Overview

Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both `overview` field and `pages` field.

func (DocumentationResponseOutput) Pages

The top level pages for the documentation set.

func (DocumentationResponseOutput) Rules

A list of documentation rules that apply to individual API elements. **NOTE:** All service configuration rules follow "last one wins" order.

func (DocumentationResponseOutput) SectionOverrides added in v0.32.0

Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries

func (DocumentationResponseOutput) ServiceRootUrl

func (o DocumentationResponseOutput) ServiceRootUrl() pulumi.StringOutput

Specifies the service root url if the default one (the service name from the yaml file) is not suitable. This can be seen in any fully specified service urls as well as sections that show a base that other urls are relative to.

func (DocumentationResponseOutput) Summary

A short description of what the service does. The summary must be plain text. It becomes the overview of the service displayed in Google Cloud Console. NOTE: This field is equivalent to the standard field `description`.

func (DocumentationResponseOutput) ToDocumentationResponseOutput

func (o DocumentationResponseOutput) ToDocumentationResponseOutput() DocumentationResponseOutput

func (DocumentationResponseOutput) ToDocumentationResponseOutputWithContext

func (o DocumentationResponseOutput) ToDocumentationResponseOutputWithContext(ctx context.Context) DocumentationResponseOutput

type DocumentationRule

type DocumentationRule struct {
	// Deprecation description of the selected element(s). It can be provided if an element is marked as `deprecated`.
	DeprecationDescription *string `pulumi:"deprecationDescription"`
	// Description of the selected proto element (e.g. a message, a method, a 'service' definition, or a field). Defaults to leading & trailing comments taken from the proto source definition of the proto element.
	Description *string `pulumi:"description"`
	// String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen.
	DisableReplacementWords *string `pulumi:"disableReplacementWords"`
	// The selector is a comma-separated list of patterns for any element such as a method, a field, an enum value. Each pattern is a qualified name of the element which may end in "*", indicating a wildcard. Wildcards are only allowed at the end and for a whole component of the qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". A wildcard will match one or more components. To specify a default for all applicable elements, the whole pattern "*" is used.
	Selector *string `pulumi:"selector"`
}

A documentation rule provides information about individual API elements.

type DocumentationRuleArgs

type DocumentationRuleArgs struct {
	// Deprecation description of the selected element(s). It can be provided if an element is marked as `deprecated`.
	DeprecationDescription pulumi.StringPtrInput `pulumi:"deprecationDescription"`
	// Description of the selected proto element (e.g. a message, a method, a 'service' definition, or a field). Defaults to leading & trailing comments taken from the proto source definition of the proto element.
	Description pulumi.StringPtrInput `pulumi:"description"`
	// String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen.
	DisableReplacementWords pulumi.StringPtrInput `pulumi:"disableReplacementWords"`
	// The selector is a comma-separated list of patterns for any element such as a method, a field, an enum value. Each pattern is a qualified name of the element which may end in "*", indicating a wildcard. Wildcards are only allowed at the end and for a whole component of the qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". A wildcard will match one or more components. To specify a default for all applicable elements, the whole pattern "*" is used.
	Selector pulumi.StringPtrInput `pulumi:"selector"`
}

A documentation rule provides information about individual API elements.

func (DocumentationRuleArgs) ElementType

func (DocumentationRuleArgs) ElementType() reflect.Type

func (DocumentationRuleArgs) ToDocumentationRuleOutput

func (i DocumentationRuleArgs) ToDocumentationRuleOutput() DocumentationRuleOutput

func (DocumentationRuleArgs) ToDocumentationRuleOutputWithContext

func (i DocumentationRuleArgs) ToDocumentationRuleOutputWithContext(ctx context.Context) DocumentationRuleOutput

type DocumentationRuleArray

type DocumentationRuleArray []DocumentationRuleInput

func (DocumentationRuleArray) ElementType

func (DocumentationRuleArray) ElementType() reflect.Type

func (DocumentationRuleArray) ToDocumentationRuleArrayOutput

func (i DocumentationRuleArray) ToDocumentationRuleArrayOutput() DocumentationRuleArrayOutput

func (DocumentationRuleArray) ToDocumentationRuleArrayOutputWithContext

func (i DocumentationRuleArray) ToDocumentationRuleArrayOutputWithContext(ctx context.Context) DocumentationRuleArrayOutput

type DocumentationRuleArrayInput

type DocumentationRuleArrayInput interface {
	pulumi.Input

	ToDocumentationRuleArrayOutput() DocumentationRuleArrayOutput
	ToDocumentationRuleArrayOutputWithContext(context.Context) DocumentationRuleArrayOutput
}

DocumentationRuleArrayInput is an input type that accepts DocumentationRuleArray and DocumentationRuleArrayOutput values. You can construct a concrete instance of `DocumentationRuleArrayInput` via:

DocumentationRuleArray{ DocumentationRuleArgs{...} }

type DocumentationRuleArrayOutput

type DocumentationRuleArrayOutput struct{ *pulumi.OutputState }

func (DocumentationRuleArrayOutput) ElementType

func (DocumentationRuleArrayOutput) Index

func (DocumentationRuleArrayOutput) ToDocumentationRuleArrayOutput

func (o DocumentationRuleArrayOutput) ToDocumentationRuleArrayOutput() DocumentationRuleArrayOutput

func (DocumentationRuleArrayOutput) ToDocumentationRuleArrayOutputWithContext

func (o DocumentationRuleArrayOutput) ToDocumentationRuleArrayOutputWithContext(ctx context.Context) DocumentationRuleArrayOutput

type DocumentationRuleInput

type DocumentationRuleInput interface {
	pulumi.Input

	ToDocumentationRuleOutput() DocumentationRuleOutput
	ToDocumentationRuleOutputWithContext(context.Context) DocumentationRuleOutput
}

DocumentationRuleInput is an input type that accepts DocumentationRuleArgs and DocumentationRuleOutput values. You can construct a concrete instance of `DocumentationRuleInput` via:

DocumentationRuleArgs{...}

type DocumentationRuleOutput

type DocumentationRuleOutput struct{ *pulumi.OutputState }

A documentation rule provides information about individual API elements.

func (DocumentationRuleOutput) DeprecationDescription

func (o DocumentationRuleOutput) DeprecationDescription() pulumi.StringPtrOutput

Deprecation description of the selected element(s). It can be provided if an element is marked as `deprecated`.

func (DocumentationRuleOutput) Description

Description of the selected proto element (e.g. a message, a method, a 'service' definition, or a field). Defaults to leading & trailing comments taken from the proto source definition of the proto element.

func (DocumentationRuleOutput) DisableReplacementWords added in v0.31.1

func (o DocumentationRuleOutput) DisableReplacementWords() pulumi.StringPtrOutput

String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen.

func (DocumentationRuleOutput) ElementType

func (DocumentationRuleOutput) ElementType() reflect.Type

func (DocumentationRuleOutput) Selector

The selector is a comma-separated list of patterns for any element such as a method, a field, an enum value. Each pattern is a qualified name of the element which may end in "*", indicating a wildcard. Wildcards are only allowed at the end and for a whole component of the qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". A wildcard will match one or more components. To specify a default for all applicable elements, the whole pattern "*" is used.

func (DocumentationRuleOutput) ToDocumentationRuleOutput

func (o DocumentationRuleOutput) ToDocumentationRuleOutput() DocumentationRuleOutput

func (DocumentationRuleOutput) ToDocumentationRuleOutputWithContext

func (o DocumentationRuleOutput) ToDocumentationRuleOutputWithContext(ctx context.Context) DocumentationRuleOutput

type DocumentationRuleResponse

type DocumentationRuleResponse struct {
	// Deprecation description of the selected element(s). It can be provided if an element is marked as `deprecated`.
	DeprecationDescription string `pulumi:"deprecationDescription"`
	// Description of the selected proto element (e.g. a message, a method, a 'service' definition, or a field). Defaults to leading & trailing comments taken from the proto source definition of the proto element.
	Description string `pulumi:"description"`
	// String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen.
	DisableReplacementWords string `pulumi:"disableReplacementWords"`
	// The selector is a comma-separated list of patterns for any element such as a method, a field, an enum value. Each pattern is a qualified name of the element which may end in "*", indicating a wildcard. Wildcards are only allowed at the end and for a whole component of the qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". A wildcard will match one or more components. To specify a default for all applicable elements, the whole pattern "*" is used.
	Selector string `pulumi:"selector"`
}

A documentation rule provides information about individual API elements.

type DocumentationRuleResponseArrayOutput

type DocumentationRuleResponseArrayOutput struct{ *pulumi.OutputState }

func (DocumentationRuleResponseArrayOutput) ElementType

func (DocumentationRuleResponseArrayOutput) Index

func (DocumentationRuleResponseArrayOutput) ToDocumentationRuleResponseArrayOutput

func (o DocumentationRuleResponseArrayOutput) ToDocumentationRuleResponseArrayOutput() DocumentationRuleResponseArrayOutput

func (DocumentationRuleResponseArrayOutput) ToDocumentationRuleResponseArrayOutputWithContext

func (o DocumentationRuleResponseArrayOutput) ToDocumentationRuleResponseArrayOutputWithContext(ctx context.Context) DocumentationRuleResponseArrayOutput

type DocumentationRuleResponseOutput

type DocumentationRuleResponseOutput struct{ *pulumi.OutputState }

A documentation rule provides information about individual API elements.

func (DocumentationRuleResponseOutput) DeprecationDescription

func (o DocumentationRuleResponseOutput) DeprecationDescription() pulumi.StringOutput

Deprecation description of the selected element(s). It can be provided if an element is marked as `deprecated`.

func (DocumentationRuleResponseOutput) Description

Description of the selected proto element (e.g. a message, a method, a 'service' definition, or a field). Defaults to leading & trailing comments taken from the proto source definition of the proto element.

func (DocumentationRuleResponseOutput) DisableReplacementWords added in v0.31.1

func (o DocumentationRuleResponseOutput) DisableReplacementWords() pulumi.StringOutput

String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen.

func (DocumentationRuleResponseOutput) ElementType

func (DocumentationRuleResponseOutput) Selector

The selector is a comma-separated list of patterns for any element such as a method, a field, an enum value. Each pattern is a qualified name of the element which may end in "*", indicating a wildcard. Wildcards are only allowed at the end and for a whole component of the qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". A wildcard will match one or more components. To specify a default for all applicable elements, the whole pattern "*" is used.

func (DocumentationRuleResponseOutput) ToDocumentationRuleResponseOutput

func (o DocumentationRuleResponseOutput) ToDocumentationRuleResponseOutput() DocumentationRuleResponseOutput

func (DocumentationRuleResponseOutput) ToDocumentationRuleResponseOutputWithContext

func (o DocumentationRuleResponseOutput) ToDocumentationRuleResponseOutputWithContext(ctx context.Context) DocumentationRuleResponseOutput

type DotnetSettings added in v0.28.0

type DotnetSettings struct {
	// Some settings.
	Common *CommonLanguageSettings `pulumi:"common"`
	// Namespaces which must be aliased in snippets due to a known (but non-generator-predictable) naming collision
	ForcedNamespaceAliases []string `pulumi:"forcedNamespaceAliases"`
	// Method signatures (in the form "service.method(signature)") which are provided separately, so shouldn't be generated. Snippets *calling* these methods are still generated, however.
	HandwrittenSignatures []string `pulumi:"handwrittenSignatures"`
	// List of full resource types to ignore during generation. This is typically used for API-specific Location resources, which should be handled by the generator as if they were actually the common Location resources. Example entry: "documentai.googleapis.com/Location"
	IgnoredResources []string `pulumi:"ignoredResources"`
	// Map from full resource types to the effective short name for the resource. This is used when otherwise resource named from different services would cause naming collisions. Example entry: "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"
	RenamedResources map[string]string `pulumi:"renamedResources"`
	// Map from original service names to renamed versions. This is used when the default generated types would cause a naming conflict. (Neither name is fully-qualified.) Example: Subscriber to SubscriberServiceApi.
	RenamedServices map[string]string `pulumi:"renamedServices"`
}

Settings for Dotnet client libraries.

type DotnetSettingsArgs added in v0.28.0

type DotnetSettingsArgs struct {
	// Some settings.
	Common CommonLanguageSettingsPtrInput `pulumi:"common"`
	// Namespaces which must be aliased in snippets due to a known (but non-generator-predictable) naming collision
	ForcedNamespaceAliases pulumi.StringArrayInput `pulumi:"forcedNamespaceAliases"`
	// Method signatures (in the form "service.method(signature)") which are provided separately, so shouldn't be generated. Snippets *calling* these methods are still generated, however.
	HandwrittenSignatures pulumi.StringArrayInput `pulumi:"handwrittenSignatures"`
	// List of full resource types to ignore during generation. This is typically used for API-specific Location resources, which should be handled by the generator as if they were actually the common Location resources. Example entry: "documentai.googleapis.com/Location"
	IgnoredResources pulumi.StringArrayInput `pulumi:"ignoredResources"`
	// Map from full resource types to the effective short name for the resource. This is used when otherwise resource named from different services would cause naming collisions. Example entry: "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"
	RenamedResources pulumi.StringMapInput `pulumi:"renamedResources"`
	// Map from original service names to renamed versions. This is used when the default generated types would cause a naming conflict. (Neither name is fully-qualified.) Example: Subscriber to SubscriberServiceApi.
	RenamedServices pulumi.StringMapInput `pulumi:"renamedServices"`
}

Settings for Dotnet client libraries.

func (DotnetSettingsArgs) ElementType added in v0.28.0

func (DotnetSettingsArgs) ElementType() reflect.Type

func (DotnetSettingsArgs) ToDotnetSettingsOutput added in v0.28.0

func (i DotnetSettingsArgs) ToDotnetSettingsOutput() DotnetSettingsOutput

func (DotnetSettingsArgs) ToDotnetSettingsOutputWithContext added in v0.28.0

func (i DotnetSettingsArgs) ToDotnetSettingsOutputWithContext(ctx context.Context) DotnetSettingsOutput

func (DotnetSettingsArgs) ToDotnetSettingsPtrOutput added in v0.28.0

func (i DotnetSettingsArgs) ToDotnetSettingsPtrOutput() DotnetSettingsPtrOutput

func (DotnetSettingsArgs) ToDotnetSettingsPtrOutputWithContext added in v0.28.0

func (i DotnetSettingsArgs) ToDotnetSettingsPtrOutputWithContext(ctx context.Context) DotnetSettingsPtrOutput

type DotnetSettingsInput added in v0.28.0

type DotnetSettingsInput interface {
	pulumi.Input

	ToDotnetSettingsOutput() DotnetSettingsOutput
	ToDotnetSettingsOutputWithContext(context.Context) DotnetSettingsOutput
}

DotnetSettingsInput is an input type that accepts DotnetSettingsArgs and DotnetSettingsOutput values. You can construct a concrete instance of `DotnetSettingsInput` via:

DotnetSettingsArgs{...}

type DotnetSettingsOutput added in v0.28.0

type DotnetSettingsOutput struct{ *pulumi.OutputState }

Settings for Dotnet client libraries.

func (DotnetSettingsOutput) Common added in v0.28.0

Some settings.

func (DotnetSettingsOutput) ElementType added in v0.28.0

func (DotnetSettingsOutput) ElementType() reflect.Type

func (DotnetSettingsOutput) ForcedNamespaceAliases added in v0.30.0

func (o DotnetSettingsOutput) ForcedNamespaceAliases() pulumi.StringArrayOutput

Namespaces which must be aliased in snippets due to a known (but non-generator-predictable) naming collision

func (DotnetSettingsOutput) HandwrittenSignatures added in v0.30.0

func (o DotnetSettingsOutput) HandwrittenSignatures() pulumi.StringArrayOutput

Method signatures (in the form "service.method(signature)") which are provided separately, so shouldn't be generated. Snippets *calling* these methods are still generated, however.

func (DotnetSettingsOutput) IgnoredResources added in v0.30.0

func (o DotnetSettingsOutput) IgnoredResources() pulumi.StringArrayOutput

List of full resource types to ignore during generation. This is typically used for API-specific Location resources, which should be handled by the generator as if they were actually the common Location resources. Example entry: "documentai.googleapis.com/Location"

func (DotnetSettingsOutput) RenamedResources added in v0.30.0

func (o DotnetSettingsOutput) RenamedResources() pulumi.StringMapOutput

Map from full resource types to the effective short name for the resource. This is used when otherwise resource named from different services would cause naming collisions. Example entry: "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"

func (DotnetSettingsOutput) RenamedServices added in v0.30.0

func (o DotnetSettingsOutput) RenamedServices() pulumi.StringMapOutput

Map from original service names to renamed versions. This is used when the default generated types would cause a naming conflict. (Neither name is fully-qualified.) Example: Subscriber to SubscriberServiceApi.

func (DotnetSettingsOutput) ToDotnetSettingsOutput added in v0.28.0

func (o DotnetSettingsOutput) ToDotnetSettingsOutput() DotnetSettingsOutput

func (DotnetSettingsOutput) ToDotnetSettingsOutputWithContext added in v0.28.0

func (o DotnetSettingsOutput) ToDotnetSettingsOutputWithContext(ctx context.Context) DotnetSettingsOutput

func (DotnetSettingsOutput) ToDotnetSettingsPtrOutput added in v0.28.0

func (o DotnetSettingsOutput) ToDotnetSettingsPtrOutput() DotnetSettingsPtrOutput

func (DotnetSettingsOutput) ToDotnetSettingsPtrOutputWithContext added in v0.28.0

func (o DotnetSettingsOutput) ToDotnetSettingsPtrOutputWithContext(ctx context.Context) DotnetSettingsPtrOutput

type DotnetSettingsPtrInput added in v0.28.0

type DotnetSettingsPtrInput interface {
	pulumi.Input

	ToDotnetSettingsPtrOutput() DotnetSettingsPtrOutput
	ToDotnetSettingsPtrOutputWithContext(context.Context) DotnetSettingsPtrOutput
}

DotnetSettingsPtrInput is an input type that accepts DotnetSettingsArgs, DotnetSettingsPtr and DotnetSettingsPtrOutput values. You can construct a concrete instance of `DotnetSettingsPtrInput` via:

        DotnetSettingsArgs{...}

or:

        nil

func DotnetSettingsPtr added in v0.28.0

func DotnetSettingsPtr(v *DotnetSettingsArgs) DotnetSettingsPtrInput

type DotnetSettingsPtrOutput added in v0.28.0

type DotnetSettingsPtrOutput struct{ *pulumi.OutputState }

func (DotnetSettingsPtrOutput) Common added in v0.28.0

Some settings.

func (DotnetSettingsPtrOutput) Elem added in v0.28.0

func (DotnetSettingsPtrOutput) ElementType added in v0.28.0

func (DotnetSettingsPtrOutput) ElementType() reflect.Type

func (DotnetSettingsPtrOutput) ForcedNamespaceAliases added in v0.30.0

func (o DotnetSettingsPtrOutput) ForcedNamespaceAliases() pulumi.StringArrayOutput

Namespaces which must be aliased in snippets due to a known (but non-generator-predictable) naming collision

func (DotnetSettingsPtrOutput) HandwrittenSignatures added in v0.30.0

func (o DotnetSettingsPtrOutput) HandwrittenSignatures() pulumi.StringArrayOutput

Method signatures (in the form "service.method(signature)") which are provided separately, so shouldn't be generated. Snippets *calling* these methods are still generated, however.

func (DotnetSettingsPtrOutput) IgnoredResources added in v0.30.0

func (o DotnetSettingsPtrOutput) IgnoredResources() pulumi.StringArrayOutput

List of full resource types to ignore during generation. This is typically used for API-specific Location resources, which should be handled by the generator as if they were actually the common Location resources. Example entry: "documentai.googleapis.com/Location"

func (DotnetSettingsPtrOutput) RenamedResources added in v0.30.0

func (o DotnetSettingsPtrOutput) RenamedResources() pulumi.StringMapOutput

Map from full resource types to the effective short name for the resource. This is used when otherwise resource named from different services would cause naming collisions. Example entry: "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"

func (DotnetSettingsPtrOutput) RenamedServices added in v0.30.0

func (o DotnetSettingsPtrOutput) RenamedServices() pulumi.StringMapOutput

Map from original service names to renamed versions. This is used when the default generated types would cause a naming conflict. (Neither name is fully-qualified.) Example: Subscriber to SubscriberServiceApi.

func (DotnetSettingsPtrOutput) ToDotnetSettingsPtrOutput added in v0.28.0

func (o DotnetSettingsPtrOutput) ToDotnetSettingsPtrOutput() DotnetSettingsPtrOutput

func (DotnetSettingsPtrOutput) ToDotnetSettingsPtrOutputWithContext added in v0.28.0

func (o DotnetSettingsPtrOutput) ToDotnetSettingsPtrOutputWithContext(ctx context.Context) DotnetSettingsPtrOutput

type DotnetSettingsResponse added in v0.28.0

type DotnetSettingsResponse struct {
	// Some settings.
	Common CommonLanguageSettingsResponse `pulumi:"common"`
	// Namespaces which must be aliased in snippets due to a known (but non-generator-predictable) naming collision
	ForcedNamespaceAliases []string `pulumi:"forcedNamespaceAliases"`
	// Method signatures (in the form "service.method(signature)") which are provided separately, so shouldn't be generated. Snippets *calling* these methods are still generated, however.
	HandwrittenSignatures []string `pulumi:"handwrittenSignatures"`
	// List of full resource types to ignore during generation. This is typically used for API-specific Location resources, which should be handled by the generator as if they were actually the common Location resources. Example entry: "documentai.googleapis.com/Location"
	IgnoredResources []string `pulumi:"ignoredResources"`
	// Map from full resource types to the effective short name for the resource. This is used when otherwise resource named from different services would cause naming collisions. Example entry: "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"
	RenamedResources map[string]string `pulumi:"renamedResources"`
	// Map from original service names to renamed versions. This is used when the default generated types would cause a naming conflict. (Neither name is fully-qualified.) Example: Subscriber to SubscriberServiceApi.
	RenamedServices map[string]string `pulumi:"renamedServices"`
}

Settings for Dotnet client libraries.

type DotnetSettingsResponseOutput added in v0.28.0

type DotnetSettingsResponseOutput struct{ *pulumi.OutputState }

Settings for Dotnet client libraries.

func (DotnetSettingsResponseOutput) Common added in v0.28.0

Some settings.

func (DotnetSettingsResponseOutput) ElementType added in v0.28.0

func (DotnetSettingsResponseOutput) ForcedNamespaceAliases added in v0.30.0

func (o DotnetSettingsResponseOutput) ForcedNamespaceAliases() pulumi.StringArrayOutput

Namespaces which must be aliased in snippets due to a known (but non-generator-predictable) naming collision

func (DotnetSettingsResponseOutput) HandwrittenSignatures added in v0.30.0

func (o DotnetSettingsResponseOutput) HandwrittenSignatures() pulumi.StringArrayOutput

Method signatures (in the form "service.method(signature)") which are provided separately, so shouldn't be generated. Snippets *calling* these methods are still generated, however.

func (DotnetSettingsResponseOutput) IgnoredResources added in v0.30.0

List of full resource types to ignore during generation. This is typically used for API-specific Location resources, which should be handled by the generator as if they were actually the common Location resources. Example entry: "documentai.googleapis.com/Location"

func (DotnetSettingsResponseOutput) RenamedResources added in v0.30.0

Map from full resource types to the effective short name for the resource. This is used when otherwise resource named from different services would cause naming collisions. Example entry: "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"

func (DotnetSettingsResponseOutput) RenamedServices added in v0.30.0

Map from original service names to renamed versions. This is used when the default generated types would cause a naming conflict. (Neither name is fully-qualified.) Example: Subscriber to SubscriberServiceApi.

func (DotnetSettingsResponseOutput) ToDotnetSettingsResponseOutput added in v0.28.0

func (o DotnetSettingsResponseOutput) ToDotnetSettingsResponseOutput() DotnetSettingsResponseOutput

func (DotnetSettingsResponseOutput) ToDotnetSettingsResponseOutputWithContext added in v0.28.0

func (o DotnetSettingsResponseOutput) ToDotnetSettingsResponseOutputWithContext(ctx context.Context) DotnetSettingsResponseOutput

type Endpoint

type Endpoint struct {
	// Unimplemented. Dot not use. DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on.
	//
	// Deprecated: Unimplemented. Dot not use. DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on.
	Aliases []string `pulumi:"aliases"`
	// Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed.
	AllowCors *bool `pulumi:"allowCors"`
	// The canonical name of this endpoint.
	Name *string `pulumi:"name"`
	// The specification of an Internet routable address of API frontend that will handle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary). It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com".
	Target *string `pulumi:"target"`
}

`Endpoint` describes a network address of a service that serves a set of APIs. It is commonly known as a service endpoint. A service may expose any number of service endpoints, and all service endpoints share the same service definition, such as quota limits and monitoring metrics. Example: type: google.api.Service name: library-example.googleapis.com endpoints: # Declares network address `https://library-example.googleapis.com` # for service `library-example.googleapis.com`. The `https` scheme # is implicit for all service endpoints. Other schemes may be # supported in the future. - name: library-example.googleapis.com allow_cors: false - name: content-staging-library-example.googleapis.com # Allows HTTP OPTIONS calls to be passed to the API frontend, for it # to decide whether the subsequent cross-origin request is allowed # to proceed. allow_cors: true

type EndpointArgs

type EndpointArgs struct {
	// Unimplemented. Dot not use. DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on.
	//
	// Deprecated: Unimplemented. Dot not use. DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on.
	Aliases pulumi.StringArrayInput `pulumi:"aliases"`
	// Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed.
	AllowCors pulumi.BoolPtrInput `pulumi:"allowCors"`
	// The canonical name of this endpoint.
	Name pulumi.StringPtrInput `pulumi:"name"`
	// The specification of an Internet routable address of API frontend that will handle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary). It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com".
	Target pulumi.StringPtrInput `pulumi:"target"`
}

`Endpoint` describes a network address of a service that serves a set of APIs. It is commonly known as a service endpoint. A service may expose any number of service endpoints, and all service endpoints share the same service definition, such as quota limits and monitoring metrics. Example: type: google.api.Service name: library-example.googleapis.com endpoints: # Declares network address `https://library-example.googleapis.com` # for service `library-example.googleapis.com`. The `https` scheme # is implicit for all service endpoints. Other schemes may be # supported in the future. - name: library-example.googleapis.com allow_cors: false - name: content-staging-library-example.googleapis.com # Allows HTTP OPTIONS calls to be passed to the API frontend, for it # to decide whether the subsequent cross-origin request is allowed # to proceed. allow_cors: true

func (EndpointArgs) ElementType

func (EndpointArgs) ElementType() reflect.Type

func (EndpointArgs) ToEndpointOutput

func (i EndpointArgs) ToEndpointOutput() EndpointOutput

func (EndpointArgs) ToEndpointOutputWithContext

func (i EndpointArgs) ToEndpointOutputWithContext(ctx context.Context) EndpointOutput

type EndpointArray

type EndpointArray []EndpointInput

func (EndpointArray) ElementType

func (EndpointArray) ElementType() reflect.Type

func (EndpointArray) ToEndpointArrayOutput

func (i EndpointArray) ToEndpointArrayOutput() EndpointArrayOutput

func (EndpointArray) ToEndpointArrayOutputWithContext

func (i EndpointArray) ToEndpointArrayOutputWithContext(ctx context.Context) EndpointArrayOutput

type EndpointArrayInput

type EndpointArrayInput interface {
	pulumi.Input

	ToEndpointArrayOutput() EndpointArrayOutput
	ToEndpointArrayOutputWithContext(context.Context) EndpointArrayOutput
}

EndpointArrayInput is an input type that accepts EndpointArray and EndpointArrayOutput values. You can construct a concrete instance of `EndpointArrayInput` via:

EndpointArray{ EndpointArgs{...} }

type EndpointArrayOutput

type EndpointArrayOutput struct{ *pulumi.OutputState }

func (EndpointArrayOutput) ElementType

func (EndpointArrayOutput) ElementType() reflect.Type

func (EndpointArrayOutput) Index

func (EndpointArrayOutput) ToEndpointArrayOutput

func (o EndpointArrayOutput) ToEndpointArrayOutput() EndpointArrayOutput

func (EndpointArrayOutput) ToEndpointArrayOutputWithContext

func (o EndpointArrayOutput) ToEndpointArrayOutputWithContext(ctx context.Context) EndpointArrayOutput

type EndpointInput

type EndpointInput interface {
	pulumi.Input

	ToEndpointOutput() EndpointOutput
	ToEndpointOutputWithContext(context.Context) EndpointOutput
}

EndpointInput is an input type that accepts EndpointArgs and EndpointOutput values. You can construct a concrete instance of `EndpointInput` via:

EndpointArgs{...}

type EndpointOutput

type EndpointOutput struct{ *pulumi.OutputState }

`Endpoint` describes a network address of a service that serves a set of APIs. It is commonly known as a service endpoint. A service may expose any number of service endpoints, and all service endpoints share the same service definition, such as quota limits and monitoring metrics. Example: type: google.api.Service name: library-example.googleapis.com endpoints: # Declares network address `https://library-example.googleapis.com` # for service `library-example.googleapis.com`. The `https` scheme # is implicit for all service endpoints. Other schemes may be # supported in the future. - name: library-example.googleapis.com allow_cors: false - name: content-staging-library-example.googleapis.com # Allows HTTP OPTIONS calls to be passed to the API frontend, for it # to decide whether the subsequent cross-origin request is allowed # to proceed. allow_cors: true

func (EndpointOutput) Aliases deprecated added in v0.2.0

Unimplemented. Dot not use. DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on.

Deprecated: Unimplemented. Dot not use. DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on.

func (EndpointOutput) AllowCors

func (o EndpointOutput) AllowCors() pulumi.BoolPtrOutput

Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed.

func (EndpointOutput) ElementType

func (EndpointOutput) ElementType() reflect.Type

func (EndpointOutput) Name

The canonical name of this endpoint.

func (EndpointOutput) Target

The specification of an Internet routable address of API frontend that will handle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary). It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com".

func (EndpointOutput) ToEndpointOutput

func (o EndpointOutput) ToEndpointOutput() EndpointOutput

func (EndpointOutput) ToEndpointOutputWithContext

func (o EndpointOutput) ToEndpointOutputWithContext(ctx context.Context) EndpointOutput

type EndpointResponse

type EndpointResponse struct {
	// Unimplemented. Dot not use. DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on.
	//
	// Deprecated: Unimplemented. Dot not use. DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on.
	Aliases []string `pulumi:"aliases"`
	// Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed.
	AllowCors bool `pulumi:"allowCors"`
	// The canonical name of this endpoint.
	Name string `pulumi:"name"`
	// The specification of an Internet routable address of API frontend that will handle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary). It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com".
	Target string `pulumi:"target"`
}

`Endpoint` describes a network address of a service that serves a set of APIs. It is commonly known as a service endpoint. A service may expose any number of service endpoints, and all service endpoints share the same service definition, such as quota limits and monitoring metrics. Example: type: google.api.Service name: library-example.googleapis.com endpoints: # Declares network address `https://library-example.googleapis.com` # for service `library-example.googleapis.com`. The `https` scheme # is implicit for all service endpoints. Other schemes may be # supported in the future. - name: library-example.googleapis.com allow_cors: false - name: content-staging-library-example.googleapis.com # Allows HTTP OPTIONS calls to be passed to the API frontend, for it # to decide whether the subsequent cross-origin request is allowed # to proceed. allow_cors: true

type EndpointResponseArrayOutput

type EndpointResponseArrayOutput struct{ *pulumi.OutputState }

func (EndpointResponseArrayOutput) ElementType

func (EndpointResponseArrayOutput) Index

func (EndpointResponseArrayOutput) ToEndpointResponseArrayOutput

func (o EndpointResponseArrayOutput) ToEndpointResponseArrayOutput() EndpointResponseArrayOutput

func (EndpointResponseArrayOutput) ToEndpointResponseArrayOutputWithContext

func (o EndpointResponseArrayOutput) ToEndpointResponseArrayOutputWithContext(ctx context.Context) EndpointResponseArrayOutput

type EndpointResponseOutput

type EndpointResponseOutput struct{ *pulumi.OutputState }

`Endpoint` describes a network address of a service that serves a set of APIs. It is commonly known as a service endpoint. A service may expose any number of service endpoints, and all service endpoints share the same service definition, such as quota limits and monitoring metrics. Example: type: google.api.Service name: library-example.googleapis.com endpoints: # Declares network address `https://library-example.googleapis.com` # for service `library-example.googleapis.com`. The `https` scheme # is implicit for all service endpoints. Other schemes may be # supported in the future. - name: library-example.googleapis.com allow_cors: false - name: content-staging-library-example.googleapis.com # Allows HTTP OPTIONS calls to be passed to the API frontend, for it # to decide whether the subsequent cross-origin request is allowed # to proceed. allow_cors: true

func (EndpointResponseOutput) Aliases deprecated added in v0.2.0

Unimplemented. Dot not use. DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on.

Deprecated: Unimplemented. Dot not use. DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on.

func (EndpointResponseOutput) AllowCors

Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed.

func (EndpointResponseOutput) ElementType

func (EndpointResponseOutput) ElementType() reflect.Type

func (EndpointResponseOutput) Name

The canonical name of this endpoint.

func (EndpointResponseOutput) Target

The specification of an Internet routable address of API frontend that will handle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary). It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com".

func (EndpointResponseOutput) ToEndpointResponseOutput

func (o EndpointResponseOutput) ToEndpointResponseOutput() EndpointResponseOutput

func (EndpointResponseOutput) ToEndpointResponseOutputWithContext

func (o EndpointResponseOutput) ToEndpointResponseOutputWithContext(ctx context.Context) EndpointResponseOutput

type Enum

type Enum struct {
	// The source edition string, only valid when syntax is SYNTAX_EDITIONS.
	Edition *string `pulumi:"edition"`
	// Enum value definitions.
	Enumvalue []EnumValue `pulumi:"enumvalue"`
	// Enum type name.
	Name *string `pulumi:"name"`
	// Protocol buffer options.
	Options []Option `pulumi:"options"`
	// The source context.
	SourceContext *SourceContext `pulumi:"sourceContext"`
	// The source syntax.
	Syntax *EnumSyntax `pulumi:"syntax"`
}

Enum type definition.

type EnumArgs

type EnumArgs struct {
	// The source edition string, only valid when syntax is SYNTAX_EDITIONS.
	Edition pulumi.StringPtrInput `pulumi:"edition"`
	// Enum value definitions.
	Enumvalue EnumValueArrayInput `pulumi:"enumvalue"`
	// Enum type name.
	Name pulumi.StringPtrInput `pulumi:"name"`
	// Protocol buffer options.
	Options OptionArrayInput `pulumi:"options"`
	// The source context.
	SourceContext SourceContextPtrInput `pulumi:"sourceContext"`
	// The source syntax.
	Syntax EnumSyntaxPtrInput `pulumi:"syntax"`
}

Enum type definition.

func (EnumArgs) ElementType

func (EnumArgs) ElementType() reflect.Type

func (EnumArgs) ToEnumOutput

func (i EnumArgs) ToEnumOutput() EnumOutput

func (EnumArgs) ToEnumOutputWithContext

func (i EnumArgs) ToEnumOutputWithContext(ctx context.Context) EnumOutput

type EnumArray

type EnumArray []EnumInput

func (EnumArray) ElementType

func (EnumArray) ElementType() reflect.Type

func (EnumArray) ToEnumArrayOutput

func (i EnumArray) ToEnumArrayOutput() EnumArrayOutput

func (EnumArray) ToEnumArrayOutputWithContext

func (i EnumArray) ToEnumArrayOutputWithContext(ctx context.Context) EnumArrayOutput

type EnumArrayInput

type EnumArrayInput interface {
	pulumi.Input

	ToEnumArrayOutput() EnumArrayOutput
	ToEnumArrayOutputWithContext(context.Context) EnumArrayOutput
}

EnumArrayInput is an input type that accepts EnumArray and EnumArrayOutput values. You can construct a concrete instance of `EnumArrayInput` via:

EnumArray{ EnumArgs{...} }

type EnumArrayOutput

type EnumArrayOutput struct{ *pulumi.OutputState }

func (EnumArrayOutput) ElementType

func (EnumArrayOutput) ElementType() reflect.Type

func (EnumArrayOutput) Index

func (EnumArrayOutput) ToEnumArrayOutput

func (o EnumArrayOutput) ToEnumArrayOutput() EnumArrayOutput

func (EnumArrayOutput) ToEnumArrayOutputWithContext

func (o EnumArrayOutput) ToEnumArrayOutputWithContext(ctx context.Context) EnumArrayOutput

type EnumInput

type EnumInput interface {
	pulumi.Input

	ToEnumOutput() EnumOutput
	ToEnumOutputWithContext(context.Context) EnumOutput
}

EnumInput is an input type that accepts EnumArgs and EnumOutput values. You can construct a concrete instance of `EnumInput` via:

EnumArgs{...}

type EnumOutput

type EnumOutput struct{ *pulumi.OutputState }

Enum type definition.

func (EnumOutput) Edition added in v0.29.0

func (o EnumOutput) Edition() pulumi.StringPtrOutput

The source edition string, only valid when syntax is SYNTAX_EDITIONS.

func (EnumOutput) ElementType

func (EnumOutput) ElementType() reflect.Type

func (EnumOutput) Enumvalue

func (o EnumOutput) Enumvalue() EnumValueArrayOutput

Enum value definitions.

func (EnumOutput) Name

Enum type name.

func (EnumOutput) Options

func (o EnumOutput) Options() OptionArrayOutput

Protocol buffer options.

func (EnumOutput) SourceContext

func (o EnumOutput) SourceContext() SourceContextPtrOutput

The source context.

func (EnumOutput) Syntax

func (o EnumOutput) Syntax() EnumSyntaxPtrOutput

The source syntax.

func (EnumOutput) ToEnumOutput

func (o EnumOutput) ToEnumOutput() EnumOutput

func (EnumOutput) ToEnumOutputWithContext

func (o EnumOutput) ToEnumOutputWithContext(ctx context.Context) EnumOutput

type EnumResponse

type EnumResponse struct {
	// The source edition string, only valid when syntax is SYNTAX_EDITIONS.
	Edition string `pulumi:"edition"`
	// Enum value definitions.
	Enumvalue []EnumValueResponse `pulumi:"enumvalue"`
	// Enum type name.
	Name string `pulumi:"name"`
	// Protocol buffer options.
	Options []OptionResponse `pulumi:"options"`
	// The source context.
	SourceContext SourceContextResponse `pulumi:"sourceContext"`
	// The source syntax.
	Syntax string `pulumi:"syntax"`
}

Enum type definition.

type EnumResponseArrayOutput

type EnumResponseArrayOutput struct{ *pulumi.OutputState }

func (EnumResponseArrayOutput) ElementType

func (EnumResponseArrayOutput) ElementType() reflect.Type

func (EnumResponseArrayOutput) Index

func (EnumResponseArrayOutput) ToEnumResponseArrayOutput

func (o EnumResponseArrayOutput) ToEnumResponseArrayOutput() EnumResponseArrayOutput

func (EnumResponseArrayOutput) ToEnumResponseArrayOutputWithContext

func (o EnumResponseArrayOutput) ToEnumResponseArrayOutputWithContext(ctx context.Context) EnumResponseArrayOutput

type EnumResponseOutput

type EnumResponseOutput struct{ *pulumi.OutputState }

Enum type definition.

func (EnumResponseOutput) Edition added in v0.29.0

The source edition string, only valid when syntax is SYNTAX_EDITIONS.

func (EnumResponseOutput) ElementType

func (EnumResponseOutput) ElementType() reflect.Type

func (EnumResponseOutput) Enumvalue

Enum value definitions.

func (EnumResponseOutput) Name

Enum type name.

func (EnumResponseOutput) Options

Protocol buffer options.

func (EnumResponseOutput) SourceContext

The source context.

func (EnumResponseOutput) Syntax

The source syntax.

func (EnumResponseOutput) ToEnumResponseOutput

func (o EnumResponseOutput) ToEnumResponseOutput() EnumResponseOutput

func (EnumResponseOutput) ToEnumResponseOutputWithContext

func (o EnumResponseOutput) ToEnumResponseOutputWithContext(ctx context.Context) EnumResponseOutput

type EnumSyntax added in v0.4.0

type EnumSyntax string

The source syntax.

func (EnumSyntax) ElementType added in v0.4.0

func (EnumSyntax) ElementType() reflect.Type

func (EnumSyntax) ToEnumSyntaxOutput added in v0.6.0

func (e EnumSyntax) ToEnumSyntaxOutput() EnumSyntaxOutput

func (EnumSyntax) ToEnumSyntaxOutputWithContext added in v0.6.0

func (e EnumSyntax) ToEnumSyntaxOutputWithContext(ctx context.Context) EnumSyntaxOutput

func (EnumSyntax) ToEnumSyntaxPtrOutput added in v0.6.0

func (e EnumSyntax) ToEnumSyntaxPtrOutput() EnumSyntaxPtrOutput

func (EnumSyntax) ToEnumSyntaxPtrOutputWithContext added in v0.6.0

func (e EnumSyntax) ToEnumSyntaxPtrOutputWithContext(ctx context.Context) EnumSyntaxPtrOutput

func (EnumSyntax) ToStringOutput added in v0.4.0

func (e EnumSyntax) ToStringOutput() pulumi.StringOutput

func (EnumSyntax) ToStringOutputWithContext added in v0.4.0

func (e EnumSyntax) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (EnumSyntax) ToStringPtrOutput added in v0.4.0

func (e EnumSyntax) ToStringPtrOutput() pulumi.StringPtrOutput

func (EnumSyntax) ToStringPtrOutputWithContext added in v0.4.0

func (e EnumSyntax) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type EnumSyntaxInput added in v0.6.0

type EnumSyntaxInput interface {
	pulumi.Input

	ToEnumSyntaxOutput() EnumSyntaxOutput
	ToEnumSyntaxOutputWithContext(context.Context) EnumSyntaxOutput
}

EnumSyntaxInput is an input type that accepts EnumSyntaxArgs and EnumSyntaxOutput values. You can construct a concrete instance of `EnumSyntaxInput` via:

EnumSyntaxArgs{...}

type EnumSyntaxOutput added in v0.6.0

type EnumSyntaxOutput struct{ *pulumi.OutputState }

func (EnumSyntaxOutput) ElementType added in v0.6.0

func (EnumSyntaxOutput) ElementType() reflect.Type

func (EnumSyntaxOutput) ToEnumSyntaxOutput added in v0.6.0

func (o EnumSyntaxOutput) ToEnumSyntaxOutput() EnumSyntaxOutput

func (EnumSyntaxOutput) ToEnumSyntaxOutputWithContext added in v0.6.0

func (o EnumSyntaxOutput) ToEnumSyntaxOutputWithContext(ctx context.Context) EnumSyntaxOutput

func (EnumSyntaxOutput) ToEnumSyntaxPtrOutput added in v0.6.0

func (o EnumSyntaxOutput) ToEnumSyntaxPtrOutput() EnumSyntaxPtrOutput

func (EnumSyntaxOutput) ToEnumSyntaxPtrOutputWithContext added in v0.6.0

func (o EnumSyntaxOutput) ToEnumSyntaxPtrOutputWithContext(ctx context.Context) EnumSyntaxPtrOutput

func (EnumSyntaxOutput) ToStringOutput added in v0.6.0

func (o EnumSyntaxOutput) ToStringOutput() pulumi.StringOutput

func (EnumSyntaxOutput) ToStringOutputWithContext added in v0.6.0

func (o EnumSyntaxOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (EnumSyntaxOutput) ToStringPtrOutput added in v0.6.0

func (o EnumSyntaxOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (EnumSyntaxOutput) ToStringPtrOutputWithContext added in v0.6.0

func (o EnumSyntaxOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type EnumSyntaxPtrInput added in v0.6.0

type EnumSyntaxPtrInput interface {
	pulumi.Input

	ToEnumSyntaxPtrOutput() EnumSyntaxPtrOutput
	ToEnumSyntaxPtrOutputWithContext(context.Context) EnumSyntaxPtrOutput
}

func EnumSyntaxPtr added in v0.6.0

func EnumSyntaxPtr(v string) EnumSyntaxPtrInput

type EnumSyntaxPtrOutput added in v0.6.0

type EnumSyntaxPtrOutput struct{ *pulumi.OutputState }

func (EnumSyntaxPtrOutput) Elem added in v0.6.0

func (EnumSyntaxPtrOutput) ElementType added in v0.6.0

func (EnumSyntaxPtrOutput) ElementType() reflect.Type

func (EnumSyntaxPtrOutput) ToEnumSyntaxPtrOutput added in v0.6.0

func (o EnumSyntaxPtrOutput) ToEnumSyntaxPtrOutput() EnumSyntaxPtrOutput

func (EnumSyntaxPtrOutput) ToEnumSyntaxPtrOutputWithContext added in v0.6.0

func (o EnumSyntaxPtrOutput) ToEnumSyntaxPtrOutputWithContext(ctx context.Context) EnumSyntaxPtrOutput

func (EnumSyntaxPtrOutput) ToStringPtrOutput added in v0.6.0

func (o EnumSyntaxPtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (EnumSyntaxPtrOutput) ToStringPtrOutputWithContext added in v0.6.0

func (o EnumSyntaxPtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type EnumValue

type EnumValue struct {
	// Enum value name.
	Name *string `pulumi:"name"`
	// Enum value number.
	Number *int `pulumi:"number"`
	// Protocol buffer options.
	Options []Option `pulumi:"options"`
}

Enum value definition.

type EnumValueArgs

type EnumValueArgs struct {
	// Enum value name.
	Name pulumi.StringPtrInput `pulumi:"name"`
	// Enum value number.
	Number pulumi.IntPtrInput `pulumi:"number"`
	// Protocol buffer options.
	Options OptionArrayInput `pulumi:"options"`
}

Enum value definition.

func (EnumValueArgs) ElementType

func (EnumValueArgs) ElementType() reflect.Type

func (EnumValueArgs) ToEnumValueOutput

func (i EnumValueArgs) ToEnumValueOutput() EnumValueOutput

func (EnumValueArgs) ToEnumValueOutputWithContext

func (i EnumValueArgs) ToEnumValueOutputWithContext(ctx context.Context) EnumValueOutput

type EnumValueArray

type EnumValueArray []EnumValueInput

func (EnumValueArray) ElementType

func (EnumValueArray) ElementType() reflect.Type

func (EnumValueArray) ToEnumValueArrayOutput

func (i EnumValueArray) ToEnumValueArrayOutput() EnumValueArrayOutput

func (EnumValueArray) ToEnumValueArrayOutputWithContext

func (i EnumValueArray) ToEnumValueArrayOutputWithContext(ctx context.Context) EnumValueArrayOutput

type EnumValueArrayInput

type EnumValueArrayInput interface {
	pulumi.Input

	ToEnumValueArrayOutput() EnumValueArrayOutput
	ToEnumValueArrayOutputWithContext(context.Context) EnumValueArrayOutput
}

EnumValueArrayInput is an input type that accepts EnumValueArray and EnumValueArrayOutput values. You can construct a concrete instance of `EnumValueArrayInput` via:

EnumValueArray{ EnumValueArgs{...} }

type EnumValueArrayOutput

type EnumValueArrayOutput struct{ *pulumi.OutputState }

func (EnumValueArrayOutput) ElementType

func (EnumValueArrayOutput) ElementType() reflect.Type

func (EnumValueArrayOutput) Index

func (EnumValueArrayOutput) ToEnumValueArrayOutput

func (o EnumValueArrayOutput) ToEnumValueArrayOutput() EnumValueArrayOutput

func (EnumValueArrayOutput) ToEnumValueArrayOutputWithContext

func (o EnumValueArrayOutput) ToEnumValueArrayOutputWithContext(ctx context.Context) EnumValueArrayOutput

type EnumValueInput

type EnumValueInput interface {
	pulumi.Input

	ToEnumValueOutput() EnumValueOutput
	ToEnumValueOutputWithContext(context.Context) EnumValueOutput
}

EnumValueInput is an input type that accepts EnumValueArgs and EnumValueOutput values. You can construct a concrete instance of `EnumValueInput` via:

EnumValueArgs{...}

type EnumValueOutput

type EnumValueOutput struct{ *pulumi.OutputState }

Enum value definition.

func (EnumValueOutput) ElementType

func (EnumValueOutput) ElementType() reflect.Type

func (EnumValueOutput) Name

Enum value name.

func (EnumValueOutput) Number

func (o EnumValueOutput) Number() pulumi.IntPtrOutput

Enum value number.

func (EnumValueOutput) Options

func (o EnumValueOutput) Options() OptionArrayOutput

Protocol buffer options.

func (EnumValueOutput) ToEnumValueOutput

func (o EnumValueOutput) ToEnumValueOutput() EnumValueOutput

func (EnumValueOutput) ToEnumValueOutputWithContext

func (o EnumValueOutput) ToEnumValueOutputWithContext(ctx context.Context) EnumValueOutput

type EnumValueResponse

type EnumValueResponse struct {
	// Enum value name.
	Name string `pulumi:"name"`
	// Enum value number.
	Number int `pulumi:"number"`
	// Protocol buffer options.
	Options []OptionResponse `pulumi:"options"`
}

Enum value definition.

type EnumValueResponseArrayOutput

type EnumValueResponseArrayOutput struct{ *pulumi.OutputState }

func (EnumValueResponseArrayOutput) ElementType

func (EnumValueResponseArrayOutput) Index

func (EnumValueResponseArrayOutput) ToEnumValueResponseArrayOutput

func (o EnumValueResponseArrayOutput) ToEnumValueResponseArrayOutput() EnumValueResponseArrayOutput

func (EnumValueResponseArrayOutput) ToEnumValueResponseArrayOutputWithContext

func (o EnumValueResponseArrayOutput) ToEnumValueResponseArrayOutputWithContext(ctx context.Context) EnumValueResponseArrayOutput

type EnumValueResponseOutput

type EnumValueResponseOutput struct{ *pulumi.OutputState }

Enum value definition.

func (EnumValueResponseOutput) ElementType

func (EnumValueResponseOutput) ElementType() reflect.Type

func (EnumValueResponseOutput) Name

Enum value name.

func (EnumValueResponseOutput) Number

Enum value number.

func (EnumValueResponseOutput) Options

Protocol buffer options.

func (EnumValueResponseOutput) ToEnumValueResponseOutput

func (o EnumValueResponseOutput) ToEnumValueResponseOutput() EnumValueResponseOutput

func (EnumValueResponseOutput) ToEnumValueResponseOutputWithContext

func (o EnumValueResponseOutput) ToEnumValueResponseOutputWithContext(ctx context.Context) EnumValueResponseOutput

type Expr

type Expr struct {
	// Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
	Description *string `pulumi:"description"`
	// Textual representation of an expression in Common Expression Language syntax.
	Expression *string `pulumi:"expression"`
	// Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
	Location *string `pulumi:"location"`
	// Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
	Title *string `pulumi:"title"`
}

Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

type ExprArgs

type ExprArgs struct {
	// Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
	Description pulumi.StringPtrInput `pulumi:"description"`
	// Textual representation of an expression in Common Expression Language syntax.
	Expression pulumi.StringPtrInput `pulumi:"expression"`
	// Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
	Location pulumi.StringPtrInput `pulumi:"location"`
	// Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
	Title pulumi.StringPtrInput `pulumi:"title"`
}

Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

func (ExprArgs) ElementType

func (ExprArgs) ElementType() reflect.Type

func (ExprArgs) ToExprOutput

func (i ExprArgs) ToExprOutput() ExprOutput

func (ExprArgs) ToExprOutputWithContext

func (i ExprArgs) ToExprOutputWithContext(ctx context.Context) ExprOutput

func (ExprArgs) ToExprPtrOutput

func (i ExprArgs) ToExprPtrOutput() ExprPtrOutput

func (ExprArgs) ToExprPtrOutputWithContext

func (i ExprArgs) ToExprPtrOutputWithContext(ctx context.Context) ExprPtrOutput

type ExprInput

type ExprInput interface {
	pulumi.Input

	ToExprOutput() ExprOutput
	ToExprOutputWithContext(context.Context) ExprOutput
}

ExprInput is an input type that accepts ExprArgs and ExprOutput values. You can construct a concrete instance of `ExprInput` via:

ExprArgs{...}

type ExprOutput

type ExprOutput struct{ *pulumi.OutputState }

Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

func (ExprOutput) Description

func (o ExprOutput) Description() pulumi.StringPtrOutput

Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

func (ExprOutput) ElementType

func (ExprOutput) ElementType() reflect.Type

func (ExprOutput) Expression

func (o ExprOutput) Expression() pulumi.StringPtrOutput

Textual representation of an expression in Common Expression Language syntax.

func (ExprOutput) Location

func (o ExprOutput) Location() pulumi.StringPtrOutput

Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

func (ExprOutput) Title

func (o ExprOutput) Title() pulumi.StringPtrOutput

Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

func (ExprOutput) ToExprOutput

func (o ExprOutput) ToExprOutput() ExprOutput

func (ExprOutput) ToExprOutputWithContext

func (o ExprOutput) ToExprOutputWithContext(ctx context.Context) ExprOutput

func (ExprOutput) ToExprPtrOutput

func (o ExprOutput) ToExprPtrOutput() ExprPtrOutput

func (ExprOutput) ToExprPtrOutputWithContext

func (o ExprOutput) ToExprPtrOutputWithContext(ctx context.Context) ExprPtrOutput

type ExprPtrInput

type ExprPtrInput interface {
	pulumi.Input

	ToExprPtrOutput() ExprPtrOutput
	ToExprPtrOutputWithContext(context.Context) ExprPtrOutput
}

ExprPtrInput is an input type that accepts ExprArgs, ExprPtr and ExprPtrOutput values. You can construct a concrete instance of `ExprPtrInput` via:

        ExprArgs{...}

or:

        nil

func ExprPtr

func ExprPtr(v *ExprArgs) ExprPtrInput

type ExprPtrOutput

type ExprPtrOutput struct{ *pulumi.OutputState }

func (ExprPtrOutput) Description

func (o ExprPtrOutput) Description() pulumi.StringPtrOutput

Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

func (ExprPtrOutput) Elem

func (o ExprPtrOutput) Elem() ExprOutput

func (ExprPtrOutput) ElementType

func (ExprPtrOutput) ElementType() reflect.Type

func (ExprPtrOutput) Expression

func (o ExprPtrOutput) Expression() pulumi.StringPtrOutput

Textual representation of an expression in Common Expression Language syntax.

func (ExprPtrOutput) Location

func (o ExprPtrOutput) Location() pulumi.StringPtrOutput

Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

func (ExprPtrOutput) Title

Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

func (ExprPtrOutput) ToExprPtrOutput

func (o ExprPtrOutput) ToExprPtrOutput() ExprPtrOutput

func (ExprPtrOutput) ToExprPtrOutputWithContext

func (o ExprPtrOutput) ToExprPtrOutputWithContext(ctx context.Context) ExprPtrOutput

type ExprResponse

type ExprResponse struct {
	// Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
	Description string `pulumi:"description"`
	// Textual representation of an expression in Common Expression Language syntax.
	Expression string `pulumi:"expression"`
	// Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
	Location string `pulumi:"location"`
	// Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
	Title string `pulumi:"title"`
}

Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

type ExprResponseOutput

type ExprResponseOutput struct{ *pulumi.OutputState }

Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

func (ExprResponseOutput) Description

func (o ExprResponseOutput) Description() pulumi.StringOutput

Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

func (ExprResponseOutput) ElementType

func (ExprResponseOutput) ElementType() reflect.Type

func (ExprResponseOutput) Expression

func (o ExprResponseOutput) Expression() pulumi.StringOutput

Textual representation of an expression in Common Expression Language syntax.

func (ExprResponseOutput) Location

func (o ExprResponseOutput) Location() pulumi.StringOutput

Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

func (ExprResponseOutput) Title

Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

func (ExprResponseOutput) ToExprResponseOutput

func (o ExprResponseOutput) ToExprResponseOutput() ExprResponseOutput

func (ExprResponseOutput) ToExprResponseOutputWithContext

func (o ExprResponseOutput) ToExprResponseOutputWithContext(ctx context.Context) ExprResponseOutput

type Field

type Field struct {
	// The field cardinality.
	Cardinality *FieldCardinality `pulumi:"cardinality"`
	// The string value of the default value of this field. Proto2 syntax only.
	DefaultValue *string `pulumi:"defaultValue"`
	// The field JSON name.
	JsonName *string `pulumi:"jsonName"`
	// The field type.
	Kind *FieldKind `pulumi:"kind"`
	// The field name.
	Name *string `pulumi:"name"`
	// The field number.
	Number *int `pulumi:"number"`
	// The index of the field type in `Type.oneofs`, for message or enumeration types. The first type has index 1; zero means the type is not in the list.
	OneofIndex *int `pulumi:"oneofIndex"`
	// The protocol buffer options.
	Options []Option `pulumi:"options"`
	// Whether to use alternative packed wire representation.
	Packed *bool `pulumi:"packed"`
	// The field type URL, without the scheme, for message or enumeration types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
	TypeUrl *string `pulumi:"typeUrl"`
}

A single field of a message type.

type FieldArgs

type FieldArgs struct {
	// The field cardinality.
	Cardinality FieldCardinalityPtrInput `pulumi:"cardinality"`
	// The string value of the default value of this field. Proto2 syntax only.
	DefaultValue pulumi.StringPtrInput `pulumi:"defaultValue"`
	// The field JSON name.
	JsonName pulumi.StringPtrInput `pulumi:"jsonName"`
	// The field type.
	Kind FieldKindPtrInput `pulumi:"kind"`
	// The field name.
	Name pulumi.StringPtrInput `pulumi:"name"`
	// The field number.
	Number pulumi.IntPtrInput `pulumi:"number"`
	// The index of the field type in `Type.oneofs`, for message or enumeration types. The first type has index 1; zero means the type is not in the list.
	OneofIndex pulumi.IntPtrInput `pulumi:"oneofIndex"`
	// The protocol buffer options.
	Options OptionArrayInput `pulumi:"options"`
	// Whether to use alternative packed wire representation.
	Packed pulumi.BoolPtrInput `pulumi:"packed"`
	// The field type URL, without the scheme, for message or enumeration types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
	TypeUrl pulumi.StringPtrInput `pulumi:"typeUrl"`
}

A single field of a message type.

func (FieldArgs) ElementType

func (FieldArgs) ElementType() reflect.Type

func (FieldArgs) ToFieldOutput

func (i FieldArgs) ToFieldOutput() FieldOutput

func (FieldArgs) ToFieldOutputWithContext

func (i FieldArgs) ToFieldOutputWithContext(ctx context.Context) FieldOutput

type FieldArray

type FieldArray []FieldInput

func (FieldArray) ElementType

func (FieldArray) ElementType() reflect.Type

func (FieldArray) ToFieldArrayOutput

func (i FieldArray) ToFieldArrayOutput() FieldArrayOutput

func (FieldArray) ToFieldArrayOutputWithContext

func (i FieldArray) ToFieldArrayOutputWithContext(ctx context.Context) FieldArrayOutput

type FieldArrayInput

type FieldArrayInput interface {
	pulumi.Input

	ToFieldArrayOutput() FieldArrayOutput
	ToFieldArrayOutputWithContext(context.Context) FieldArrayOutput
}

FieldArrayInput is an input type that accepts FieldArray and FieldArrayOutput values. You can construct a concrete instance of `FieldArrayInput` via:

FieldArray{ FieldArgs{...} }

type FieldArrayOutput

type FieldArrayOutput struct{ *pulumi.OutputState }

func (FieldArrayOutput) ElementType

func (FieldArrayOutput) ElementType() reflect.Type

func (FieldArrayOutput) Index

func (FieldArrayOutput) ToFieldArrayOutput

func (o FieldArrayOutput) ToFieldArrayOutput() FieldArrayOutput

func (FieldArrayOutput) ToFieldArrayOutputWithContext

func (o FieldArrayOutput) ToFieldArrayOutputWithContext(ctx context.Context) FieldArrayOutput

type FieldCardinality added in v0.4.0

type FieldCardinality string

The field cardinality.

func (FieldCardinality) ElementType added in v0.4.0

func (FieldCardinality) ElementType() reflect.Type

func (FieldCardinality) ToFieldCardinalityOutput added in v0.6.0

func (e FieldCardinality) ToFieldCardinalityOutput() FieldCardinalityOutput

func (FieldCardinality) ToFieldCardinalityOutputWithContext added in v0.6.0

func (e FieldCardinality) ToFieldCardinalityOutputWithContext(ctx context.Context) FieldCardinalityOutput

func (FieldCardinality) ToFieldCardinalityPtrOutput added in v0.6.0

func (e FieldCardinality) ToFieldCardinalityPtrOutput() FieldCardinalityPtrOutput

func (FieldCardinality) ToFieldCardinalityPtrOutputWithContext added in v0.6.0

func (e FieldCardinality) ToFieldCardinalityPtrOutputWithContext(ctx context.Context) FieldCardinalityPtrOutput

func (FieldCardinality) ToStringOutput added in v0.4.0

func (e FieldCardinality) ToStringOutput() pulumi.StringOutput

func (FieldCardinality) ToStringOutputWithContext added in v0.4.0

func (e FieldCardinality) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (FieldCardinality) ToStringPtrOutput added in v0.4.0

func (e FieldCardinality) ToStringPtrOutput() pulumi.StringPtrOutput

func (FieldCardinality) ToStringPtrOutputWithContext added in v0.4.0

func (e FieldCardinality) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type FieldCardinalityInput added in v0.6.0

type FieldCardinalityInput interface {
	pulumi.Input

	ToFieldCardinalityOutput() FieldCardinalityOutput
	ToFieldCardinalityOutputWithContext(context.Context) FieldCardinalityOutput
}

FieldCardinalityInput is an input type that accepts FieldCardinalityArgs and FieldCardinalityOutput values. You can construct a concrete instance of `FieldCardinalityInput` via:

FieldCardinalityArgs{...}

type FieldCardinalityOutput added in v0.6.0

type FieldCardinalityOutput struct{ *pulumi.OutputState }

func (FieldCardinalityOutput) ElementType added in v0.6.0

func (FieldCardinalityOutput) ElementType() reflect.Type

func (FieldCardinalityOutput) ToFieldCardinalityOutput added in v0.6.0

func (o FieldCardinalityOutput) ToFieldCardinalityOutput() FieldCardinalityOutput

func (FieldCardinalityOutput) ToFieldCardinalityOutputWithContext added in v0.6.0

func (o FieldCardinalityOutput) ToFieldCardinalityOutputWithContext(ctx context.Context) FieldCardinalityOutput

func (FieldCardinalityOutput) ToFieldCardinalityPtrOutput added in v0.6.0

func (o FieldCardinalityOutput) ToFieldCardinalityPtrOutput() FieldCardinalityPtrOutput

func (FieldCardinalityOutput) ToFieldCardinalityPtrOutputWithContext added in v0.6.0

func (o FieldCardinalityOutput) ToFieldCardinalityPtrOutputWithContext(ctx context.Context) FieldCardinalityPtrOutput

func (FieldCardinalityOutput) ToStringOutput added in v0.6.0

func (o FieldCardinalityOutput) ToStringOutput() pulumi.StringOutput

func (FieldCardinalityOutput) ToStringOutputWithContext added in v0.6.0

func (o FieldCardinalityOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (FieldCardinalityOutput) ToStringPtrOutput added in v0.6.0

func (o FieldCardinalityOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (FieldCardinalityOutput) ToStringPtrOutputWithContext added in v0.6.0

func (o FieldCardinalityOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type FieldCardinalityPtrInput added in v0.6.0

type FieldCardinalityPtrInput interface {
	pulumi.Input

	ToFieldCardinalityPtrOutput() FieldCardinalityPtrOutput
	ToFieldCardinalityPtrOutputWithContext(context.Context) FieldCardinalityPtrOutput
}

func FieldCardinalityPtr added in v0.6.0

func FieldCardinalityPtr(v string) FieldCardinalityPtrInput

type FieldCardinalityPtrOutput added in v0.6.0

type FieldCardinalityPtrOutput struct{ *pulumi.OutputState }

func (FieldCardinalityPtrOutput) Elem added in v0.6.0

func (FieldCardinalityPtrOutput) ElementType added in v0.6.0

func (FieldCardinalityPtrOutput) ElementType() reflect.Type

func (FieldCardinalityPtrOutput) ToFieldCardinalityPtrOutput added in v0.6.0

func (o FieldCardinalityPtrOutput) ToFieldCardinalityPtrOutput() FieldCardinalityPtrOutput

func (FieldCardinalityPtrOutput) ToFieldCardinalityPtrOutputWithContext added in v0.6.0

func (o FieldCardinalityPtrOutput) ToFieldCardinalityPtrOutputWithContext(ctx context.Context) FieldCardinalityPtrOutput

func (FieldCardinalityPtrOutput) ToStringPtrOutput added in v0.6.0

func (o FieldCardinalityPtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (FieldCardinalityPtrOutput) ToStringPtrOutputWithContext added in v0.6.0

func (o FieldCardinalityPtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type FieldInput

type FieldInput interface {
	pulumi.Input

	ToFieldOutput() FieldOutput
	ToFieldOutputWithContext(context.Context) FieldOutput
}

FieldInput is an input type that accepts FieldArgs and FieldOutput values. You can construct a concrete instance of `FieldInput` via:

FieldArgs{...}

type FieldKind added in v0.4.0

type FieldKind string

The field type.

func (FieldKind) ElementType added in v0.4.0

func (FieldKind) ElementType() reflect.Type

func (FieldKind) ToFieldKindOutput added in v0.6.0

func (e FieldKind) ToFieldKindOutput() FieldKindOutput

func (FieldKind) ToFieldKindOutputWithContext added in v0.6.0

func (e FieldKind) ToFieldKindOutputWithContext(ctx context.Context) FieldKindOutput

func (FieldKind) ToFieldKindPtrOutput added in v0.6.0

func (e FieldKind) ToFieldKindPtrOutput() FieldKindPtrOutput

func (FieldKind) ToFieldKindPtrOutputWithContext added in v0.6.0

func (e FieldKind) ToFieldKindPtrOutputWithContext(ctx context.Context) FieldKindPtrOutput

func (FieldKind) ToStringOutput added in v0.4.0

func (e FieldKind) ToStringOutput() pulumi.StringOutput

func (FieldKind) ToStringOutputWithContext added in v0.4.0

func (e FieldKind) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (FieldKind) ToStringPtrOutput added in v0.4.0

func (e FieldKind) ToStringPtrOutput() pulumi.StringPtrOutput

func (FieldKind) ToStringPtrOutputWithContext added in v0.4.0

func (e FieldKind) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type FieldKindInput added in v0.6.0

type FieldKindInput interface {
	pulumi.Input

	ToFieldKindOutput() FieldKindOutput
	ToFieldKindOutputWithContext(context.Context) FieldKindOutput
}

FieldKindInput is an input type that accepts FieldKindArgs and FieldKindOutput values. You can construct a concrete instance of `FieldKindInput` via:

FieldKindArgs{...}

type FieldKindOutput added in v0.6.0

type FieldKindOutput struct{ *pulumi.OutputState }

func (FieldKindOutput) ElementType added in v0.6.0

func (FieldKindOutput) ElementType() reflect.Type

func (FieldKindOutput) ToFieldKindOutput added in v0.6.0

func (o FieldKindOutput) ToFieldKindOutput() FieldKindOutput

func (FieldKindOutput) ToFieldKindOutputWithContext added in v0.6.0

func (o FieldKindOutput) ToFieldKindOutputWithContext(ctx context.Context) FieldKindOutput

func (FieldKindOutput) ToFieldKindPtrOutput added in v0.6.0

func (o FieldKindOutput) ToFieldKindPtrOutput() FieldKindPtrOutput

func (FieldKindOutput) ToFieldKindPtrOutputWithContext added in v0.6.0

func (o FieldKindOutput) ToFieldKindPtrOutputWithContext(ctx context.Context) FieldKindPtrOutput

func (FieldKindOutput) ToStringOutput added in v0.6.0

func (o FieldKindOutput) ToStringOutput() pulumi.StringOutput

func (FieldKindOutput) ToStringOutputWithContext added in v0.6.0

func (o FieldKindOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (FieldKindOutput) ToStringPtrOutput added in v0.6.0

func (o FieldKindOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (FieldKindOutput) ToStringPtrOutputWithContext added in v0.6.0

func (o FieldKindOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type FieldKindPtrInput added in v0.6.0

type FieldKindPtrInput interface {
	pulumi.Input

	ToFieldKindPtrOutput() FieldKindPtrOutput
	ToFieldKindPtrOutputWithContext(context.Context) FieldKindPtrOutput
}

func FieldKindPtr added in v0.6.0

func FieldKindPtr(v string) FieldKindPtrInput

type FieldKindPtrOutput added in v0.6.0

type FieldKindPtrOutput struct{ *pulumi.OutputState }

func (FieldKindPtrOutput) Elem added in v0.6.0

func (FieldKindPtrOutput) ElementType added in v0.6.0

func (FieldKindPtrOutput) ElementType() reflect.Type

func (FieldKindPtrOutput) ToFieldKindPtrOutput added in v0.6.0

func (o FieldKindPtrOutput) ToFieldKindPtrOutput() FieldKindPtrOutput

func (FieldKindPtrOutput) ToFieldKindPtrOutputWithContext added in v0.6.0

func (o FieldKindPtrOutput) ToFieldKindPtrOutputWithContext(ctx context.Context) FieldKindPtrOutput

func (FieldKindPtrOutput) ToStringPtrOutput added in v0.6.0

func (o FieldKindPtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (FieldKindPtrOutput) ToStringPtrOutputWithContext added in v0.6.0

func (o FieldKindPtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type FieldOutput

type FieldOutput struct{ *pulumi.OutputState }

A single field of a message type.

func (FieldOutput) Cardinality

func (o FieldOutput) Cardinality() FieldCardinalityPtrOutput

The field cardinality.

func (FieldOutput) DefaultValue

func (o FieldOutput) DefaultValue() pulumi.StringPtrOutput

The string value of the default value of this field. Proto2 syntax only.

func (FieldOutput) ElementType

func (FieldOutput) ElementType() reflect.Type

func (FieldOutput) JsonName

func (o FieldOutput) JsonName() pulumi.StringPtrOutput

The field JSON name.

func (FieldOutput) Kind

The field type.

func (FieldOutput) Name

The field name.

func (FieldOutput) Number

func (o FieldOutput) Number() pulumi.IntPtrOutput

The field number.

func (FieldOutput) OneofIndex

func (o FieldOutput) OneofIndex() pulumi.IntPtrOutput

The index of the field type in `Type.oneofs`, for message or enumeration types. The first type has index 1; zero means the type is not in the list.

func (FieldOutput) Options

func (o FieldOutput) Options() OptionArrayOutput

The protocol buffer options.

func (FieldOutput) Packed

func (o FieldOutput) Packed() pulumi.BoolPtrOutput

Whether to use alternative packed wire representation.

func (FieldOutput) ToFieldOutput

func (o FieldOutput) ToFieldOutput() FieldOutput

func (FieldOutput) ToFieldOutputWithContext

func (o FieldOutput) ToFieldOutputWithContext(ctx context.Context) FieldOutput

func (FieldOutput) TypeUrl

func (o FieldOutput) TypeUrl() pulumi.StringPtrOutput

The field type URL, without the scheme, for message or enumeration types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.

type FieldPolicy added in v0.32.0

type FieldPolicy struct {
	// Specifies the required permission(s) for the resource referred to by the field. It requires the field contains a valid resource reference, and the request must pass the permission checks to proceed. For example, "resourcemanager.projects.get".
	ResourcePermission *string `pulumi:"resourcePermission"`
	// Specifies the resource type for the resource referred to by the field.
	ResourceType *string `pulumi:"resourceType"`
	// Selects one or more request or response message fields to apply this `FieldPolicy`. When a `FieldPolicy` is used in proto annotation, the selector must be left as empty. The service config generator will automatically fill the correct value. When a `FieldPolicy` is used in service config, the selector must be a comma-separated string with valid request or response field paths, such as "foo.bar" or "foo.bar,foo.baz".
	Selector *string `pulumi:"selector"`
}

Google API Policy Annotation This message defines a simple API policy annotation that can be used to annotate API request and response message fields with applicable policies. One field may have multiple applicable policies that must all be satisfied before a request can be processed. This policy annotation is used to generate the overall policy that will be used for automatic runtime policy enforcement and documentation generation.

type FieldPolicyArgs added in v0.32.0

type FieldPolicyArgs struct {
	// Specifies the required permission(s) for the resource referred to by the field. It requires the field contains a valid resource reference, and the request must pass the permission checks to proceed. For example, "resourcemanager.projects.get".
	ResourcePermission pulumi.StringPtrInput `pulumi:"resourcePermission"`
	// Specifies the resource type for the resource referred to by the field.
	ResourceType pulumi.StringPtrInput `pulumi:"resourceType"`
	// Selects one or more request or response message fields to apply this `FieldPolicy`. When a `FieldPolicy` is used in proto annotation, the selector must be left as empty. The service config generator will automatically fill the correct value. When a `FieldPolicy` is used in service config, the selector must be a comma-separated string with valid request or response field paths, such as "foo.bar" or "foo.bar,foo.baz".
	Selector pulumi.StringPtrInput `pulumi:"selector"`
}

Google API Policy Annotation This message defines a simple API policy annotation that can be used to annotate API request and response message fields with applicable policies. One field may have multiple applicable policies that must all be satisfied before a request can be processed. This policy annotation is used to generate the overall policy that will be used for automatic runtime policy enforcement and documentation generation.

func (FieldPolicyArgs) ElementType added in v0.32.0

func (FieldPolicyArgs) ElementType() reflect.Type

func (FieldPolicyArgs) ToFieldPolicyOutput added in v0.32.0

func (i FieldPolicyArgs) ToFieldPolicyOutput() FieldPolicyOutput

func (FieldPolicyArgs) ToFieldPolicyOutputWithContext added in v0.32.0

func (i FieldPolicyArgs) ToFieldPolicyOutputWithContext(ctx context.Context) FieldPolicyOutput

type FieldPolicyArray added in v0.32.0

type FieldPolicyArray []FieldPolicyInput

func (FieldPolicyArray) ElementType added in v0.32.0

func (FieldPolicyArray) ElementType() reflect.Type

func (FieldPolicyArray) ToFieldPolicyArrayOutput added in v0.32.0

func (i FieldPolicyArray) ToFieldPolicyArrayOutput() FieldPolicyArrayOutput

func (FieldPolicyArray) ToFieldPolicyArrayOutputWithContext added in v0.32.0

func (i FieldPolicyArray) ToFieldPolicyArrayOutputWithContext(ctx context.Context) FieldPolicyArrayOutput

type FieldPolicyArrayInput added in v0.32.0

type FieldPolicyArrayInput interface {
	pulumi.Input

	ToFieldPolicyArrayOutput() FieldPolicyArrayOutput
	ToFieldPolicyArrayOutputWithContext(context.Context) FieldPolicyArrayOutput
}

FieldPolicyArrayInput is an input type that accepts FieldPolicyArray and FieldPolicyArrayOutput values. You can construct a concrete instance of `FieldPolicyArrayInput` via:

FieldPolicyArray{ FieldPolicyArgs{...} }

type FieldPolicyArrayOutput added in v0.32.0

type FieldPolicyArrayOutput struct{ *pulumi.OutputState }

func (FieldPolicyArrayOutput) ElementType added in v0.32.0

func (FieldPolicyArrayOutput) ElementType() reflect.Type

func (FieldPolicyArrayOutput) Index added in v0.32.0

func (FieldPolicyArrayOutput) ToFieldPolicyArrayOutput added in v0.32.0

func (o FieldPolicyArrayOutput) ToFieldPolicyArrayOutput() FieldPolicyArrayOutput

func (FieldPolicyArrayOutput) ToFieldPolicyArrayOutputWithContext added in v0.32.0

func (o FieldPolicyArrayOutput) ToFieldPolicyArrayOutputWithContext(ctx context.Context) FieldPolicyArrayOutput

type FieldPolicyInput added in v0.32.0

type FieldPolicyInput interface {
	pulumi.Input

	ToFieldPolicyOutput() FieldPolicyOutput
	ToFieldPolicyOutputWithContext(context.Context) FieldPolicyOutput
}

FieldPolicyInput is an input type that accepts FieldPolicyArgs and FieldPolicyOutput values. You can construct a concrete instance of `FieldPolicyInput` via:

FieldPolicyArgs{...}

type FieldPolicyOutput added in v0.32.0

type FieldPolicyOutput struct{ *pulumi.OutputState }

Google API Policy Annotation This message defines a simple API policy annotation that can be used to annotate API request and response message fields with applicable policies. One field may have multiple applicable policies that must all be satisfied before a request can be processed. This policy annotation is used to generate the overall policy that will be used for automatic runtime policy enforcement and documentation generation.

func (FieldPolicyOutput) ElementType added in v0.32.0

func (FieldPolicyOutput) ElementType() reflect.Type

func (FieldPolicyOutput) ResourcePermission added in v0.32.0

func (o FieldPolicyOutput) ResourcePermission() pulumi.StringPtrOutput

Specifies the required permission(s) for the resource referred to by the field. It requires the field contains a valid resource reference, and the request must pass the permission checks to proceed. For example, "resourcemanager.projects.get".

func (FieldPolicyOutput) ResourceType added in v0.32.0

func (o FieldPolicyOutput) ResourceType() pulumi.StringPtrOutput

Specifies the resource type for the resource referred to by the field.

func (FieldPolicyOutput) Selector added in v0.32.0

Selects one or more request or response message fields to apply this `FieldPolicy`. When a `FieldPolicy` is used in proto annotation, the selector must be left as empty. The service config generator will automatically fill the correct value. When a `FieldPolicy` is used in service config, the selector must be a comma-separated string with valid request or response field paths, such as "foo.bar" or "foo.bar,foo.baz".

func (FieldPolicyOutput) ToFieldPolicyOutput added in v0.32.0

func (o FieldPolicyOutput) ToFieldPolicyOutput() FieldPolicyOutput

func (FieldPolicyOutput) ToFieldPolicyOutputWithContext added in v0.32.0

func (o FieldPolicyOutput) ToFieldPolicyOutputWithContext(ctx context.Context) FieldPolicyOutput

type FieldPolicyResponse added in v0.32.0

type FieldPolicyResponse struct {
	// Specifies the required permission(s) for the resource referred to by the field. It requires the field contains a valid resource reference, and the request must pass the permission checks to proceed. For example, "resourcemanager.projects.get".
	ResourcePermission string `pulumi:"resourcePermission"`
	// Specifies the resource type for the resource referred to by the field.
	ResourceType string `pulumi:"resourceType"`
	// Selects one or more request or response message fields to apply this `FieldPolicy`. When a `FieldPolicy` is used in proto annotation, the selector must be left as empty. The service config generator will automatically fill the correct value. When a `FieldPolicy` is used in service config, the selector must be a comma-separated string with valid request or response field paths, such as "foo.bar" or "foo.bar,foo.baz".
	Selector string `pulumi:"selector"`
}

Google API Policy Annotation This message defines a simple API policy annotation that can be used to annotate API request and response message fields with applicable policies. One field may have multiple applicable policies that must all be satisfied before a request can be processed. This policy annotation is used to generate the overall policy that will be used for automatic runtime policy enforcement and documentation generation.

type FieldPolicyResponseArrayOutput added in v0.32.0

type FieldPolicyResponseArrayOutput struct{ *pulumi.OutputState }

func (FieldPolicyResponseArrayOutput) ElementType added in v0.32.0

func (FieldPolicyResponseArrayOutput) Index added in v0.32.0

func (FieldPolicyResponseArrayOutput) ToFieldPolicyResponseArrayOutput added in v0.32.0

func (o FieldPolicyResponseArrayOutput) ToFieldPolicyResponseArrayOutput() FieldPolicyResponseArrayOutput

func (FieldPolicyResponseArrayOutput) ToFieldPolicyResponseArrayOutputWithContext added in v0.32.0

func (o FieldPolicyResponseArrayOutput) ToFieldPolicyResponseArrayOutputWithContext(ctx context.Context) FieldPolicyResponseArrayOutput

type FieldPolicyResponseOutput added in v0.32.0

type FieldPolicyResponseOutput struct{ *pulumi.OutputState }

Google API Policy Annotation This message defines a simple API policy annotation that can be used to annotate API request and response message fields with applicable policies. One field may have multiple applicable policies that must all be satisfied before a request can be processed. This policy annotation is used to generate the overall policy that will be used for automatic runtime policy enforcement and documentation generation.

func (FieldPolicyResponseOutput) ElementType added in v0.32.0

func (FieldPolicyResponseOutput) ElementType() reflect.Type

func (FieldPolicyResponseOutput) ResourcePermission added in v0.32.0

func (o FieldPolicyResponseOutput) ResourcePermission() pulumi.StringOutput

Specifies the required permission(s) for the resource referred to by the field. It requires the field contains a valid resource reference, and the request must pass the permission checks to proceed. For example, "resourcemanager.projects.get".

func (FieldPolicyResponseOutput) ResourceType added in v0.32.0

Specifies the resource type for the resource referred to by the field.

func (FieldPolicyResponseOutput) Selector added in v0.32.0

Selects one or more request or response message fields to apply this `FieldPolicy`. When a `FieldPolicy` is used in proto annotation, the selector must be left as empty. The service config generator will automatically fill the correct value. When a `FieldPolicy` is used in service config, the selector must be a comma-separated string with valid request or response field paths, such as "foo.bar" or "foo.bar,foo.baz".

func (FieldPolicyResponseOutput) ToFieldPolicyResponseOutput added in v0.32.0

func (o FieldPolicyResponseOutput) ToFieldPolicyResponseOutput() FieldPolicyResponseOutput

func (FieldPolicyResponseOutput) ToFieldPolicyResponseOutputWithContext added in v0.32.0

func (o FieldPolicyResponseOutput) ToFieldPolicyResponseOutputWithContext(ctx context.Context) FieldPolicyResponseOutput

type FieldResponse

type FieldResponse struct {
	// The field cardinality.
	Cardinality string `pulumi:"cardinality"`
	// The string value of the default value of this field. Proto2 syntax only.
	DefaultValue string `pulumi:"defaultValue"`
	// The field JSON name.
	JsonName string `pulumi:"jsonName"`
	// The field type.
	Kind string `pulumi:"kind"`
	// The field name.
	Name string `pulumi:"name"`
	// The field number.
	Number int `pulumi:"number"`
	// The index of the field type in `Type.oneofs`, for message or enumeration types. The first type has index 1; zero means the type is not in the list.
	OneofIndex int `pulumi:"oneofIndex"`
	// The protocol buffer options.
	Options []OptionResponse `pulumi:"options"`
	// Whether to use alternative packed wire representation.
	Packed bool `pulumi:"packed"`
	// The field type URL, without the scheme, for message or enumeration types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
	TypeUrl string `pulumi:"typeUrl"`
}

A single field of a message type.

type FieldResponseArrayOutput

type FieldResponseArrayOutput struct{ *pulumi.OutputState }

func (FieldResponseArrayOutput) ElementType

func (FieldResponseArrayOutput) ElementType() reflect.Type

func (FieldResponseArrayOutput) Index

func (FieldResponseArrayOutput) ToFieldResponseArrayOutput

func (o FieldResponseArrayOutput) ToFieldResponseArrayOutput() FieldResponseArrayOutput

func (FieldResponseArrayOutput) ToFieldResponseArrayOutputWithContext

func (o FieldResponseArrayOutput) ToFieldResponseArrayOutputWithContext(ctx context.Context) FieldResponseArrayOutput

type FieldResponseOutput

type FieldResponseOutput struct{ *pulumi.OutputState }

A single field of a message type.

func (FieldResponseOutput) Cardinality

func (o FieldResponseOutput) Cardinality() pulumi.StringOutput

The field cardinality.

func (FieldResponseOutput) DefaultValue

func (o FieldResponseOutput) DefaultValue() pulumi.StringOutput

The string value of the default value of this field. Proto2 syntax only.

func (FieldResponseOutput) ElementType

func (FieldResponseOutput) ElementType() reflect.Type

func (FieldResponseOutput) JsonName

The field JSON name.

func (FieldResponseOutput) Kind

The field type.

func (FieldResponseOutput) Name

The field name.

func (FieldResponseOutput) Number

The field number.

func (FieldResponseOutput) OneofIndex

func (o FieldResponseOutput) OneofIndex() pulumi.IntOutput

The index of the field type in `Type.oneofs`, for message or enumeration types. The first type has index 1; zero means the type is not in the list.

func (FieldResponseOutput) Options

The protocol buffer options.

func (FieldResponseOutput) Packed

Whether to use alternative packed wire representation.

func (FieldResponseOutput) ToFieldResponseOutput

func (o FieldResponseOutput) ToFieldResponseOutput() FieldResponseOutput

func (FieldResponseOutput) ToFieldResponseOutputWithContext

func (o FieldResponseOutput) ToFieldResponseOutputWithContext(ctx context.Context) FieldResponseOutput

func (FieldResponseOutput) TypeUrl

The field type URL, without the scheme, for message or enumeration types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.

type GoSettings added in v0.28.0

type GoSettings struct {
	// Some settings.
	Common *CommonLanguageSettings `pulumi:"common"`
}

Settings for Go client libraries.

type GoSettingsArgs added in v0.28.0

type GoSettingsArgs struct {
	// Some settings.
	Common CommonLanguageSettingsPtrInput `pulumi:"common"`
}

Settings for Go client libraries.

func (GoSettingsArgs) ElementType added in v0.28.0

func (GoSettingsArgs) ElementType() reflect.Type

func (GoSettingsArgs) ToGoSettingsOutput added in v0.28.0

func (i GoSettingsArgs) ToGoSettingsOutput() GoSettingsOutput

func (GoSettingsArgs) ToGoSettingsOutputWithContext added in v0.28.0

func (i GoSettingsArgs) ToGoSettingsOutputWithContext(ctx context.Context) GoSettingsOutput

func (GoSettingsArgs) ToGoSettingsPtrOutput added in v0.28.0

func (i GoSettingsArgs) ToGoSettingsPtrOutput() GoSettingsPtrOutput

func (GoSettingsArgs) ToGoSettingsPtrOutputWithContext added in v0.28.0

func (i GoSettingsArgs) ToGoSettingsPtrOutputWithContext(ctx context.Context) GoSettingsPtrOutput

type GoSettingsInput added in v0.28.0

type GoSettingsInput interface {
	pulumi.Input

	ToGoSettingsOutput() GoSettingsOutput
	ToGoSettingsOutputWithContext(context.Context) GoSettingsOutput
}

GoSettingsInput is an input type that accepts GoSettingsArgs and GoSettingsOutput values. You can construct a concrete instance of `GoSettingsInput` via:

GoSettingsArgs{...}

type GoSettingsOutput added in v0.28.0

type GoSettingsOutput struct{ *pulumi.OutputState }

Settings for Go client libraries.

func (GoSettingsOutput) Common added in v0.28.0

Some settings.

func (GoSettingsOutput) ElementType added in v0.28.0

func (GoSettingsOutput) ElementType() reflect.Type

func (GoSettingsOutput) ToGoSettingsOutput added in v0.28.0

func (o GoSettingsOutput) ToGoSettingsOutput() GoSettingsOutput

func (GoSettingsOutput) ToGoSettingsOutputWithContext added in v0.28.0

func (o GoSettingsOutput) ToGoSettingsOutputWithContext(ctx context.Context) GoSettingsOutput

func (GoSettingsOutput) ToGoSettingsPtrOutput added in v0.28.0

func (o GoSettingsOutput) ToGoSettingsPtrOutput() GoSettingsPtrOutput

func (GoSettingsOutput) ToGoSettingsPtrOutputWithContext added in v0.28.0

func (o GoSettingsOutput) ToGoSettingsPtrOutputWithContext(ctx context.Context) GoSettingsPtrOutput

type GoSettingsPtrInput added in v0.28.0

type GoSettingsPtrInput interface {
	pulumi.Input

	ToGoSettingsPtrOutput() GoSettingsPtrOutput
	ToGoSettingsPtrOutputWithContext(context.Context) GoSettingsPtrOutput
}

GoSettingsPtrInput is an input type that accepts GoSettingsArgs, GoSettingsPtr and GoSettingsPtrOutput values. You can construct a concrete instance of `GoSettingsPtrInput` via:

        GoSettingsArgs{...}

or:

        nil

func GoSettingsPtr added in v0.28.0

func GoSettingsPtr(v *GoSettingsArgs) GoSettingsPtrInput

type GoSettingsPtrOutput added in v0.28.0

type GoSettingsPtrOutput struct{ *pulumi.OutputState }

func (GoSettingsPtrOutput) Common added in v0.28.0

Some settings.

func (GoSettingsPtrOutput) Elem added in v0.28.0

func (GoSettingsPtrOutput) ElementType added in v0.28.0

func (GoSettingsPtrOutput) ElementType() reflect.Type

func (GoSettingsPtrOutput) ToGoSettingsPtrOutput added in v0.28.0

func (o GoSettingsPtrOutput) ToGoSettingsPtrOutput() GoSettingsPtrOutput

func (GoSettingsPtrOutput) ToGoSettingsPtrOutputWithContext added in v0.28.0

func (o GoSettingsPtrOutput) ToGoSettingsPtrOutputWithContext(ctx context.Context) GoSettingsPtrOutput

type GoSettingsResponse added in v0.28.0

type GoSettingsResponse struct {
	// Some settings.
	Common CommonLanguageSettingsResponse `pulumi:"common"`
}

Settings for Go client libraries.

type GoSettingsResponseOutput added in v0.28.0

type GoSettingsResponseOutput struct{ *pulumi.OutputState }

Settings for Go client libraries.

func (GoSettingsResponseOutput) Common added in v0.28.0

Some settings.

func (GoSettingsResponseOutput) ElementType added in v0.28.0

func (GoSettingsResponseOutput) ElementType() reflect.Type

func (GoSettingsResponseOutput) ToGoSettingsResponseOutput added in v0.28.0

func (o GoSettingsResponseOutput) ToGoSettingsResponseOutput() GoSettingsResponseOutput

func (GoSettingsResponseOutput) ToGoSettingsResponseOutputWithContext added in v0.28.0

func (o GoSettingsResponseOutput) ToGoSettingsResponseOutputWithContext(ctx context.Context) GoSettingsResponseOutput

type Http

type Http struct {
	// When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default behavior is to not decode RFC 6570 reserved characters in multi segment matches.
	FullyDecodeReservedExpansion *bool `pulumi:"fullyDecodeReservedExpansion"`
	// A list of HTTP configuration rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order.
	Rules []HttpRule `pulumi:"rules"`
}

Defines the HTTP configuration for an API service. It contains a list of HttpRule, each specifying the mapping of an RPC method to one or more HTTP REST API methods.

type HttpArgs

type HttpArgs struct {
	// When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default behavior is to not decode RFC 6570 reserved characters in multi segment matches.
	FullyDecodeReservedExpansion pulumi.BoolPtrInput `pulumi:"fullyDecodeReservedExpansion"`
	// A list of HTTP configuration rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order.
	Rules HttpRuleArrayInput `pulumi:"rules"`
}

Defines the HTTP configuration for an API service. It contains a list of HttpRule, each specifying the mapping of an RPC method to one or more HTTP REST API methods.

func (HttpArgs) ElementType

func (HttpArgs) ElementType() reflect.Type

func (HttpArgs) ToHttpOutput

func (i HttpArgs) ToHttpOutput() HttpOutput

func (HttpArgs) ToHttpOutputWithContext

func (i HttpArgs) ToHttpOutputWithContext(ctx context.Context) HttpOutput

func (HttpArgs) ToHttpPtrOutput

func (i HttpArgs) ToHttpPtrOutput() HttpPtrOutput

func (HttpArgs) ToHttpPtrOutputWithContext

func (i HttpArgs) ToHttpPtrOutputWithContext(ctx context.Context) HttpPtrOutput

type HttpInput

type HttpInput interface {
	pulumi.Input

	ToHttpOutput() HttpOutput
	ToHttpOutputWithContext(context.Context) HttpOutput
}

HttpInput is an input type that accepts HttpArgs and HttpOutput values. You can construct a concrete instance of `HttpInput` via:

HttpArgs{...}

type HttpOutput

type HttpOutput struct{ *pulumi.OutputState }

Defines the HTTP configuration for an API service. It contains a list of HttpRule, each specifying the mapping of an RPC method to one or more HTTP REST API methods.

func (HttpOutput) ElementType

func (HttpOutput) ElementType() reflect.Type

func (HttpOutput) FullyDecodeReservedExpansion

func (o HttpOutput) FullyDecodeReservedExpansion() pulumi.BoolPtrOutput

When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default behavior is to not decode RFC 6570 reserved characters in multi segment matches.

func (HttpOutput) Rules

func (o HttpOutput) Rules() HttpRuleArrayOutput

A list of HTTP configuration rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order.

func (HttpOutput) ToHttpOutput

func (o HttpOutput) ToHttpOutput() HttpOutput

func (HttpOutput) ToHttpOutputWithContext

func (o HttpOutput) ToHttpOutputWithContext(ctx context.Context) HttpOutput

func (HttpOutput) ToHttpPtrOutput

func (o HttpOutput) ToHttpPtrOutput() HttpPtrOutput

func (HttpOutput) ToHttpPtrOutputWithContext

func (o HttpOutput) ToHttpPtrOutputWithContext(ctx context.Context) HttpPtrOutput

type HttpPtrInput

type HttpPtrInput interface {
	pulumi.Input

	ToHttpPtrOutput() HttpPtrOutput
	ToHttpPtrOutputWithContext(context.Context) HttpPtrOutput
}

HttpPtrInput is an input type that accepts HttpArgs, HttpPtr and HttpPtrOutput values. You can construct a concrete instance of `HttpPtrInput` via:

        HttpArgs{...}

or:

        nil

func HttpPtr

func HttpPtr(v *HttpArgs) HttpPtrInput

type HttpPtrOutput

type HttpPtrOutput struct{ *pulumi.OutputState }

func (HttpPtrOutput) Elem

func (o HttpPtrOutput) Elem() HttpOutput

func (HttpPtrOutput) ElementType

func (HttpPtrOutput) ElementType() reflect.Type

func (HttpPtrOutput) FullyDecodeReservedExpansion

func (o HttpPtrOutput) FullyDecodeReservedExpansion() pulumi.BoolPtrOutput

When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default behavior is to not decode RFC 6570 reserved characters in multi segment matches.

func (HttpPtrOutput) Rules

A list of HTTP configuration rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order.

func (HttpPtrOutput) ToHttpPtrOutput

func (o HttpPtrOutput) ToHttpPtrOutput() HttpPtrOutput

func (HttpPtrOutput) ToHttpPtrOutputWithContext

func (o HttpPtrOutput) ToHttpPtrOutputWithContext(ctx context.Context) HttpPtrOutput

type HttpResponse

type HttpResponse struct {
	// When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default behavior is to not decode RFC 6570 reserved characters in multi segment matches.
	FullyDecodeReservedExpansion bool `pulumi:"fullyDecodeReservedExpansion"`
	// A list of HTTP configuration rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order.
	Rules []HttpRuleResponse `pulumi:"rules"`
}

Defines the HTTP configuration for an API service. It contains a list of HttpRule, each specifying the mapping of an RPC method to one or more HTTP REST API methods.

type HttpResponseOutput

type HttpResponseOutput struct{ *pulumi.OutputState }

Defines the HTTP configuration for an API service. It contains a list of HttpRule, each specifying the mapping of an RPC method to one or more HTTP REST API methods.

func (HttpResponseOutput) ElementType

func (HttpResponseOutput) ElementType() reflect.Type

func (HttpResponseOutput) FullyDecodeReservedExpansion

func (o HttpResponseOutput) FullyDecodeReservedExpansion() pulumi.BoolOutput

When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default behavior is to not decode RFC 6570 reserved characters in multi segment matches.

func (HttpResponseOutput) Rules

A list of HTTP configuration rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order.

func (HttpResponseOutput) ToHttpResponseOutput

func (o HttpResponseOutput) ToHttpResponseOutput() HttpResponseOutput

func (HttpResponseOutput) ToHttpResponseOutputWithContext

func (o HttpResponseOutput) ToHttpResponseOutputWithContext(ctx context.Context) HttpResponseOutput

type HttpRule

type HttpRule struct {
	// Additional HTTP bindings for the selector. Nested bindings must not contain an `additional_bindings` field themselves (that is, the nesting may only be one level deep).
	AdditionalBindings []HttpRule `pulumi:"additionalBindings"`
	// The name of the request field whose value is mapped to the HTTP request body, or `*` for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type.
	Body *string `pulumi:"body"`
	// The custom pattern is used for specifying an HTTP method that is not included in the `pattern` field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients.
	Custom *CustomHttpPattern `pulumi:"custom"`
	// Maps to HTTP DELETE. Used for deleting a resource.
	Delete *string `pulumi:"delete"`
	// Maps to HTTP GET. Used for listing and getting information about resources.
	Get *string `pulumi:"get"`
	// Maps to HTTP PATCH. Used for updating a resource.
	Patch *string `pulumi:"patch"`
	// Maps to HTTP POST. Used for creating a resource or performing an action.
	Post *string `pulumi:"post"`
	// Maps to HTTP PUT. Used for replacing a resource.
	Put *string `pulumi:"put"`
	// Optional. The name of the response field whose value is mapped to the HTTP response body. When omitted, the entire response message will be used as the HTTP response body. NOTE: The referred field must be present at the top-level of the response message type.
	ResponseBody *string `pulumi:"responseBody"`
	// Selects a method to which this rule applies. Refer to selector for syntax details.
	Selector *string `pulumi:"selector"`
}

gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/123456` | `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A&param=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "*" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id}" additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: HTTP | gRPC -----|----- `GET /v1/messages/123456` | `GetMessage(message_id: "123456")` `GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id: "123456")` ## Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. ### Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. ## Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example: http: rules: # Selects a gRPC method and applies HttpRule to it. - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} ## Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.">¶

type HttpRuleArgs

type HttpRuleArgs struct {
	// Additional HTTP bindings for the selector. Nested bindings must not contain an `additional_bindings` field themselves (that is, the nesting may only be one level deep).
	AdditionalBindings HttpRuleArrayInput `pulumi:"additionalBindings"`
	// The name of the request field whose value is mapped to the HTTP request body, or `*` for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type.
	Body pulumi.StringPtrInput `pulumi:"body"`
	// The custom pattern is used for specifying an HTTP method that is not included in the `pattern` field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients.
	Custom CustomHttpPatternPtrInput `pulumi:"custom"`
	// Maps to HTTP DELETE. Used for deleting a resource.
	Delete pulumi.StringPtrInput `pulumi:"delete"`
	// Maps to HTTP GET. Used for listing and getting information about resources.
	Get pulumi.StringPtrInput `pulumi:"get"`
	// Maps to HTTP PATCH. Used for updating a resource.
	Patch pulumi.StringPtrInput `pulumi:"patch"`
	// Maps to HTTP POST. Used for creating a resource or performing an action.
	Post pulumi.StringPtrInput `pulumi:"post"`
	// Maps to HTTP PUT. Used for replacing a resource.
	Put pulumi.StringPtrInput `pulumi:"put"`
	// Optional. The name of the response field whose value is mapped to the HTTP response body. When omitted, the entire response message will be used as the HTTP response body. NOTE: The referred field must be present at the top-level of the response message type.
	ResponseBody pulumi.StringPtrInput `pulumi:"responseBody"`
	// Selects a method to which this rule applies. Refer to selector for syntax details.
	Selector pulumi.StringPtrInput `pulumi:"selector"`
}

gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/123456` | `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A&param=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "*" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id}" additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: HTTP | gRPC -----|----- `GET /v1/messages/123456` | `GetMessage(message_id: "123456")` `GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id: "123456")` ## Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. ### Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. ## Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example: http: rules: # Selects a gRPC method and applies HttpRule to it. - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} ## Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.">¶

func (HttpRuleArgs) ElementType

func (HttpRuleArgs) ElementType() reflect.Type

func (HttpRuleArgs) ToHttpRuleOutput

func (i HttpRuleArgs) ToHttpRuleOutput() HttpRuleOutput

func (HttpRuleArgs) ToHttpRuleOutputWithContext

func (i HttpRuleArgs) ToHttpRuleOutputWithContext(ctx context.Context) HttpRuleOutput

type HttpRuleArray

type HttpRuleArray []HttpRuleInput

func (HttpRuleArray) ElementType

func (HttpRuleArray) ElementType() reflect.Type

func (HttpRuleArray) ToHttpRuleArrayOutput

func (i HttpRuleArray) ToHttpRuleArrayOutput() HttpRuleArrayOutput

func (HttpRuleArray) ToHttpRuleArrayOutputWithContext

func (i HttpRuleArray) ToHttpRuleArrayOutputWithContext(ctx context.Context) HttpRuleArrayOutput

type HttpRuleArrayInput

type HttpRuleArrayInput interface {
	pulumi.Input

	ToHttpRuleArrayOutput() HttpRuleArrayOutput
	ToHttpRuleArrayOutputWithContext(context.Context) HttpRuleArrayOutput
}

HttpRuleArrayInput is an input type that accepts HttpRuleArray and HttpRuleArrayOutput values. You can construct a concrete instance of `HttpRuleArrayInput` via:

HttpRuleArray{ HttpRuleArgs{...} }

type HttpRuleArrayOutput

type HttpRuleArrayOutput struct{ *pulumi.OutputState }

func (HttpRuleArrayOutput) ElementType

func (HttpRuleArrayOutput) ElementType() reflect.Type

func (HttpRuleArrayOutput) Index

func (HttpRuleArrayOutput) ToHttpRuleArrayOutput

func (o HttpRuleArrayOutput) ToHttpRuleArrayOutput() HttpRuleArrayOutput

func (HttpRuleArrayOutput) ToHttpRuleArrayOutputWithContext

func (o HttpRuleArrayOutput) ToHttpRuleArrayOutputWithContext(ctx context.Context) HttpRuleArrayOutput

type HttpRuleInput

type HttpRuleInput interface {
	pulumi.Input

	ToHttpRuleOutput() HttpRuleOutput
	ToHttpRuleOutputWithContext(context.Context) HttpRuleOutput
}

HttpRuleInput is an input type that accepts HttpRuleArgs and HttpRuleOutput values. You can construct a concrete instance of `HttpRuleInput` via:

HttpRuleArgs{...}

type HttpRuleOutput

type HttpRuleOutput struct{ *pulumi.OutputState }

gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/123456` | `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A&param=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "*" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id}" additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: HTTP | gRPC -----|----- `GET /v1/messages/123456` | `GetMessage(message_id: "123456")` `GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id: "123456")` ## Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. ### Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. ## Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example: http: rules: # Selects a gRPC method and applies HttpRule to it. - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} ## Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.">¶

func (HttpRuleOutput) AdditionalBindings

func (o HttpRuleOutput) AdditionalBindings() HttpRuleArrayOutput

Additional HTTP bindings for the selector. Nested bindings must not contain an `additional_bindings` field themselves (that is, the nesting may only be one level deep).

func (HttpRuleOutput) Body

The name of the request field whose value is mapped to the HTTP request body, or `*` for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type.

func (HttpRuleOutput) Custom

The custom pattern is used for specifying an HTTP method that is not included in the `pattern` field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients.

func (HttpRuleOutput) Delete

Maps to HTTP DELETE. Used for deleting a resource.

func (HttpRuleOutput) ElementType

func (HttpRuleOutput) ElementType() reflect.Type

func (HttpRuleOutput) Get

Maps to HTTP GET. Used for listing and getting information about resources.

func (HttpRuleOutput) Patch

Maps to HTTP PATCH. Used for updating a resource.

func (HttpRuleOutput) Post

Maps to HTTP POST. Used for creating a resource or performing an action.

func (HttpRuleOutput) Put

Maps to HTTP PUT. Used for replacing a resource.

func (HttpRuleOutput) ResponseBody

func (o HttpRuleOutput) ResponseBody() pulumi.StringPtrOutput

Optional. The name of the response field whose value is mapped to the HTTP response body. When omitted, the entire response message will be used as the HTTP response body. NOTE: The referred field must be present at the top-level of the response message type.

func (HttpRuleOutput) Selector

func (o HttpRuleOutput) Selector() pulumi.StringPtrOutput

Selects a method to which this rule applies. Refer to selector for syntax details.

func (HttpRuleOutput) ToHttpRuleOutput

func (o HttpRuleOutput) ToHttpRuleOutput() HttpRuleOutput

func (HttpRuleOutput) ToHttpRuleOutputWithContext

func (o HttpRuleOutput) ToHttpRuleOutputWithContext(ctx context.Context) HttpRuleOutput

type HttpRuleResponse

type HttpRuleResponse struct {
	// Additional HTTP bindings for the selector. Nested bindings must not contain an `additional_bindings` field themselves (that is, the nesting may only be one level deep).
	AdditionalBindings []HttpRuleResponse `pulumi:"additionalBindings"`
	// The name of the request field whose value is mapped to the HTTP request body, or `*` for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type.
	Body string `pulumi:"body"`
	// The custom pattern is used for specifying an HTTP method that is not included in the `pattern` field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients.
	Custom CustomHttpPatternResponse `pulumi:"custom"`
	// Maps to HTTP DELETE. Used for deleting a resource.
	Delete string `pulumi:"delete"`
	// Maps to HTTP GET. Used for listing and getting information about resources.
	Get string `pulumi:"get"`
	// Maps to HTTP PATCH. Used for updating a resource.
	Patch string `pulumi:"patch"`
	// Maps to HTTP POST. Used for creating a resource or performing an action.
	Post string `pulumi:"post"`
	// Maps to HTTP PUT. Used for replacing a resource.
	Put string `pulumi:"put"`
	// Optional. The name of the response field whose value is mapped to the HTTP response body. When omitted, the entire response message will be used as the HTTP response body. NOTE: The referred field must be present at the top-level of the response message type.
	ResponseBody string `pulumi:"responseBody"`
	// Selects a method to which this rule applies. Refer to selector for syntax details.
	Selector string `pulumi:"selector"`
}

gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/123456` | `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A&param=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "*" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id}" additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: HTTP | gRPC -----|----- `GET /v1/messages/123456` | `GetMessage(message_id: "123456")` `GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id: "123456")` ## Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. ### Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. ## Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example: http: rules: # Selects a gRPC method and applies HttpRule to it. - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} ## Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.">¶

type HttpRuleResponseArrayOutput

type HttpRuleResponseArrayOutput struct{ *pulumi.OutputState }

func (HttpRuleResponseArrayOutput) ElementType

func (HttpRuleResponseArrayOutput) Index

func (HttpRuleResponseArrayOutput) ToHttpRuleResponseArrayOutput

func (o HttpRuleResponseArrayOutput) ToHttpRuleResponseArrayOutput() HttpRuleResponseArrayOutput

func (HttpRuleResponseArrayOutput) ToHttpRuleResponseArrayOutputWithContext

func (o HttpRuleResponseArrayOutput) ToHttpRuleResponseArrayOutputWithContext(ctx context.Context) HttpRuleResponseArrayOutput

type HttpRuleResponseOutput

type HttpRuleResponseOutput struct{ *pulumi.OutputState }

gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/123456` | `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A&param=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "*" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id}" additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: HTTP | gRPC -----|----- `GET /v1/messages/123456` | `GetMessage(message_id: "123456")` `GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id: "123456")` ## Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. ### Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. ## Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example: http: rules: # Selects a gRPC method and applies HttpRule to it. - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} ## Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.">¶

func (HttpRuleResponseOutput) AdditionalBindings

func (o HttpRuleResponseOutput) AdditionalBindings() HttpRuleResponseArrayOutput

Additional HTTP bindings for the selector. Nested bindings must not contain an `additional_bindings` field themselves (that is, the nesting may only be one level deep).

func (HttpRuleResponseOutput) Body

The name of the request field whose value is mapped to the HTTP request body, or `*` for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type.

func (HttpRuleResponseOutput) Custom

The custom pattern is used for specifying an HTTP method that is not included in the `pattern` field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients.

func (HttpRuleResponseOutput) Delete

Maps to HTTP DELETE. Used for deleting a resource.

func (HttpRuleResponseOutput) ElementType

func (HttpRuleResponseOutput) ElementType() reflect.Type

func (HttpRuleResponseOutput) Get

Maps to HTTP GET. Used for listing and getting information about resources.

func (HttpRuleResponseOutput) Patch

Maps to HTTP PATCH. Used for updating a resource.

func (HttpRuleResponseOutput) Post

Maps to HTTP POST. Used for creating a resource or performing an action.

func (HttpRuleResponseOutput) Put

Maps to HTTP PUT. Used for replacing a resource.

func (HttpRuleResponseOutput) ResponseBody

func (o HttpRuleResponseOutput) ResponseBody() pulumi.StringOutput

Optional. The name of the response field whose value is mapped to the HTTP response body. When omitted, the entire response message will be used as the HTTP response body. NOTE: The referred field must be present at the top-level of the response message type.

func (HttpRuleResponseOutput) Selector

Selects a method to which this rule applies. Refer to selector for syntax details.

func (HttpRuleResponseOutput) ToHttpRuleResponseOutput

func (o HttpRuleResponseOutput) ToHttpRuleResponseOutput() HttpRuleResponseOutput

func (HttpRuleResponseOutput) ToHttpRuleResponseOutputWithContext

func (o HttpRuleResponseOutput) ToHttpRuleResponseOutputWithContext(ctx context.Context) HttpRuleResponseOutput

type JavaSettings added in v0.28.0

type JavaSettings struct {
	// Some settings.
	Common *CommonLanguageSettings `pulumi:"common"`
	// The package name to use in Java. Clobbers the java_package option set in the protobuf. This should be used **only** by APIs who have already set the language_settings.java.package_name" field in gapic.yaml. API teams should use the protobuf java_package option where possible. Example of a YAML configuration:: publishing: java_settings: library_package: com.google.cloud.pubsub.v1
	LibraryPackage *string `pulumi:"libraryPackage"`
	// Configure the Java class name to use instead of the service's for its corresponding generated GAPIC client. Keys are fully-qualified service names as they appear in the protobuf (including the full the language_settings.java.interface_names" field in gapic.yaml. API teams should otherwise use the service name as it appears in the protobuf. Example of a YAML configuration:: publishing: java_settings: service_class_names: - google.pubsub.v1.Publisher: TopicAdmin - google.pubsub.v1.Subscriber: SubscriptionAdmin
	ServiceClassNames map[string]string `pulumi:"serviceClassNames"`
}

Settings for Java client libraries.

type JavaSettingsArgs added in v0.28.0

type JavaSettingsArgs struct {
	// Some settings.
	Common CommonLanguageSettingsPtrInput `pulumi:"common"`
	// The package name to use in Java. Clobbers the java_package option set in the protobuf. This should be used **only** by APIs who have already set the language_settings.java.package_name" field in gapic.yaml. API teams should use the protobuf java_package option where possible. Example of a YAML configuration:: publishing: java_settings: library_package: com.google.cloud.pubsub.v1
	LibraryPackage pulumi.StringPtrInput `pulumi:"libraryPackage"`
	// Configure the Java class name to use instead of the service's for its corresponding generated GAPIC client. Keys are fully-qualified service names as they appear in the protobuf (including the full the language_settings.java.interface_names" field in gapic.yaml. API teams should otherwise use the service name as it appears in the protobuf. Example of a YAML configuration:: publishing: java_settings: service_class_names: - google.pubsub.v1.Publisher: TopicAdmin - google.pubsub.v1.Subscriber: SubscriptionAdmin
	ServiceClassNames pulumi.StringMapInput `pulumi:"serviceClassNames"`
}

Settings for Java client libraries.

func (JavaSettingsArgs) ElementType added in v0.28.0

func (JavaSettingsArgs) ElementType() reflect.Type

func (JavaSettingsArgs) ToJavaSettingsOutput added in v0.28.0

func (i JavaSettingsArgs) ToJavaSettingsOutput() JavaSettingsOutput

func (JavaSettingsArgs) ToJavaSettingsOutputWithContext added in v0.28.0

func (i JavaSettingsArgs) ToJavaSettingsOutputWithContext(ctx context.Context) JavaSettingsOutput

func (JavaSettingsArgs) ToJavaSettingsPtrOutput added in v0.28.0

func (i JavaSettingsArgs) ToJavaSettingsPtrOutput() JavaSettingsPtrOutput

func (JavaSettingsArgs) ToJavaSettingsPtrOutputWithContext added in v0.28.0

func (i JavaSettingsArgs) ToJavaSettingsPtrOutputWithContext(ctx context.Context) JavaSettingsPtrOutput

type JavaSettingsInput added in v0.28.0

type JavaSettingsInput interface {
	pulumi.Input

	ToJavaSettingsOutput() JavaSettingsOutput
	ToJavaSettingsOutputWithContext(context.Context) JavaSettingsOutput
}

JavaSettingsInput is an input type that accepts JavaSettingsArgs and JavaSettingsOutput values. You can construct a concrete instance of `JavaSettingsInput` via:

JavaSettingsArgs{...}

type JavaSettingsOutput added in v0.28.0

type JavaSettingsOutput struct{ *pulumi.OutputState }

Settings for Java client libraries.

func (JavaSettingsOutput) Common added in v0.28.0

Some settings.

func (JavaSettingsOutput) ElementType added in v0.28.0

func (JavaSettingsOutput) ElementType() reflect.Type

func (JavaSettingsOutput) LibraryPackage added in v0.28.0

func (o JavaSettingsOutput) LibraryPackage() pulumi.StringPtrOutput

The package name to use in Java. Clobbers the java_package option set in the protobuf. This should be used **only** by APIs who have already set the language_settings.java.package_name" field in gapic.yaml. API teams should use the protobuf java_package option where possible. Example of a YAML configuration:: publishing: java_settings: library_package: com.google.cloud.pubsub.v1

func (JavaSettingsOutput) ServiceClassNames added in v0.28.0

func (o JavaSettingsOutput) ServiceClassNames() pulumi.StringMapOutput

Configure the Java class name to use instead of the service's for its corresponding generated GAPIC client. Keys are fully-qualified service names as they appear in the protobuf (including the full the language_settings.java.interface_names" field in gapic.yaml. API teams should otherwise use the service name as it appears in the protobuf. Example of a YAML configuration:: publishing: java_settings: service_class_names: - google.pubsub.v1.Publisher: TopicAdmin - google.pubsub.v1.Subscriber: SubscriptionAdmin

func (JavaSettingsOutput) ToJavaSettingsOutput added in v0.28.0

func (o JavaSettingsOutput) ToJavaSettingsOutput() JavaSettingsOutput

func (JavaSettingsOutput) ToJavaSettingsOutputWithContext added in v0.28.0

func (o JavaSettingsOutput) ToJavaSettingsOutputWithContext(ctx context.Context) JavaSettingsOutput

func (JavaSettingsOutput) ToJavaSettingsPtrOutput added in v0.28.0

func (o JavaSettingsOutput) ToJavaSettingsPtrOutput() JavaSettingsPtrOutput

func (JavaSettingsOutput) ToJavaSettingsPtrOutputWithContext added in v0.28.0

func (o JavaSettingsOutput) ToJavaSettingsPtrOutputWithContext(ctx context.Context) JavaSettingsPtrOutput

type JavaSettingsPtrInput added in v0.28.0

type JavaSettingsPtrInput interface {
	pulumi.Input

	ToJavaSettingsPtrOutput() JavaSettingsPtrOutput
	ToJavaSettingsPtrOutputWithContext(context.Context) JavaSettingsPtrOutput
}

JavaSettingsPtrInput is an input type that accepts JavaSettingsArgs, JavaSettingsPtr and JavaSettingsPtrOutput values. You can construct a concrete instance of `JavaSettingsPtrInput` via:

        JavaSettingsArgs{...}

or:

        nil

func JavaSettingsPtr added in v0.28.0

func JavaSettingsPtr(v *JavaSettingsArgs) JavaSettingsPtrInput

type JavaSettingsPtrOutput added in v0.28.0

type JavaSettingsPtrOutput struct{ *pulumi.OutputState }

func (JavaSettingsPtrOutput) Common added in v0.28.0

Some settings.

func (JavaSettingsPtrOutput) Elem added in v0.28.0

func (JavaSettingsPtrOutput) ElementType added in v0.28.0

func (JavaSettingsPtrOutput) ElementType() reflect.Type

func (JavaSettingsPtrOutput) LibraryPackage added in v0.28.0

func (o JavaSettingsPtrOutput) LibraryPackage() pulumi.StringPtrOutput

The package name to use in Java. Clobbers the java_package option set in the protobuf. This should be used **only** by APIs who have already set the language_settings.java.package_name" field in gapic.yaml. API teams should use the protobuf java_package option where possible. Example of a YAML configuration:: publishing: java_settings: library_package: com.google.cloud.pubsub.v1

func (JavaSettingsPtrOutput) ServiceClassNames added in v0.28.0

func (o JavaSettingsPtrOutput) ServiceClassNames() pulumi.StringMapOutput

Configure the Java class name to use instead of the service's for its corresponding generated GAPIC client. Keys are fully-qualified service names as they appear in the protobuf (including the full the language_settings.java.interface_names" field in gapic.yaml. API teams should otherwise use the service name as it appears in the protobuf. Example of a YAML configuration:: publishing: java_settings: service_class_names: - google.pubsub.v1.Publisher: TopicAdmin - google.pubsub.v1.Subscriber: SubscriptionAdmin

func (JavaSettingsPtrOutput) ToJavaSettingsPtrOutput added in v0.28.0

func (o JavaSettingsPtrOutput) ToJavaSettingsPtrOutput() JavaSettingsPtrOutput

func (JavaSettingsPtrOutput) ToJavaSettingsPtrOutputWithContext added in v0.28.0

func (o JavaSettingsPtrOutput) ToJavaSettingsPtrOutputWithContext(ctx context.Context) JavaSettingsPtrOutput

type JavaSettingsResponse added in v0.28.0

type JavaSettingsResponse struct {
	// Some settings.
	Common CommonLanguageSettingsResponse `pulumi:"common"`
	// The package name to use in Java. Clobbers the java_package option set in the protobuf. This should be used **only** by APIs who have already set the language_settings.java.package_name" field in gapic.yaml. API teams should use the protobuf java_package option where possible. Example of a YAML configuration:: publishing: java_settings: library_package: com.google.cloud.pubsub.v1
	LibraryPackage string `pulumi:"libraryPackage"`
	// Configure the Java class name to use instead of the service's for its corresponding generated GAPIC client. Keys are fully-qualified service names as they appear in the protobuf (including the full the language_settings.java.interface_names" field in gapic.yaml. API teams should otherwise use the service name as it appears in the protobuf. Example of a YAML configuration:: publishing: java_settings: service_class_names: - google.pubsub.v1.Publisher: TopicAdmin - google.pubsub.v1.Subscriber: SubscriptionAdmin
	ServiceClassNames map[string]string `pulumi:"serviceClassNames"`
}

Settings for Java client libraries.

type JavaSettingsResponseOutput added in v0.28.0

type JavaSettingsResponseOutput struct{ *pulumi.OutputState }

Settings for Java client libraries.

func (JavaSettingsResponseOutput) Common added in v0.28.0

Some settings.

func (JavaSettingsResponseOutput) ElementType added in v0.28.0

func (JavaSettingsResponseOutput) ElementType() reflect.Type

func (JavaSettingsResponseOutput) LibraryPackage added in v0.28.0

func (o JavaSettingsResponseOutput) LibraryPackage() pulumi.StringOutput

The package name to use in Java. Clobbers the java_package option set in the protobuf. This should be used **only** by APIs who have already set the language_settings.java.package_name" field in gapic.yaml. API teams should use the protobuf java_package option where possible. Example of a YAML configuration:: publishing: java_settings: library_package: com.google.cloud.pubsub.v1

func (JavaSettingsResponseOutput) ServiceClassNames added in v0.28.0

func (o JavaSettingsResponseOutput) ServiceClassNames() pulumi.StringMapOutput

Configure the Java class name to use instead of the service's for its corresponding generated GAPIC client. Keys are fully-qualified service names as they appear in the protobuf (including the full the language_settings.java.interface_names" field in gapic.yaml. API teams should otherwise use the service name as it appears in the protobuf. Example of a YAML configuration:: publishing: java_settings: service_class_names: - google.pubsub.v1.Publisher: TopicAdmin - google.pubsub.v1.Subscriber: SubscriptionAdmin

func (JavaSettingsResponseOutput) ToJavaSettingsResponseOutput added in v0.28.0

func (o JavaSettingsResponseOutput) ToJavaSettingsResponseOutput() JavaSettingsResponseOutput

func (JavaSettingsResponseOutput) ToJavaSettingsResponseOutputWithContext added in v0.28.0

func (o JavaSettingsResponseOutput) ToJavaSettingsResponseOutputWithContext(ctx context.Context) JavaSettingsResponseOutput

type JwtLocation

type JwtLocation struct {
	// Specifies cookie name to extract JWT token.
	Cookie *string `pulumi:"cookie"`
	// Specifies HTTP header name to extract JWT token.
	Header *string `pulumi:"header"`
	// Specifies URL query parameter name to extract JWT token.
	Query *string `pulumi:"query"`
	// The value prefix. The value format is "value_prefix{token}" Only applies to "in" header type. Must be empty for "in" query type. If not empty, the header value has to match (case sensitive) this prefix. If not matched, JWT will not be extracted. If matched, JWT will be extracted after the prefix is removed. For example, for "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space at the end.
	ValuePrefix *string `pulumi:"valuePrefix"`
}

Specifies a location to extract JWT from an API request.

type JwtLocationArgs

type JwtLocationArgs struct {
	// Specifies cookie name to extract JWT token.
	Cookie pulumi.StringPtrInput `pulumi:"cookie"`
	// Specifies HTTP header name to extract JWT token.
	Header pulumi.StringPtrInput `pulumi:"header"`
	// Specifies URL query parameter name to extract JWT token.
	Query pulumi.StringPtrInput `pulumi:"query"`
	// The value prefix. The value format is "value_prefix{token}" Only applies to "in" header type. Must be empty for "in" query type. If not empty, the header value has to match (case sensitive) this prefix. If not matched, JWT will not be extracted. If matched, JWT will be extracted after the prefix is removed. For example, for "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space at the end.
	ValuePrefix pulumi.StringPtrInput `pulumi:"valuePrefix"`
}

Specifies a location to extract JWT from an API request.

func (JwtLocationArgs) ElementType

func (JwtLocationArgs) ElementType() reflect.Type

func (JwtLocationArgs) ToJwtLocationOutput

func (i JwtLocationArgs) ToJwtLocationOutput() JwtLocationOutput

func (JwtLocationArgs) ToJwtLocationOutputWithContext

func (i JwtLocationArgs) ToJwtLocationOutputWithContext(ctx context.Context) JwtLocationOutput

type JwtLocationArray

type JwtLocationArray []JwtLocationInput

func (JwtLocationArray) ElementType

func (JwtLocationArray) ElementType() reflect.Type

func (JwtLocationArray) ToJwtLocationArrayOutput

func (i JwtLocationArray) ToJwtLocationArrayOutput() JwtLocationArrayOutput

func (JwtLocationArray) ToJwtLocationArrayOutputWithContext

func (i JwtLocationArray) ToJwtLocationArrayOutputWithContext(ctx context.Context) JwtLocationArrayOutput

type JwtLocationArrayInput

type JwtLocationArrayInput interface {
	pulumi.Input

	ToJwtLocationArrayOutput() JwtLocationArrayOutput
	ToJwtLocationArrayOutputWithContext(context.Context) JwtLocationArrayOutput
}

JwtLocationArrayInput is an input type that accepts JwtLocationArray and JwtLocationArrayOutput values. You can construct a concrete instance of `JwtLocationArrayInput` via:

JwtLocationArray{ JwtLocationArgs{...} }

type JwtLocationArrayOutput

type JwtLocationArrayOutput struct{ *pulumi.OutputState }

func (JwtLocationArrayOutput) ElementType

func (JwtLocationArrayOutput) ElementType() reflect.Type

func (JwtLocationArrayOutput) Index

func (JwtLocationArrayOutput) ToJwtLocationArrayOutput

func (o JwtLocationArrayOutput) ToJwtLocationArrayOutput() JwtLocationArrayOutput

func (JwtLocationArrayOutput) ToJwtLocationArrayOutputWithContext

func (o JwtLocationArrayOutput) ToJwtLocationArrayOutputWithContext(ctx context.Context) JwtLocationArrayOutput

type JwtLocationInput

type JwtLocationInput interface {
	pulumi.Input

	ToJwtLocationOutput() JwtLocationOutput
	ToJwtLocationOutputWithContext(context.Context) JwtLocationOutput
}

JwtLocationInput is an input type that accepts JwtLocationArgs and JwtLocationOutput values. You can construct a concrete instance of `JwtLocationInput` via:

JwtLocationArgs{...}

type JwtLocationOutput

type JwtLocationOutput struct{ *pulumi.OutputState }

Specifies a location to extract JWT from an API request.

func (JwtLocationOutput) Cookie added in v0.18.1

Specifies cookie name to extract JWT token.

func (JwtLocationOutput) ElementType

func (JwtLocationOutput) ElementType() reflect.Type

func (JwtLocationOutput) Header

Specifies HTTP header name to extract JWT token.

func (JwtLocationOutput) Query

Specifies URL query parameter name to extract JWT token.

func (JwtLocationOutput) ToJwtLocationOutput

func (o JwtLocationOutput) ToJwtLocationOutput() JwtLocationOutput

func (JwtLocationOutput) ToJwtLocationOutputWithContext

func (o JwtLocationOutput) ToJwtLocationOutputWithContext(ctx context.Context) JwtLocationOutput

func (JwtLocationOutput) ValuePrefix

func (o JwtLocationOutput) ValuePrefix() pulumi.StringPtrOutput

The value prefix. The value format is "value_prefix{token}" Only applies to "in" header type. Must be empty for "in" query type. If not empty, the header value has to match (case sensitive) this prefix. If not matched, JWT will not be extracted. If matched, JWT will be extracted after the prefix is removed. For example, for "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space at the end.

type JwtLocationResponse

type JwtLocationResponse struct {
	// Specifies cookie name to extract JWT token.
	Cookie string `pulumi:"cookie"`
	// Specifies HTTP header name to extract JWT token.
	Header string `pulumi:"header"`
	// Specifies URL query parameter name to extract JWT token.
	Query string `pulumi:"query"`
	// The value prefix. The value format is "value_prefix{token}" Only applies to "in" header type. Must be empty for "in" query type. If not empty, the header value has to match (case sensitive) this prefix. If not matched, JWT will not be extracted. If matched, JWT will be extracted after the prefix is removed. For example, for "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space at the end.
	ValuePrefix string `pulumi:"valuePrefix"`
}

Specifies a location to extract JWT from an API request.

type JwtLocationResponseArrayOutput

type JwtLocationResponseArrayOutput struct{ *pulumi.OutputState }

func (JwtLocationResponseArrayOutput) ElementType

func (JwtLocationResponseArrayOutput) Index

func (JwtLocationResponseArrayOutput) ToJwtLocationResponseArrayOutput

func (o JwtLocationResponseArrayOutput) ToJwtLocationResponseArrayOutput() JwtLocationResponseArrayOutput

func (JwtLocationResponseArrayOutput) ToJwtLocationResponseArrayOutputWithContext

func (o JwtLocationResponseArrayOutput) ToJwtLocationResponseArrayOutputWithContext(ctx context.Context) JwtLocationResponseArrayOutput

type JwtLocationResponseOutput

type JwtLocationResponseOutput struct{ *pulumi.OutputState }

Specifies a location to extract JWT from an API request.

func (JwtLocationResponseOutput) Cookie added in v0.18.1

Specifies cookie name to extract JWT token.

func (JwtLocationResponseOutput) ElementType

func (JwtLocationResponseOutput) ElementType() reflect.Type

func (JwtLocationResponseOutput) Header

Specifies HTTP header name to extract JWT token.

func (JwtLocationResponseOutput) Query

Specifies URL query parameter name to extract JWT token.

func (JwtLocationResponseOutput) ToJwtLocationResponseOutput

func (o JwtLocationResponseOutput) ToJwtLocationResponseOutput() JwtLocationResponseOutput

func (JwtLocationResponseOutput) ToJwtLocationResponseOutputWithContext

func (o JwtLocationResponseOutput) ToJwtLocationResponseOutputWithContext(ctx context.Context) JwtLocationResponseOutput

func (JwtLocationResponseOutput) ValuePrefix

The value prefix. The value format is "value_prefix{token}" Only applies to "in" header type. Must be empty for "in" query type. If not empty, the header value has to match (case sensitive) this prefix. If not matched, JWT will not be extracted. If matched, JWT will be extracted after the prefix is removed. For example, for "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space at the end.

type LabelDescriptor

type LabelDescriptor struct {
	// A human-readable description for the label.
	Description *string `pulumi:"description"`
	// The label key.
	Key *string `pulumi:"key"`
	// The type of data that can be assigned to the label.
	ValueType *LabelDescriptorValueType `pulumi:"valueType"`
}

A description of a label.

type LabelDescriptorArgs

type LabelDescriptorArgs struct {
	// A human-readable description for the label.
	Description pulumi.StringPtrInput `pulumi:"description"`
	// The label key.
	Key pulumi.StringPtrInput `pulumi:"key"`
	// The type of data that can be assigned to the label.
	ValueType LabelDescriptorValueTypePtrInput `pulumi:"valueType"`
}

A description of a label.

func (LabelDescriptorArgs) ElementType

func (LabelDescriptorArgs) ElementType() reflect.Type

func (LabelDescriptorArgs) ToLabelDescriptorOutput

func (i LabelDescriptorArgs) ToLabelDescriptorOutput() LabelDescriptorOutput

func (LabelDescriptorArgs) ToLabelDescriptorOutputWithContext

func (i LabelDescriptorArgs) ToLabelDescriptorOutputWithContext(ctx context.Context) LabelDescriptorOutput

type LabelDescriptorArray

type LabelDescriptorArray []LabelDescriptorInput

func (LabelDescriptorArray) ElementType

func (LabelDescriptorArray) ElementType() reflect.Type

func (LabelDescriptorArray) ToLabelDescriptorArrayOutput

func (i LabelDescriptorArray) ToLabelDescriptorArrayOutput() LabelDescriptorArrayOutput

func (LabelDescriptorArray) ToLabelDescriptorArrayOutputWithContext

func (i LabelDescriptorArray) ToLabelDescriptorArrayOutputWithContext(ctx context.Context) LabelDescriptorArrayOutput

type LabelDescriptorArrayInput

type LabelDescriptorArrayInput interface {
	pulumi.Input

	ToLabelDescriptorArrayOutput() LabelDescriptorArrayOutput
	ToLabelDescriptorArrayOutputWithContext(context.Context) LabelDescriptorArrayOutput
}

LabelDescriptorArrayInput is an input type that accepts LabelDescriptorArray and LabelDescriptorArrayOutput values. You can construct a concrete instance of `LabelDescriptorArrayInput` via:

LabelDescriptorArray{ LabelDescriptorArgs{...} }

type LabelDescriptorArrayOutput

type LabelDescriptorArrayOutput struct{ *pulumi.OutputState }

func (LabelDescriptorArrayOutput) ElementType

func (LabelDescriptorArrayOutput) ElementType() reflect.Type

func (LabelDescriptorArrayOutput) Index

func (LabelDescriptorArrayOutput) ToLabelDescriptorArrayOutput

func (o LabelDescriptorArrayOutput) ToLabelDescriptorArrayOutput() LabelDescriptorArrayOutput

func (LabelDescriptorArrayOutput) ToLabelDescriptorArrayOutputWithContext

func (o LabelDescriptorArrayOutput) ToLabelDescriptorArrayOutputWithContext(ctx context.Context) LabelDescriptorArrayOutput

type LabelDescriptorInput

type LabelDescriptorInput interface {
	pulumi.Input

	ToLabelDescriptorOutput() LabelDescriptorOutput
	ToLabelDescriptorOutputWithContext(context.Context) LabelDescriptorOutput
}

LabelDescriptorInput is an input type that accepts LabelDescriptorArgs and LabelDescriptorOutput values. You can construct a concrete instance of `LabelDescriptorInput` via:

LabelDescriptorArgs{...}

type LabelDescriptorOutput

type LabelDescriptorOutput struct{ *pulumi.OutputState }

A description of a label.

func (LabelDescriptorOutput) Description

A human-readable description for the label.

func (LabelDescriptorOutput) ElementType

func (LabelDescriptorOutput) ElementType() reflect.Type

func (LabelDescriptorOutput) Key

The label key.

func (LabelDescriptorOutput) ToLabelDescriptorOutput

func (o LabelDescriptorOutput) ToLabelDescriptorOutput() LabelDescriptorOutput

func (LabelDescriptorOutput) ToLabelDescriptorOutputWithContext

func (o LabelDescriptorOutput) ToLabelDescriptorOutputWithContext(ctx context.Context) LabelDescriptorOutput

func (LabelDescriptorOutput) ValueType

The type of data that can be assigned to the label.

type LabelDescriptorResponse

type LabelDescriptorResponse struct {
	// A human-readable description for the label.
	Description string `pulumi:"description"`
	// The label key.
	Key string `pulumi:"key"`
	// The type of data that can be assigned to the label.
	ValueType string `pulumi:"valueType"`
}

A description of a label.

type LabelDescriptorResponseArrayOutput

type LabelDescriptorResponseArrayOutput struct{ *pulumi.OutputState }

func (LabelDescriptorResponseArrayOutput) ElementType

func (LabelDescriptorResponseArrayOutput) Index

func (LabelDescriptorResponseArrayOutput) ToLabelDescriptorResponseArrayOutput

func (o LabelDescriptorResponseArrayOutput) ToLabelDescriptorResponseArrayOutput() LabelDescriptorResponseArrayOutput

func (LabelDescriptorResponseArrayOutput) ToLabelDescriptorResponseArrayOutputWithContext

func (o LabelDescriptorResponseArrayOutput) ToLabelDescriptorResponseArrayOutputWithContext(ctx context.Context) LabelDescriptorResponseArrayOutput

type LabelDescriptorResponseOutput

type LabelDescriptorResponseOutput struct{ *pulumi.OutputState }

A description of a label.

func (LabelDescriptorResponseOutput) Description

A human-readable description for the label.

func (LabelDescriptorResponseOutput) ElementType

func (LabelDescriptorResponseOutput) Key

The label key.

func (LabelDescriptorResponseOutput) ToLabelDescriptorResponseOutput

func (o LabelDescriptorResponseOutput) ToLabelDescriptorResponseOutput() LabelDescriptorResponseOutput

func (LabelDescriptorResponseOutput) ToLabelDescriptorResponseOutputWithContext

func (o LabelDescriptorResponseOutput) ToLabelDescriptorResponseOutputWithContext(ctx context.Context) LabelDescriptorResponseOutput

func (LabelDescriptorResponseOutput) ValueType

The type of data that can be assigned to the label.

type LabelDescriptorValueType added in v0.4.0

type LabelDescriptorValueType string

The type of data that can be assigned to the label.

func (LabelDescriptorValueType) ElementType added in v0.4.0

func (LabelDescriptorValueType) ElementType() reflect.Type

func (LabelDescriptorValueType) ToLabelDescriptorValueTypeOutput added in v0.6.0

func (e LabelDescriptorValueType) ToLabelDescriptorValueTypeOutput() LabelDescriptorValueTypeOutput

func (LabelDescriptorValueType) ToLabelDescriptorValueTypeOutputWithContext added in v0.6.0

func (e LabelDescriptorValueType) ToLabelDescriptorValueTypeOutputWithContext(ctx context.Context) LabelDescriptorValueTypeOutput

func (LabelDescriptorValueType) ToLabelDescriptorValueTypePtrOutput added in v0.6.0

func (e LabelDescriptorValueType) ToLabelDescriptorValueTypePtrOutput() LabelDescriptorValueTypePtrOutput

func (LabelDescriptorValueType) ToLabelDescriptorValueTypePtrOutputWithContext added in v0.6.0

func (e LabelDescriptorValueType) ToLabelDescriptorValueTypePtrOutputWithContext(ctx context.Context) LabelDescriptorValueTypePtrOutput

func (LabelDescriptorValueType) ToStringOutput added in v0.4.0

func (e LabelDescriptorValueType) ToStringOutput() pulumi.StringOutput

func (LabelDescriptorValueType) ToStringOutputWithContext added in v0.4.0

func (e LabelDescriptorValueType) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (LabelDescriptorValueType) ToStringPtrOutput added in v0.4.0

func (e LabelDescriptorValueType) ToStringPtrOutput() pulumi.StringPtrOutput

func (LabelDescriptorValueType) ToStringPtrOutputWithContext added in v0.4.0

func (e LabelDescriptorValueType) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type LabelDescriptorValueTypeInput added in v0.6.0

type LabelDescriptorValueTypeInput interface {
	pulumi.Input

	ToLabelDescriptorValueTypeOutput() LabelDescriptorValueTypeOutput
	ToLabelDescriptorValueTypeOutputWithContext(context.Context) LabelDescriptorValueTypeOutput
}

LabelDescriptorValueTypeInput is an input type that accepts LabelDescriptorValueTypeArgs and LabelDescriptorValueTypeOutput values. You can construct a concrete instance of `LabelDescriptorValueTypeInput` via:

LabelDescriptorValueTypeArgs{...}

type LabelDescriptorValueTypeOutput added in v0.6.0

type LabelDescriptorValueTypeOutput struct{ *pulumi.OutputState }

func (LabelDescriptorValueTypeOutput) ElementType added in v0.6.0

func (LabelDescriptorValueTypeOutput) ToLabelDescriptorValueTypeOutput added in v0.6.0

func (o LabelDescriptorValueTypeOutput) ToLabelDescriptorValueTypeOutput() LabelDescriptorValueTypeOutput

func (LabelDescriptorValueTypeOutput) ToLabelDescriptorValueTypeOutputWithContext added in v0.6.0

func (o LabelDescriptorValueTypeOutput) ToLabelDescriptorValueTypeOutputWithContext(ctx context.Context) LabelDescriptorValueTypeOutput

func (LabelDescriptorValueTypeOutput) ToLabelDescriptorValueTypePtrOutput added in v0.6.0

func (o LabelDescriptorValueTypeOutput) ToLabelDescriptorValueTypePtrOutput() LabelDescriptorValueTypePtrOutput

func (LabelDescriptorValueTypeOutput) ToLabelDescriptorValueTypePtrOutputWithContext added in v0.6.0

func (o LabelDescriptorValueTypeOutput) ToLabelDescriptorValueTypePtrOutputWithContext(ctx context.Context) LabelDescriptorValueTypePtrOutput

func (LabelDescriptorValueTypeOutput) ToStringOutput added in v0.6.0

func (LabelDescriptorValueTypeOutput) ToStringOutputWithContext added in v0.6.0

func (o LabelDescriptorValueTypeOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (LabelDescriptorValueTypeOutput) ToStringPtrOutput added in v0.6.0

func (LabelDescriptorValueTypeOutput) ToStringPtrOutputWithContext added in v0.6.0

func (o LabelDescriptorValueTypeOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type LabelDescriptorValueTypePtrInput added in v0.6.0

type LabelDescriptorValueTypePtrInput interface {
	pulumi.Input

	ToLabelDescriptorValueTypePtrOutput() LabelDescriptorValueTypePtrOutput
	ToLabelDescriptorValueTypePtrOutputWithContext(context.Context) LabelDescriptorValueTypePtrOutput
}

func LabelDescriptorValueTypePtr added in v0.6.0

func LabelDescriptorValueTypePtr(v string) LabelDescriptorValueTypePtrInput

type LabelDescriptorValueTypePtrOutput added in v0.6.0

type LabelDescriptorValueTypePtrOutput struct{ *pulumi.OutputState }

func (LabelDescriptorValueTypePtrOutput) Elem added in v0.6.0

func (LabelDescriptorValueTypePtrOutput) ElementType added in v0.6.0

func (LabelDescriptorValueTypePtrOutput) ToLabelDescriptorValueTypePtrOutput added in v0.6.0

func (o LabelDescriptorValueTypePtrOutput) ToLabelDescriptorValueTypePtrOutput() LabelDescriptorValueTypePtrOutput

func (LabelDescriptorValueTypePtrOutput) ToLabelDescriptorValueTypePtrOutputWithContext added in v0.6.0

func (o LabelDescriptorValueTypePtrOutput) ToLabelDescriptorValueTypePtrOutputWithContext(ctx context.Context) LabelDescriptorValueTypePtrOutput

func (LabelDescriptorValueTypePtrOutput) ToStringPtrOutput added in v0.6.0

func (LabelDescriptorValueTypePtrOutput) ToStringPtrOutputWithContext added in v0.6.0

func (o LabelDescriptorValueTypePtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type LogDescriptor

type LogDescriptor struct {
	// A human-readable description of this log. This information appears in the documentation and can contain details.
	Description *string `pulumi:"description"`
	// The human-readable name for this log. This information appears on the user interface and should be concise.
	DisplayName *string `pulumi:"displayName"`
	// The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid.
	Labels []LabelDescriptor `pulumi:"labels"`
	// The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.].
	Name *string `pulumi:"name"`
}

A description of a log type. Example in YAML format: - name: library.googleapis.com/activity_history description: The history of borrowing and returning library items. display_name: Activity labels: - key: /customer_id description: Identifier of a library customer

type LogDescriptorArgs

type LogDescriptorArgs struct {
	// A human-readable description of this log. This information appears in the documentation and can contain details.
	Description pulumi.StringPtrInput `pulumi:"description"`
	// The human-readable name for this log. This information appears on the user interface and should be concise.
	DisplayName pulumi.StringPtrInput `pulumi:"displayName"`
	// The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid.
	Labels LabelDescriptorArrayInput `pulumi:"labels"`
	// The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.].
	Name pulumi.StringPtrInput `pulumi:"name"`
}

A description of a log type. Example in YAML format: - name: library.googleapis.com/activity_history description: The history of borrowing and returning library items. display_name: Activity labels: - key: /customer_id description: Identifier of a library customer

func (LogDescriptorArgs) ElementType

func (LogDescriptorArgs) ElementType() reflect.Type

func (LogDescriptorArgs) ToLogDescriptorOutput

func (i LogDescriptorArgs) ToLogDescriptorOutput() LogDescriptorOutput

func (LogDescriptorArgs) ToLogDescriptorOutputWithContext

func (i LogDescriptorArgs) ToLogDescriptorOutputWithContext(ctx context.Context) LogDescriptorOutput

type LogDescriptorArray

type LogDescriptorArray []LogDescriptorInput

func (LogDescriptorArray) ElementType

func (LogDescriptorArray) ElementType() reflect.Type

func (LogDescriptorArray) ToLogDescriptorArrayOutput

func (i LogDescriptorArray) ToLogDescriptorArrayOutput() LogDescriptorArrayOutput

func (LogDescriptorArray) ToLogDescriptorArrayOutputWithContext

func (i LogDescriptorArray) ToLogDescriptorArrayOutputWithContext(ctx context.Context) LogDescriptorArrayOutput

type LogDescriptorArrayInput

type LogDescriptorArrayInput interface {
	pulumi.Input

	ToLogDescriptorArrayOutput() LogDescriptorArrayOutput
	ToLogDescriptorArrayOutputWithContext(context.Context) LogDescriptorArrayOutput
}

LogDescriptorArrayInput is an input type that accepts LogDescriptorArray and LogDescriptorArrayOutput values. You can construct a concrete instance of `LogDescriptorArrayInput` via:

LogDescriptorArray{ LogDescriptorArgs{...} }

type LogDescriptorArrayOutput

type LogDescriptorArrayOutput struct{ *pulumi.OutputState }

func (LogDescriptorArrayOutput) ElementType

func (LogDescriptorArrayOutput) ElementType() reflect.Type

func (LogDescriptorArrayOutput) Index

func (LogDescriptorArrayOutput) ToLogDescriptorArrayOutput

func (o LogDescriptorArrayOutput) ToLogDescriptorArrayOutput() LogDescriptorArrayOutput

func (LogDescriptorArrayOutput) ToLogDescriptorArrayOutputWithContext

func (o LogDescriptorArrayOutput) ToLogDescriptorArrayOutputWithContext(ctx context.Context) LogDescriptorArrayOutput

type LogDescriptorInput

type LogDescriptorInput interface {
	pulumi.Input

	ToLogDescriptorOutput() LogDescriptorOutput
	ToLogDescriptorOutputWithContext(context.Context) LogDescriptorOutput
}

LogDescriptorInput is an input type that accepts LogDescriptorArgs and LogDescriptorOutput values. You can construct a concrete instance of `LogDescriptorInput` via:

LogDescriptorArgs{...}

type LogDescriptorOutput

type LogDescriptorOutput struct{ *pulumi.OutputState }

A description of a log type. Example in YAML format: - name: library.googleapis.com/activity_history description: The history of borrowing and returning library items. display_name: Activity labels: - key: /customer_id description: Identifier of a library customer

func (LogDescriptorOutput) Description

func (o LogDescriptorOutput) Description() pulumi.StringPtrOutput

A human-readable description of this log. This information appears in the documentation and can contain details.

func (LogDescriptorOutput) DisplayName

func (o LogDescriptorOutput) DisplayName() pulumi.StringPtrOutput

The human-readable name for this log. This information appears on the user interface and should be concise.

func (LogDescriptorOutput) ElementType

func (LogDescriptorOutput) ElementType() reflect.Type

func (LogDescriptorOutput) Labels

The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid.

func (LogDescriptorOutput) Name

The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.].

func (LogDescriptorOutput) ToLogDescriptorOutput

func (o LogDescriptorOutput) ToLogDescriptorOutput() LogDescriptorOutput

func (LogDescriptorOutput) ToLogDescriptorOutputWithContext

func (o LogDescriptorOutput) ToLogDescriptorOutputWithContext(ctx context.Context) LogDescriptorOutput

type LogDescriptorResponse

type LogDescriptorResponse struct {
	// A human-readable description of this log. This information appears in the documentation and can contain details.
	Description string `pulumi:"description"`
	// The human-readable name for this log. This information appears on the user interface and should be concise.
	DisplayName string `pulumi:"displayName"`
	// The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid.
	Labels []LabelDescriptorResponse `pulumi:"labels"`
	// The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.].
	Name string `pulumi:"name"`
}

A description of a log type. Example in YAML format: - name: library.googleapis.com/activity_history description: The history of borrowing and returning library items. display_name: Activity labels: - key: /customer_id description: Identifier of a library customer

type LogDescriptorResponseArrayOutput

type LogDescriptorResponseArrayOutput struct{ *pulumi.OutputState }

func (LogDescriptorResponseArrayOutput) ElementType

func (LogDescriptorResponseArrayOutput) Index

func (LogDescriptorResponseArrayOutput) ToLogDescriptorResponseArrayOutput

func (o LogDescriptorResponseArrayOutput) ToLogDescriptorResponseArrayOutput() LogDescriptorResponseArrayOutput

func (LogDescriptorResponseArrayOutput) ToLogDescriptorResponseArrayOutputWithContext

func (o LogDescriptorResponseArrayOutput) ToLogDescriptorResponseArrayOutputWithContext(ctx context.Context) LogDescriptorResponseArrayOutput

type LogDescriptorResponseOutput

type LogDescriptorResponseOutput struct{ *pulumi.OutputState }

A description of a log type. Example in YAML format: - name: library.googleapis.com/activity_history description: The history of borrowing and returning library items. display_name: Activity labels: - key: /customer_id description: Identifier of a library customer

func (LogDescriptorResponseOutput) Description

A human-readable description of this log. This information appears in the documentation and can contain details.

func (LogDescriptorResponseOutput) DisplayName

The human-readable name for this log. This information appears on the user interface and should be concise.

func (LogDescriptorResponseOutput) ElementType

func (LogDescriptorResponseOutput) Labels

The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid.

func (LogDescriptorResponseOutput) Name

The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.].

func (LogDescriptorResponseOutput) ToLogDescriptorResponseOutput

func (o LogDescriptorResponseOutput) ToLogDescriptorResponseOutput() LogDescriptorResponseOutput

func (LogDescriptorResponseOutput) ToLogDescriptorResponseOutputWithContext

func (o LogDescriptorResponseOutput) ToLogDescriptorResponseOutputWithContext(ctx context.Context) LogDescriptorResponseOutput

type Logging

type Logging struct {
	// Logging configurations for sending logs to the consumer project. There can be multiple consumer destinations, each one must have a different monitored resource type. A log can be used in at most one consumer destination.
	ConsumerDestinations []LoggingDestination `pulumi:"consumerDestinations"`
	// Logging configurations for sending logs to the producer project. There can be multiple producer destinations, each one must have a different monitored resource type. A log can be used in at most one producer destination.
	ProducerDestinations []LoggingDestination `pulumi:"producerDestinations"`
}

Logging configuration of the service. The following example shows how to configure logs to be sent to the producer and consumer projects. In the example, the `activity_history` log is sent to both the producer and consumer projects, whereas the `purchase_history` log is only sent to the producer project. monitored_resources: - type: library.googleapis.com/branch labels: - key: /city description: The city where the library branch is located in. - key: /name description: The name of the branch. logs: - name: activity_history labels: - key: /customer_id - name: purchase_history logging: producer_destinations: - monitored_resource: library.googleapis.com/branch logs: - activity_history - purchase_history consumer_destinations: - monitored_resource: library.googleapis.com/branch logs: - activity_history

type LoggingArgs

type LoggingArgs struct {
	// Logging configurations for sending logs to the consumer project. There can be multiple consumer destinations, each one must have a different monitored resource type. A log can be used in at most one consumer destination.
	ConsumerDestinations LoggingDestinationArrayInput `pulumi:"consumerDestinations"`
	// Logging configurations for sending logs to the producer project. There can be multiple producer destinations, each one must have a different monitored resource type. A log can be used in at most one producer destination.
	ProducerDestinations LoggingDestinationArrayInput `pulumi:"producerDestinations"`
}

Logging configuration of the service. The following example shows how to configure logs to be sent to the producer and consumer projects. In the example, the `activity_history` log is sent to both the producer and consumer projects, whereas the `purchase_history` log is only sent to the producer project. monitored_resources: - type: library.googleapis.com/branch labels: - key: /city description: The city where the library branch is located in. - key: /name description: The name of the branch. logs: - name: activity_history labels: - key: /customer_id - name: purchase_history logging: producer_destinations: - monitored_resource: library.googleapis.com/branch logs: - activity_history - purchase_history consumer_destinations: - monitored_resource: library.googleapis.com/branch logs: - activity_history

func (LoggingArgs) ElementType

func (LoggingArgs) ElementType() reflect.Type

func (LoggingArgs) ToLoggingOutput

func (i LoggingArgs) ToLoggingOutput() LoggingOutput

func (LoggingArgs) ToLoggingOutputWithContext

func (i LoggingArgs) ToLoggingOutputWithContext(ctx context.Context) LoggingOutput

func (LoggingArgs) ToLoggingPtrOutput

func (i LoggingArgs) ToLoggingPtrOutput() LoggingPtrOutput

func (LoggingArgs) ToLoggingPtrOutputWithContext

func (i LoggingArgs) ToLoggingPtrOutputWithContext(ctx context.Context) LoggingPtrOutput

type LoggingDestination

type LoggingDestination struct {
	// Names of the logs to be sent to this destination. Each name must be defined in the Service.logs section. If the log name is not a domain scoped name, it will be automatically prefixed with the service name followed by "/".
	Logs []string `pulumi:"logs"`
	// The monitored resource type. The type must be defined in the Service.monitored_resources section.
	MonitoredResource *string `pulumi:"monitoredResource"`
}

Configuration of a specific logging destination (the producer project or the consumer project).

type LoggingDestinationArgs

type LoggingDestinationArgs struct {
	// Names of the logs to be sent to this destination. Each name must be defined in the Service.logs section. If the log name is not a domain scoped name, it will be automatically prefixed with the service name followed by "/".
	Logs pulumi.StringArrayInput `pulumi:"logs"`
	// The monitored resource type. The type must be defined in the Service.monitored_resources section.
	MonitoredResource pulumi.StringPtrInput `pulumi:"monitoredResource"`
}

Configuration of a specific logging destination (the producer project or the consumer project).

func (LoggingDestinationArgs) ElementType

func (LoggingDestinationArgs) ElementType() reflect.Type

func (LoggingDestinationArgs) ToLoggingDestinationOutput

func (i LoggingDestinationArgs) ToLoggingDestinationOutput() LoggingDestinationOutput

func (LoggingDestinationArgs) ToLoggingDestinationOutputWithContext

func (i LoggingDestinationArgs) ToLoggingDestinationOutputWithContext(ctx context.Context) LoggingDestinationOutput

type LoggingDestinationArray

type LoggingDestinationArray []LoggingDestinationInput

func (LoggingDestinationArray) ElementType

func (LoggingDestinationArray) ElementType() reflect.Type

func (LoggingDestinationArray) ToLoggingDestinationArrayOutput

func (i LoggingDestinationArray) ToLoggingDestinationArrayOutput() LoggingDestinationArrayOutput

func (LoggingDestinationArray) ToLoggingDestinationArrayOutputWithContext

func (i LoggingDestinationArray) ToLoggingDestinationArrayOutputWithContext(ctx context.Context) LoggingDestinationArrayOutput

type LoggingDestinationArrayInput

type LoggingDestinationArrayInput interface {
	pulumi.Input

	ToLoggingDestinationArrayOutput() LoggingDestinationArrayOutput
	ToLoggingDestinationArrayOutputWithContext(context.Context) LoggingDestinationArrayOutput
}

LoggingDestinationArrayInput is an input type that accepts LoggingDestinationArray and LoggingDestinationArrayOutput values. You can construct a concrete instance of `LoggingDestinationArrayInput` via:

LoggingDestinationArray{ LoggingDestinationArgs{...} }

type LoggingDestinationArrayOutput

type LoggingDestinationArrayOutput struct{ *pulumi.OutputState }

func (LoggingDestinationArrayOutput) ElementType

func (LoggingDestinationArrayOutput) Index

func (LoggingDestinationArrayOutput) ToLoggingDestinationArrayOutput

func (o LoggingDestinationArrayOutput) ToLoggingDestinationArrayOutput() LoggingDestinationArrayOutput

func (LoggingDestinationArrayOutput) ToLoggingDestinationArrayOutputWithContext

func (o LoggingDestinationArrayOutput) ToLoggingDestinationArrayOutputWithContext(ctx context.Context) LoggingDestinationArrayOutput

type LoggingDestinationInput

type LoggingDestinationInput interface {
	pulumi.Input

	ToLoggingDestinationOutput() LoggingDestinationOutput
	ToLoggingDestinationOutputWithContext(context.Context) LoggingDestinationOutput
}

LoggingDestinationInput is an input type that accepts LoggingDestinationArgs and LoggingDestinationOutput values. You can construct a concrete instance of `LoggingDestinationInput` via:

LoggingDestinationArgs{...}

type LoggingDestinationOutput

type LoggingDestinationOutput struct{ *pulumi.OutputState }

Configuration of a specific logging destination (the producer project or the consumer project).

func (LoggingDestinationOutput) ElementType

func (LoggingDestinationOutput) ElementType() reflect.Type

func (LoggingDestinationOutput) Logs

Names of the logs to be sent to this destination. Each name must be defined in the Service.logs section. If the log name is not a domain scoped name, it will be automatically prefixed with the service name followed by "/".

func (LoggingDestinationOutput) MonitoredResource

func (o LoggingDestinationOutput) MonitoredResource() pulumi.StringPtrOutput

The monitored resource type. The type must be defined in the Service.monitored_resources section.

func (LoggingDestinationOutput) ToLoggingDestinationOutput

func (o LoggingDestinationOutput) ToLoggingDestinationOutput() LoggingDestinationOutput

func (LoggingDestinationOutput) ToLoggingDestinationOutputWithContext

func (o LoggingDestinationOutput) ToLoggingDestinationOutputWithContext(ctx context.Context) LoggingDestinationOutput

type LoggingDestinationResponse

type LoggingDestinationResponse struct {
	// Names of the logs to be sent to this destination. Each name must be defined in the Service.logs section. If the log name is not a domain scoped name, it will be automatically prefixed with the service name followed by "/".
	Logs []string `pulumi:"logs"`
	// The monitored resource type. The type must be defined in the Service.monitored_resources section.
	MonitoredResource string `pulumi:"monitoredResource"`
}

Configuration of a specific logging destination (the producer project or the consumer project).

type LoggingDestinationResponseArrayOutput

type LoggingDestinationResponseArrayOutput struct{ *pulumi.OutputState }

func (LoggingDestinationResponseArrayOutput) ElementType

func (LoggingDestinationResponseArrayOutput) Index

func (LoggingDestinationResponseArrayOutput) ToLoggingDestinationResponseArrayOutput

func (o LoggingDestinationResponseArrayOutput) ToLoggingDestinationResponseArrayOutput() LoggingDestinationResponseArrayOutput

func (LoggingDestinationResponseArrayOutput) ToLoggingDestinationResponseArrayOutputWithContext

func (o LoggingDestinationResponseArrayOutput) ToLoggingDestinationResponseArrayOutputWithContext(ctx context.Context) LoggingDestinationResponseArrayOutput

type LoggingDestinationResponseOutput

type LoggingDestinationResponseOutput struct{ *pulumi.OutputState }

Configuration of a specific logging destination (the producer project or the consumer project).

func (LoggingDestinationResponseOutput) ElementType

func (LoggingDestinationResponseOutput) Logs

Names of the logs to be sent to this destination. Each name must be defined in the Service.logs section. If the log name is not a domain scoped name, it will be automatically prefixed with the service name followed by "/".

func (LoggingDestinationResponseOutput) MonitoredResource

The monitored resource type. The type must be defined in the Service.monitored_resources section.

func (LoggingDestinationResponseOutput) ToLoggingDestinationResponseOutput

func (o LoggingDestinationResponseOutput) ToLoggingDestinationResponseOutput() LoggingDestinationResponseOutput

func (LoggingDestinationResponseOutput) ToLoggingDestinationResponseOutputWithContext

func (o LoggingDestinationResponseOutput) ToLoggingDestinationResponseOutputWithContext(ctx context.Context) LoggingDestinationResponseOutput

type LoggingInput

type LoggingInput interface {
	pulumi.Input

	ToLoggingOutput() LoggingOutput
	ToLoggingOutputWithContext(context.Context) LoggingOutput
}

LoggingInput is an input type that accepts LoggingArgs and LoggingOutput values. You can construct a concrete instance of `LoggingInput` via:

LoggingArgs{...}

type LoggingOutput

type LoggingOutput struct{ *pulumi.OutputState }

Logging configuration of the service. The following example shows how to configure logs to be sent to the producer and consumer projects. In the example, the `activity_history` log is sent to both the producer and consumer projects, whereas the `purchase_history` log is only sent to the producer project. monitored_resources: - type: library.googleapis.com/branch labels: - key: /city description: The city where the library branch is located in. - key: /name description: The name of the branch. logs: - name: activity_history labels: - key: /customer_id - name: purchase_history logging: producer_destinations: - monitored_resource: library.googleapis.com/branch logs: - activity_history - purchase_history consumer_destinations: - monitored_resource: library.googleapis.com/branch logs: - activity_history

func (LoggingOutput) ConsumerDestinations

func (o LoggingOutput) ConsumerDestinations() LoggingDestinationArrayOutput

Logging configurations for sending logs to the consumer project. There can be multiple consumer destinations, each one must have a different monitored resource type. A log can be used in at most one consumer destination.

func (LoggingOutput) ElementType

func (LoggingOutput) ElementType() reflect.Type

func (LoggingOutput) ProducerDestinations

func (o LoggingOutput) ProducerDestinations() LoggingDestinationArrayOutput

Logging configurations for sending logs to the producer project. There can be multiple producer destinations, each one must have a different monitored resource type. A log can be used in at most one producer destination.

func (LoggingOutput) ToLoggingOutput

func (o LoggingOutput) ToLoggingOutput() LoggingOutput

func (LoggingOutput) ToLoggingOutputWithContext

func (o LoggingOutput) ToLoggingOutputWithContext(ctx context.Context) LoggingOutput

func (LoggingOutput) ToLoggingPtrOutput

func (o LoggingOutput) ToLoggingPtrOutput() LoggingPtrOutput

func (LoggingOutput) ToLoggingPtrOutputWithContext

func (o LoggingOutput) ToLoggingPtrOutputWithContext(ctx context.Context) LoggingPtrOutput

type LoggingPtrInput

type LoggingPtrInput interface {
	pulumi.Input

	ToLoggingPtrOutput() LoggingPtrOutput
	ToLoggingPtrOutputWithContext(context.Context) LoggingPtrOutput
}

LoggingPtrInput is an input type that accepts LoggingArgs, LoggingPtr and LoggingPtrOutput values. You can construct a concrete instance of `LoggingPtrInput` via:

        LoggingArgs{...}

or:

        nil

func LoggingPtr

func LoggingPtr(v *LoggingArgs) LoggingPtrInput

type LoggingPtrOutput

type LoggingPtrOutput struct{ *pulumi.OutputState }

func (LoggingPtrOutput) ConsumerDestinations

func (o LoggingPtrOutput) ConsumerDestinations() LoggingDestinationArrayOutput

Logging configurations for sending logs to the consumer project. There can be multiple consumer destinations, each one must have a different monitored resource type. A log can be used in at most one consumer destination.

func (LoggingPtrOutput) Elem

func (LoggingPtrOutput) ElementType

func (LoggingPtrOutput) ElementType() reflect.Type

func (LoggingPtrOutput) ProducerDestinations

func (o LoggingPtrOutput) ProducerDestinations() LoggingDestinationArrayOutput

Logging configurations for sending logs to the producer project. There can be multiple producer destinations, each one must have a different monitored resource type. A log can be used in at most one producer destination.

func (LoggingPtrOutput) ToLoggingPtrOutput

func (o LoggingPtrOutput) ToLoggingPtrOutput() LoggingPtrOutput

func (LoggingPtrOutput) ToLoggingPtrOutputWithContext

func (o LoggingPtrOutput) ToLoggingPtrOutputWithContext(ctx context.Context) LoggingPtrOutput

type LoggingResponse

type LoggingResponse struct {
	// Logging configurations for sending logs to the consumer project. There can be multiple consumer destinations, each one must have a different monitored resource type. A log can be used in at most one consumer destination.
	ConsumerDestinations []LoggingDestinationResponse `pulumi:"consumerDestinations"`
	// Logging configurations for sending logs to the producer project. There can be multiple producer destinations, each one must have a different monitored resource type. A log can be used in at most one producer destination.
	ProducerDestinations []LoggingDestinationResponse `pulumi:"producerDestinations"`
}

Logging configuration of the service. The following example shows how to configure logs to be sent to the producer and consumer projects. In the example, the `activity_history` log is sent to both the producer and consumer projects, whereas the `purchase_history` log is only sent to the producer project. monitored_resources: - type: library.googleapis.com/branch labels: - key: /city description: The city where the library branch is located in. - key: /name description: The name of the branch. logs: - name: activity_history labels: - key: /customer_id - name: purchase_history logging: producer_destinations: - monitored_resource: library.googleapis.com/branch logs: - activity_history - purchase_history consumer_destinations: - monitored_resource: library.googleapis.com/branch logs: - activity_history

type LoggingResponseOutput

type LoggingResponseOutput struct{ *pulumi.OutputState }

Logging configuration of the service. The following example shows how to configure logs to be sent to the producer and consumer projects. In the example, the `activity_history` log is sent to both the producer and consumer projects, whereas the `purchase_history` log is only sent to the producer project. monitored_resources: - type: library.googleapis.com/branch labels: - key: /city description: The city where the library branch is located in. - key: /name description: The name of the branch. logs: - name: activity_history labels: - key: /customer_id - name: purchase_history logging: producer_destinations: - monitored_resource: library.googleapis.com/branch logs: - activity_history - purchase_history consumer_destinations: - monitored_resource: library.googleapis.com/branch logs: - activity_history

func (LoggingResponseOutput) ConsumerDestinations

Logging configurations for sending logs to the consumer project. There can be multiple consumer destinations, each one must have a different monitored resource type. A log can be used in at most one consumer destination.

func (LoggingResponseOutput) ElementType

func (LoggingResponseOutput) ElementType() reflect.Type

func (LoggingResponseOutput) ProducerDestinations

Logging configurations for sending logs to the producer project. There can be multiple producer destinations, each one must have a different monitored resource type. A log can be used in at most one producer destination.

func (LoggingResponseOutput) ToLoggingResponseOutput

func (o LoggingResponseOutput) ToLoggingResponseOutput() LoggingResponseOutput

func (LoggingResponseOutput) ToLoggingResponseOutputWithContext

func (o LoggingResponseOutput) ToLoggingResponseOutputWithContext(ctx context.Context) LoggingResponseOutput

type LongRunning added in v0.28.0

type LongRunning struct {
	// Initial delay after which the first poll request will be made. Default value: 5 seconds.
	InitialPollDelay *string `pulumi:"initialPollDelay"`
	// Maximum time between two subsequent poll requests. Default value: 45 seconds.
	MaxPollDelay *string `pulumi:"maxPollDelay"`
	// Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay. Default value: 1.5.
	PollDelayMultiplier *float64 `pulumi:"pollDelayMultiplier"`
	// Total polling timeout. Default value: 5 minutes.
	TotalPollTimeout *string `pulumi:"totalPollTimeout"`
}

Describes settings to use when generating API methods that use the long-running operation pattern. All default values below are from those used in the client library generators (e.g. [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)).

type LongRunningArgs added in v0.28.0

type LongRunningArgs struct {
	// Initial delay after which the first poll request will be made. Default value: 5 seconds.
	InitialPollDelay pulumi.StringPtrInput `pulumi:"initialPollDelay"`
	// Maximum time between two subsequent poll requests. Default value: 45 seconds.
	MaxPollDelay pulumi.StringPtrInput `pulumi:"maxPollDelay"`
	// Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay. Default value: 1.5.
	PollDelayMultiplier pulumi.Float64PtrInput `pulumi:"pollDelayMultiplier"`
	// Total polling timeout. Default value: 5 minutes.
	TotalPollTimeout pulumi.StringPtrInput `pulumi:"totalPollTimeout"`
}

Describes settings to use when generating API methods that use the long-running operation pattern. All default values below are from those used in the client library generators (e.g. [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)).

func (LongRunningArgs) ElementType added in v0.28.0

func (LongRunningArgs) ElementType() reflect.Type

func (LongRunningArgs) ToLongRunningOutput added in v0.28.0

func (i LongRunningArgs) ToLongRunningOutput() LongRunningOutput

func (LongRunningArgs) ToLongRunningOutputWithContext added in v0.28.0

func (i LongRunningArgs) ToLongRunningOutputWithContext(ctx context.Context) LongRunningOutput

func (LongRunningArgs) ToLongRunningPtrOutput added in v0.28.0

func (i LongRunningArgs) ToLongRunningPtrOutput() LongRunningPtrOutput

func (LongRunningArgs) ToLongRunningPtrOutputWithContext added in v0.28.0

func (i LongRunningArgs) ToLongRunningPtrOutputWithContext(ctx context.Context) LongRunningPtrOutput

type LongRunningInput added in v0.28.0

type LongRunningInput interface {
	pulumi.Input

	ToLongRunningOutput() LongRunningOutput
	ToLongRunningOutputWithContext(context.Context) LongRunningOutput
}

LongRunningInput is an input type that accepts LongRunningArgs and LongRunningOutput values. You can construct a concrete instance of `LongRunningInput` via:

LongRunningArgs{...}

type LongRunningOutput added in v0.28.0

type LongRunningOutput struct{ *pulumi.OutputState }

Describes settings to use when generating API methods that use the long-running operation pattern. All default values below are from those used in the client library generators (e.g. [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)).

func (LongRunningOutput) ElementType added in v0.28.0

func (LongRunningOutput) ElementType() reflect.Type

func (LongRunningOutput) InitialPollDelay added in v0.28.0

func (o LongRunningOutput) InitialPollDelay() pulumi.StringPtrOutput

Initial delay after which the first poll request will be made. Default value: 5 seconds.

func (LongRunningOutput) MaxPollDelay added in v0.28.0

func (o LongRunningOutput) MaxPollDelay() pulumi.StringPtrOutput

Maximum time between two subsequent poll requests. Default value: 45 seconds.

func (LongRunningOutput) PollDelayMultiplier added in v0.28.0

func (o LongRunningOutput) PollDelayMultiplier() pulumi.Float64PtrOutput

Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay. Default value: 1.5.

func (LongRunningOutput) ToLongRunningOutput added in v0.28.0

func (o LongRunningOutput) ToLongRunningOutput() LongRunningOutput

func (LongRunningOutput) ToLongRunningOutputWithContext added in v0.28.0

func (o LongRunningOutput) ToLongRunningOutputWithContext(ctx context.Context) LongRunningOutput

func (LongRunningOutput) ToLongRunningPtrOutput added in v0.28.0

func (o LongRunningOutput) ToLongRunningPtrOutput() LongRunningPtrOutput

func (LongRunningOutput) ToLongRunningPtrOutputWithContext added in v0.28.0

func (o LongRunningOutput) ToLongRunningPtrOutputWithContext(ctx context.Context) LongRunningPtrOutput

func (LongRunningOutput) TotalPollTimeout added in v0.28.0

func (o LongRunningOutput) TotalPollTimeout() pulumi.StringPtrOutput

Total polling timeout. Default value: 5 minutes.

type LongRunningPtrInput added in v0.28.0

type LongRunningPtrInput interface {
	pulumi.Input

	ToLongRunningPtrOutput() LongRunningPtrOutput
	ToLongRunningPtrOutputWithContext(context.Context) LongRunningPtrOutput
}

LongRunningPtrInput is an input type that accepts LongRunningArgs, LongRunningPtr and LongRunningPtrOutput values. You can construct a concrete instance of `LongRunningPtrInput` via:

        LongRunningArgs{...}

or:

        nil

func LongRunningPtr added in v0.28.0

func LongRunningPtr(v *LongRunningArgs) LongRunningPtrInput

type LongRunningPtrOutput added in v0.28.0

type LongRunningPtrOutput struct{ *pulumi.OutputState }

func (LongRunningPtrOutput) Elem added in v0.28.0

func (LongRunningPtrOutput) ElementType added in v0.28.0

func (LongRunningPtrOutput) ElementType() reflect.Type

func (LongRunningPtrOutput) InitialPollDelay added in v0.28.0

func (o LongRunningPtrOutput) InitialPollDelay() pulumi.StringPtrOutput

Initial delay after which the first poll request will be made. Default value: 5 seconds.

func (LongRunningPtrOutput) MaxPollDelay added in v0.28.0

func (o LongRunningPtrOutput) MaxPollDelay() pulumi.StringPtrOutput

Maximum time between two subsequent poll requests. Default value: 45 seconds.

func (LongRunningPtrOutput) PollDelayMultiplier added in v0.28.0

func (o LongRunningPtrOutput) PollDelayMultiplier() pulumi.Float64PtrOutput

Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay. Default value: 1.5.

func (LongRunningPtrOutput) ToLongRunningPtrOutput added in v0.28.0

func (o LongRunningPtrOutput) ToLongRunningPtrOutput() LongRunningPtrOutput

func (LongRunningPtrOutput) ToLongRunningPtrOutputWithContext added in v0.28.0

func (o LongRunningPtrOutput) ToLongRunningPtrOutputWithContext(ctx context.Context) LongRunningPtrOutput

func (LongRunningPtrOutput) TotalPollTimeout added in v0.28.0

func (o LongRunningPtrOutput) TotalPollTimeout() pulumi.StringPtrOutput

Total polling timeout. Default value: 5 minutes.

type LongRunningResponse added in v0.28.0

type LongRunningResponse struct {
	// Initial delay after which the first poll request will be made. Default value: 5 seconds.
	InitialPollDelay string `pulumi:"initialPollDelay"`
	// Maximum time between two subsequent poll requests. Default value: 45 seconds.
	MaxPollDelay string `pulumi:"maxPollDelay"`
	// Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay. Default value: 1.5.
	PollDelayMultiplier float64 `pulumi:"pollDelayMultiplier"`
	// Total polling timeout. Default value: 5 minutes.
	TotalPollTimeout string `pulumi:"totalPollTimeout"`
}

Describes settings to use when generating API methods that use the long-running operation pattern. All default values below are from those used in the client library generators (e.g. [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)).

type LongRunningResponseOutput added in v0.28.0

type LongRunningResponseOutput struct{ *pulumi.OutputState }

Describes settings to use when generating API methods that use the long-running operation pattern. All default values below are from those used in the client library generators (e.g. [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)).

func (LongRunningResponseOutput) ElementType added in v0.28.0

func (LongRunningResponseOutput) ElementType() reflect.Type

func (LongRunningResponseOutput) InitialPollDelay added in v0.28.0

func (o LongRunningResponseOutput) InitialPollDelay() pulumi.StringOutput

Initial delay after which the first poll request will be made. Default value: 5 seconds.

func (LongRunningResponseOutput) MaxPollDelay added in v0.28.0

Maximum time between two subsequent poll requests. Default value: 45 seconds.

func (LongRunningResponseOutput) PollDelayMultiplier added in v0.28.0

func (o LongRunningResponseOutput) PollDelayMultiplier() pulumi.Float64Output

Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay. Default value: 1.5.

func (LongRunningResponseOutput) ToLongRunningResponseOutput added in v0.28.0

func (o LongRunningResponseOutput) ToLongRunningResponseOutput() LongRunningResponseOutput

func (LongRunningResponseOutput) ToLongRunningResponseOutputWithContext added in v0.28.0

func (o LongRunningResponseOutput) ToLongRunningResponseOutputWithContext(ctx context.Context) LongRunningResponseOutput

func (LongRunningResponseOutput) TotalPollTimeout added in v0.28.0

func (o LongRunningResponseOutput) TotalPollTimeout() pulumi.StringOutput

Total polling timeout. Default value: 5 minutes.

type LookupConfigArgs added in v0.4.0

type LookupConfigArgs struct {
	ConfigId    string  `pulumi:"configId"`
	ServiceName string  `pulumi:"serviceName"`
	View        *string `pulumi:"view"`
}

type LookupConfigOutputArgs added in v0.8.0

type LookupConfigOutputArgs struct {
	ConfigId    pulumi.StringInput    `pulumi:"configId"`
	ServiceName pulumi.StringInput    `pulumi:"serviceName"`
	View        pulumi.StringPtrInput `pulumi:"view"`
}

func (LookupConfigOutputArgs) ElementType added in v0.8.0

func (LookupConfigOutputArgs) ElementType() reflect.Type

type LookupConfigResult added in v0.4.0

type LookupConfigResult struct {
	// A list of API interfaces exported by this service. Only the `name` field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files.
	Apis []ApiResponse `pulumi:"apis"`
	// Auth configuration.
	Authentication AuthenticationResponse `pulumi:"authentication"`
	// API backend configuration.
	Backend BackendResponse `pulumi:"backend"`
	// Billing configuration.
	Billing BillingResponse `pulumi:"billing"`
	// Obsolete. Do not use. This field has no semantic meaning. The service config compiler always sets this field to `3`.
	ConfigVersion int `pulumi:"configVersion"`
	// Context configuration.
	Context ContextResponse `pulumi:"context"`
	// Configuration for the service control plane.
	Control ControlResponse `pulumi:"control"`
	// Custom error configuration.
	CustomError CustomErrorResponse `pulumi:"customError"`
	// Additional API documentation.
	Documentation DocumentationResponse `pulumi:"documentation"`
	// Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs.
	Endpoints []EndpointResponse `pulumi:"endpoints"`
	// A list of all enum types included in this API service. Enums referenced directly or indirectly by the `apis` are automatically included. Enums which are not referenced but shall be included should be listed here by name by the configuration author. Example: enums: - name: google.someapi.v1.SomeEnum
	Enums []EnumResponse `pulumi:"enums"`
	// HTTP configuration.
	Http HttpResponse `pulumi:"http"`
	// Logging configuration.
	Logging LoggingResponse `pulumi:"logging"`
	// Defines the logs used by this service.
	Logs []LogDescriptorResponse `pulumi:"logs"`
	// Defines the metrics used by this service.
	Metrics []MetricDescriptorResponse `pulumi:"metrics"`
	// Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.
	MonitoredResources []MonitoredResourceDescriptorResponse `pulumi:"monitoredResources"`
	// Monitoring configuration.
	Monitoring MonitoringResponse `pulumi:"monitoring"`
	// The service name, which is a DNS-like logical identifier for the service, such as `calendar.googleapis.com`. The service name typically goes through DNS verification to make sure the owner of the service also owns the DNS name.
	Name string `pulumi:"name"`
	// The Google project that owns this service.
	ProducerProjectId string `pulumi:"producerProjectId"`
	// Settings for [Google Cloud Client libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) generated from APIs defined as protocol buffers.
	Publishing PublishingResponse `pulumi:"publishing"`
	// Quota configuration.
	Quota QuotaResponse `pulumi:"quota"`
	// The source information for this configuration if available.
	SourceInfo SourceInfoResponse `pulumi:"sourceInfo"`
	// System parameter configuration.
	SystemParameters SystemParametersResponse `pulumi:"systemParameters"`
	// A list of all proto message types included in this API service. It serves similar purpose as [google.api.Service.types], except that these types are not needed by user-defined APIs. Therefore, they will not show up in the generated discovery doc. This field should only be used to define system APIs in ESF.
	SystemTypes []TypeResponse `pulumi:"systemTypes"`
	// The product title for this service, it is the name displayed in Google Cloud Console.
	Title string `pulumi:"title"`
	// A list of all proto message types included in this API service. Types referenced directly or indirectly by the `apis` are automatically included. Messages which are not referenced but shall be included, such as types used by the `google.protobuf.Any` type, should be listed here by name by the configuration author. Example: types: - name: google.protobuf.Int32
	Types []TypeResponse `pulumi:"types"`
	// Configuration controlling usage of this service.
	Usage UsageResponse `pulumi:"usage"`
}

func LookupConfig added in v0.4.0

func LookupConfig(ctx *pulumi.Context, args *LookupConfigArgs, opts ...pulumi.InvokeOption) (*LookupConfigResult, error)

Gets a service configuration (version) for a managed service.

type LookupConfigResultOutput added in v0.8.0

type LookupConfigResultOutput struct{ *pulumi.OutputState }

func LookupConfigOutput added in v0.8.0

func LookupConfigOutput(ctx *pulumi.Context, args LookupConfigOutputArgs, opts ...pulumi.InvokeOption) LookupConfigResultOutput

func (LookupConfigResultOutput) Apis added in v0.8.0

A list of API interfaces exported by this service. Only the `name` field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files.

func (LookupConfigResultOutput) Authentication added in v0.8.0

Auth configuration.

func (LookupConfigResultOutput) Backend added in v0.8.0

API backend configuration.

func (LookupConfigResultOutput) Billing added in v0.8.0

Billing configuration.

func (LookupConfigResultOutput) ConfigVersion added in v0.8.0

func (o LookupConfigResultOutput) ConfigVersion() pulumi.IntOutput

Obsolete. Do not use. This field has no semantic meaning. The service config compiler always sets this field to `3`.

func (LookupConfigResultOutput) Context added in v0.8.0

Context configuration.

func (LookupConfigResultOutput) Control added in v0.8.0

Configuration for the service control plane.

func (LookupConfigResultOutput) CustomError added in v0.8.0

Custom error configuration.

func (LookupConfigResultOutput) Documentation added in v0.8.0

Additional API documentation.

func (LookupConfigResultOutput) ElementType added in v0.8.0

func (LookupConfigResultOutput) ElementType() reflect.Type

func (LookupConfigResultOutput) Endpoints added in v0.8.0

Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs.

func (LookupConfigResultOutput) Enums added in v0.8.0

A list of all enum types included in this API service. Enums referenced directly or indirectly by the `apis` are automatically included. Enums which are not referenced but shall be included should be listed here by name by the configuration author. Example: enums: - name: google.someapi.v1.SomeEnum

func (LookupConfigResultOutput) Http added in v0.8.0

HTTP configuration.

func (LookupConfigResultOutput) Logging added in v0.8.0

Logging configuration.

func (LookupConfigResultOutput) Logs added in v0.8.0

Defines the logs used by this service.

func (LookupConfigResultOutput) Metrics added in v0.8.0

Defines the metrics used by this service.

func (LookupConfigResultOutput) MonitoredResources added in v0.8.0

Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.

func (LookupConfigResultOutput) Monitoring added in v0.8.0

Monitoring configuration.

func (LookupConfigResultOutput) Name added in v0.8.0

The service name, which is a DNS-like logical identifier for the service, such as `calendar.googleapis.com`. The service name typically goes through DNS verification to make sure the owner of the service also owns the DNS name.

func (LookupConfigResultOutput) ProducerProjectId added in v0.8.0

func (o LookupConfigResultOutput) ProducerProjectId() pulumi.StringOutput

The Google project that owns this service.

func (LookupConfigResultOutput) Publishing added in v0.28.0

Settings for [Google Cloud Client libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) generated from APIs defined as protocol buffers.

func (LookupConfigResultOutput) Quota added in v0.8.0

Quota configuration.

func (LookupConfigResultOutput) SourceInfo added in v0.8.0

The source information for this configuration if available.

func (LookupConfigResultOutput) SystemParameters added in v0.8.0

System parameter configuration.

func (LookupConfigResultOutput) SystemTypes added in v0.8.0

A list of all proto message types included in this API service. It serves similar purpose as [google.api.Service.types], except that these types are not needed by user-defined APIs. Therefore, they will not show up in the generated discovery doc. This field should only be used to define system APIs in ESF.

func (LookupConfigResultOutput) Title added in v0.8.0

The product title for this service, it is the name displayed in Google Cloud Console.

func (LookupConfigResultOutput) ToLookupConfigResultOutput added in v0.8.0

func (o LookupConfigResultOutput) ToLookupConfigResultOutput() LookupConfigResultOutput

func (LookupConfigResultOutput) ToLookupConfigResultOutputWithContext added in v0.8.0

func (o LookupConfigResultOutput) ToLookupConfigResultOutputWithContext(ctx context.Context) LookupConfigResultOutput

func (LookupConfigResultOutput) Types added in v0.8.0

A list of all proto message types included in this API service. Types referenced directly or indirectly by the `apis` are automatically included. Messages which are not referenced but shall be included, such as types used by the `google.protobuf.Any` type, should be listed here by name by the configuration author. Example: types: - name: google.protobuf.Int32

func (LookupConfigResultOutput) Usage added in v0.8.0

Configuration controlling usage of this service.

type LookupRolloutArgs added in v0.4.0

type LookupRolloutArgs struct {
	RolloutId   string `pulumi:"rolloutId"`
	ServiceName string `pulumi:"serviceName"`
}

type LookupRolloutOutputArgs added in v0.8.0

type LookupRolloutOutputArgs struct {
	RolloutId   pulumi.StringInput `pulumi:"rolloutId"`
	ServiceName pulumi.StringInput `pulumi:"serviceName"`
}

func (LookupRolloutOutputArgs) ElementType added in v0.8.0

func (LookupRolloutOutputArgs) ElementType() reflect.Type

type LookupRolloutResult added in v0.4.0

type LookupRolloutResult struct {
	// Creation time of the rollout. Readonly.
	CreateTime string `pulumi:"createTime"`
	// The user who created the Rollout. Readonly.
	CreatedBy string `pulumi:"createdBy"`
	// The strategy associated with a rollout to delete a `ManagedService`. Readonly.
	DeleteServiceStrategy DeleteServiceStrategyResponse `pulumi:"deleteServiceStrategy"`
	// Optional. Unique identifier of this Rollout. Must be no longer than 63 characters and only lower case letters, digits, '.', '_' and '-' are allowed. If not specified by client, the server will generate one. The generated id will have the form of , where "date" is the create date in ISO 8601 format. "revision number" is a monotonically increasing positive number that is reset every day for each service. An example of the generated rollout_id is '2016-02-16r1'
	RolloutId string `pulumi:"rolloutId"`
	// The name of the service associated with this Rollout.
	ServiceName string `pulumi:"serviceName"`
	// The status of this rollout. Readonly. In case of a failed rollout, the system will automatically rollback to the current Rollout version. Readonly.
	Status string `pulumi:"status"`
	// Google Service Control selects service configurations based on traffic percentage.
	TrafficPercentStrategy TrafficPercentStrategyResponse `pulumi:"trafficPercentStrategy"`
}

func LookupRollout added in v0.4.0

func LookupRollout(ctx *pulumi.Context, args *LookupRolloutArgs, opts ...pulumi.InvokeOption) (*LookupRolloutResult, error)

Gets a service configuration rollout.

type LookupRolloutResultOutput added in v0.8.0

type LookupRolloutResultOutput struct{ *pulumi.OutputState }

func LookupRolloutOutput added in v0.8.0

func LookupRolloutOutput(ctx *pulumi.Context, args LookupRolloutOutputArgs, opts ...pulumi.InvokeOption) LookupRolloutResultOutput

func (LookupRolloutResultOutput) CreateTime added in v0.8.0

Creation time of the rollout. Readonly.

func (LookupRolloutResultOutput) CreatedBy added in v0.16.0

The user who created the Rollout. Readonly.

func (LookupRolloutResultOutput) DeleteServiceStrategy added in v0.8.0

The strategy associated with a rollout to delete a `ManagedService`. Readonly.

func (LookupRolloutResultOutput) ElementType added in v0.8.0

func (LookupRolloutResultOutput) ElementType() reflect.Type

func (LookupRolloutResultOutput) RolloutId added in v0.8.0

Optional. Unique identifier of this Rollout. Must be no longer than 63 characters and only lower case letters, digits, '.', '_' and '-' are allowed. If not specified by client, the server will generate one. The generated id will have the form of , where "date" is the create date in ISO 8601 format. "revision number" is a monotonically increasing positive number that is reset every day for each service. An example of the generated rollout_id is '2016-02-16r1'

func (LookupRolloutResultOutput) ServiceName added in v0.8.0

The name of the service associated with this Rollout.

func (LookupRolloutResultOutput) Status added in v0.8.0

The status of this rollout. Readonly. In case of a failed rollout, the system will automatically rollback to the current Rollout version. Readonly.

func (LookupRolloutResultOutput) ToLookupRolloutResultOutput added in v0.8.0

func (o LookupRolloutResultOutput) ToLookupRolloutResultOutput() LookupRolloutResultOutput

func (LookupRolloutResultOutput) ToLookupRolloutResultOutputWithContext added in v0.8.0

func (o LookupRolloutResultOutput) ToLookupRolloutResultOutputWithContext(ctx context.Context) LookupRolloutResultOutput

func (LookupRolloutResultOutput) TrafficPercentStrategy added in v0.8.0

Google Service Control selects service configurations based on traffic percentage.

type LookupServiceArgs added in v0.4.0

type LookupServiceArgs struct {
	ServiceName string `pulumi:"serviceName"`
}

type LookupServiceConsumerIamPolicyArgs added in v0.4.0

type LookupServiceConsumerIamPolicyArgs struct {
	ConsumerId string `pulumi:"consumerId"`
	ServiceId  string `pulumi:"serviceId"`
}

type LookupServiceConsumerIamPolicyOutputArgs added in v0.8.0

type LookupServiceConsumerIamPolicyOutputArgs struct {
	ConsumerId pulumi.StringInput `pulumi:"consumerId"`
	ServiceId  pulumi.StringInput `pulumi:"serviceId"`
}

func (LookupServiceConsumerIamPolicyOutputArgs) ElementType added in v0.8.0

type LookupServiceConsumerIamPolicyResult added in v0.4.0

type LookupServiceConsumerIamPolicyResult struct {
	// Specifies cloud audit logging configuration for this policy.
	AuditConfigs []AuditConfigResponse `pulumi:"auditConfigs"`
	// Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
	Bindings []BindingResponse `pulumi:"bindings"`
	// `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
	Etag string `pulumi:"etag"`
	// Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
	Version int `pulumi:"version"`
}

func LookupServiceConsumerIamPolicy added in v0.4.0

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

type LookupServiceConsumerIamPolicyResultOutput added in v0.8.0

type LookupServiceConsumerIamPolicyResultOutput struct{ *pulumi.OutputState }

func (LookupServiceConsumerIamPolicyResultOutput) AuditConfigs added in v0.8.0

Specifies cloud audit logging configuration for this policy.

func (LookupServiceConsumerIamPolicyResultOutput) Bindings added in v0.8.0

Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.

func (LookupServiceConsumerIamPolicyResultOutput) ElementType added in v0.8.0

func (LookupServiceConsumerIamPolicyResultOutput) Etag added in v0.8.0

`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

func (LookupServiceConsumerIamPolicyResultOutput) ToLookupServiceConsumerIamPolicyResultOutput added in v0.8.0

func (o LookupServiceConsumerIamPolicyResultOutput) ToLookupServiceConsumerIamPolicyResultOutput() LookupServiceConsumerIamPolicyResultOutput

func (LookupServiceConsumerIamPolicyResultOutput) ToLookupServiceConsumerIamPolicyResultOutputWithContext added in v0.8.0

func (o LookupServiceConsumerIamPolicyResultOutput) ToLookupServiceConsumerIamPolicyResultOutputWithContext(ctx context.Context) LookupServiceConsumerIamPolicyResultOutput

func (LookupServiceConsumerIamPolicyResultOutput) Version added in v0.8.0

Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

type LookupServiceIamPolicyArgs added in v0.4.0

type LookupServiceIamPolicyArgs struct {
	ServiceId string `pulumi:"serviceId"`
}

type LookupServiceIamPolicyOutputArgs added in v0.8.0

type LookupServiceIamPolicyOutputArgs struct {
	ServiceId pulumi.StringInput `pulumi:"serviceId"`
}

func (LookupServiceIamPolicyOutputArgs) ElementType added in v0.8.0

type LookupServiceIamPolicyResult added in v0.4.0

type LookupServiceIamPolicyResult struct {
	// Specifies cloud audit logging configuration for this policy.
	AuditConfigs []AuditConfigResponse `pulumi:"auditConfigs"`
	// Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
	Bindings []BindingResponse `pulumi:"bindings"`
	// `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
	Etag string `pulumi:"etag"`
	// Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
	Version int `pulumi:"version"`
}

func LookupServiceIamPolicy added in v0.4.0

func LookupServiceIamPolicy(ctx *pulumi.Context, args *LookupServiceIamPolicyArgs, opts ...pulumi.InvokeOption) (*LookupServiceIamPolicyResult, error)

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

type LookupServiceIamPolicyResultOutput added in v0.8.0

type LookupServiceIamPolicyResultOutput struct{ *pulumi.OutputState }

func LookupServiceIamPolicyOutput added in v0.8.0

func (LookupServiceIamPolicyResultOutput) AuditConfigs added in v0.8.0

Specifies cloud audit logging configuration for this policy.

func (LookupServiceIamPolicyResultOutput) Bindings added in v0.8.0

Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.

func (LookupServiceIamPolicyResultOutput) ElementType added in v0.8.0

func (LookupServiceIamPolicyResultOutput) Etag added in v0.8.0

`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

func (LookupServiceIamPolicyResultOutput) ToLookupServiceIamPolicyResultOutput added in v0.8.0

func (o LookupServiceIamPolicyResultOutput) ToLookupServiceIamPolicyResultOutput() LookupServiceIamPolicyResultOutput

func (LookupServiceIamPolicyResultOutput) ToLookupServiceIamPolicyResultOutputWithContext added in v0.8.0

func (o LookupServiceIamPolicyResultOutput) ToLookupServiceIamPolicyResultOutputWithContext(ctx context.Context) LookupServiceIamPolicyResultOutput

func (LookupServiceIamPolicyResultOutput) Version added in v0.8.0

Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

type LookupServiceOutputArgs added in v0.8.0

type LookupServiceOutputArgs struct {
	ServiceName pulumi.StringInput `pulumi:"serviceName"`
}

func (LookupServiceOutputArgs) ElementType added in v0.8.0

func (LookupServiceOutputArgs) ElementType() reflect.Type

type LookupServiceResult added in v0.4.0

type LookupServiceResult struct {
	// ID of the project that produces and owns this service.
	ProducerProjectId string `pulumi:"producerProjectId"`
	// The name of the service. See the [overview](https://cloud.google.com/service-infrastructure/docs/overview) for naming requirements.
	ServiceName string `pulumi:"serviceName"`
}

func LookupService added in v0.4.0

func LookupService(ctx *pulumi.Context, args *LookupServiceArgs, opts ...pulumi.InvokeOption) (*LookupServiceResult, error)

Gets a managed service. Authentication is required unless the service is public.

type LookupServiceResultOutput added in v0.8.0

type LookupServiceResultOutput struct{ *pulumi.OutputState }

func LookupServiceOutput added in v0.8.0

func LookupServiceOutput(ctx *pulumi.Context, args LookupServiceOutputArgs, opts ...pulumi.InvokeOption) LookupServiceResultOutput

func (LookupServiceResultOutput) ElementType added in v0.8.0

func (LookupServiceResultOutput) ElementType() reflect.Type

func (LookupServiceResultOutput) ProducerProjectId added in v0.8.0

func (o LookupServiceResultOutput) ProducerProjectId() pulumi.StringOutput

ID of the project that produces and owns this service.

func (LookupServiceResultOutput) ServiceName added in v0.8.0

The name of the service. See the [overview](https://cloud.google.com/service-infrastructure/docs/overview) for naming requirements.

func (LookupServiceResultOutput) ToLookupServiceResultOutput added in v0.8.0

func (o LookupServiceResultOutput) ToLookupServiceResultOutput() LookupServiceResultOutput

func (LookupServiceResultOutput) ToLookupServiceResultOutputWithContext added in v0.8.0

func (o LookupServiceResultOutput) ToLookupServiceResultOutputWithContext(ctx context.Context) LookupServiceResultOutput

type Method

type Method struct {
	// The simple name of this method.
	Name *string `pulumi:"name"`
	// Any metadata attached to the method.
	Options []Option `pulumi:"options"`
	// If true, the request is streamed.
	RequestStreaming *bool `pulumi:"requestStreaming"`
	// A URL of the input message type.
	RequestTypeUrl *string `pulumi:"requestTypeUrl"`
	// If true, the response is streamed.
	ResponseStreaming *bool `pulumi:"responseStreaming"`
	// The URL of the output message type.
	ResponseTypeUrl *string `pulumi:"responseTypeUrl"`
	// The source syntax of this method.
	Syntax *MethodSyntax `pulumi:"syntax"`
}

Method represents a method of an API interface.

type MethodArgs

type MethodArgs struct {
	// The simple name of this method.
	Name pulumi.StringPtrInput `pulumi:"name"`
	// Any metadata attached to the method.
	Options OptionArrayInput `pulumi:"options"`
	// If true, the request is streamed.
	RequestStreaming pulumi.BoolPtrInput `pulumi:"requestStreaming"`
	// A URL of the input message type.
	RequestTypeUrl pulumi.StringPtrInput `pulumi:"requestTypeUrl"`
	// If true, the response is streamed.
	ResponseStreaming pulumi.BoolPtrInput `pulumi:"responseStreaming"`
	// The URL of the output message type.
	ResponseTypeUrl pulumi.StringPtrInput `pulumi:"responseTypeUrl"`
	// The source syntax of this method.
	Syntax MethodSyntaxPtrInput `pulumi:"syntax"`
}

Method represents a method of an API interface.

func (MethodArgs) ElementType

func (MethodArgs) ElementType() reflect.Type

func (MethodArgs) ToMethodOutput

func (i MethodArgs) ToMethodOutput() MethodOutput

func (MethodArgs) ToMethodOutputWithContext

func (i MethodArgs) ToMethodOutputWithContext(ctx context.Context) MethodOutput

type MethodArray

type MethodArray []MethodInput

func (MethodArray) ElementType

func (MethodArray) ElementType() reflect.Type

func (MethodArray) ToMethodArrayOutput

func (i MethodArray) ToMethodArrayOutput() MethodArrayOutput

func (MethodArray) ToMethodArrayOutputWithContext

func (i MethodArray) ToMethodArrayOutputWithContext(ctx context.Context) MethodArrayOutput

type MethodArrayInput

type MethodArrayInput interface {
	pulumi.Input

	ToMethodArrayOutput() MethodArrayOutput
	ToMethodArrayOutputWithContext(context.Context) MethodArrayOutput
}

MethodArrayInput is an input type that accepts MethodArray and MethodArrayOutput values. You can construct a concrete instance of `MethodArrayInput` via:

MethodArray{ MethodArgs{...} }

type MethodArrayOutput

type MethodArrayOutput struct{ *pulumi.OutputState }

func (MethodArrayOutput) ElementType

func (MethodArrayOutput) ElementType() reflect.Type

func (MethodArrayOutput) Index

func (MethodArrayOutput) ToMethodArrayOutput

func (o MethodArrayOutput) ToMethodArrayOutput() MethodArrayOutput

func (MethodArrayOutput) ToMethodArrayOutputWithContext

func (o MethodArrayOutput) ToMethodArrayOutputWithContext(ctx context.Context) MethodArrayOutput

type MethodInput

type MethodInput interface {
	pulumi.Input

	ToMethodOutput() MethodOutput
	ToMethodOutputWithContext(context.Context) MethodOutput
}

MethodInput is an input type that accepts MethodArgs and MethodOutput values. You can construct a concrete instance of `MethodInput` via:

MethodArgs{...}

type MethodOutput

type MethodOutput struct{ *pulumi.OutputState }

Method represents a method of an API interface.

func (MethodOutput) ElementType

func (MethodOutput) ElementType() reflect.Type

func (MethodOutput) Name

The simple name of this method.

func (MethodOutput) Options

func (o MethodOutput) Options() OptionArrayOutput

Any metadata attached to the method.

func (MethodOutput) RequestStreaming

func (o MethodOutput) RequestStreaming() pulumi.BoolPtrOutput

If true, the request is streamed.

func (MethodOutput) RequestTypeUrl

func (o MethodOutput) RequestTypeUrl() pulumi.StringPtrOutput

A URL of the input message type.

func (MethodOutput) ResponseStreaming

func (o MethodOutput) ResponseStreaming() pulumi.BoolPtrOutput

If true, the response is streamed.

func (MethodOutput) ResponseTypeUrl

func (o MethodOutput) ResponseTypeUrl() pulumi.StringPtrOutput

The URL of the output message type.

func (MethodOutput) Syntax

The source syntax of this method.

func (MethodOutput) ToMethodOutput

func (o MethodOutput) ToMethodOutput() MethodOutput

func (MethodOutput) ToMethodOutputWithContext

func (o MethodOutput) ToMethodOutputWithContext(ctx context.Context) MethodOutput

type MethodPolicy added in v0.32.0

type MethodPolicy struct {
	// Policies that are applicable to the request message.
	RequestPolicies []FieldPolicy `pulumi:"requestPolicies"`
	// Selects a method to which these policies should be enforced, for example, "google.pubsub.v1.Subscriber.CreateSubscription". Refer to selector for syntax details. NOTE: This field must not be set in the proto annotation. It will be automatically filled by the service config compiler .
	Selector *string `pulumi:"selector"`
}

Defines policies applying to an RPC method.

type MethodPolicyArgs added in v0.32.0

type MethodPolicyArgs struct {
	// Policies that are applicable to the request message.
	RequestPolicies FieldPolicyArrayInput `pulumi:"requestPolicies"`
	// Selects a method to which these policies should be enforced, for example, "google.pubsub.v1.Subscriber.CreateSubscription". Refer to selector for syntax details. NOTE: This field must not be set in the proto annotation. It will be automatically filled by the service config compiler .
	Selector pulumi.StringPtrInput `pulumi:"selector"`
}

Defines policies applying to an RPC method.

func (MethodPolicyArgs) ElementType added in v0.32.0

func (MethodPolicyArgs) ElementType() reflect.Type

func (MethodPolicyArgs) ToMethodPolicyOutput added in v0.32.0

func (i MethodPolicyArgs) ToMethodPolicyOutput() MethodPolicyOutput

func (MethodPolicyArgs) ToMethodPolicyOutputWithContext added in v0.32.0

func (i MethodPolicyArgs) ToMethodPolicyOutputWithContext(ctx context.Context) MethodPolicyOutput

type MethodPolicyArray added in v0.32.0

type MethodPolicyArray []MethodPolicyInput

func (MethodPolicyArray) ElementType added in v0.32.0

func (MethodPolicyArray) ElementType() reflect.Type

func (MethodPolicyArray) ToMethodPolicyArrayOutput added in v0.32.0

func (i MethodPolicyArray) ToMethodPolicyArrayOutput() MethodPolicyArrayOutput

func (MethodPolicyArray) ToMethodPolicyArrayOutputWithContext added in v0.32.0

func (i MethodPolicyArray) ToMethodPolicyArrayOutputWithContext(ctx context.Context) MethodPolicyArrayOutput

type MethodPolicyArrayInput added in v0.32.0

type MethodPolicyArrayInput interface {
	pulumi.Input

	ToMethodPolicyArrayOutput() MethodPolicyArrayOutput
	ToMethodPolicyArrayOutputWithContext(context.Context) MethodPolicyArrayOutput
}

MethodPolicyArrayInput is an input type that accepts MethodPolicyArray and MethodPolicyArrayOutput values. You can construct a concrete instance of `MethodPolicyArrayInput` via:

MethodPolicyArray{ MethodPolicyArgs{...} }

type MethodPolicyArrayOutput added in v0.32.0

type MethodPolicyArrayOutput struct{ *pulumi.OutputState }

func (MethodPolicyArrayOutput) ElementType added in v0.32.0

func (MethodPolicyArrayOutput) ElementType() reflect.Type

func (MethodPolicyArrayOutput) Index added in v0.32.0

func (MethodPolicyArrayOutput) ToMethodPolicyArrayOutput added in v0.32.0

func (o MethodPolicyArrayOutput) ToMethodPolicyArrayOutput() MethodPolicyArrayOutput

func (MethodPolicyArrayOutput) ToMethodPolicyArrayOutputWithContext added in v0.32.0

func (o MethodPolicyArrayOutput) ToMethodPolicyArrayOutputWithContext(ctx context.Context) MethodPolicyArrayOutput

type MethodPolicyInput added in v0.32.0

type MethodPolicyInput interface {
	pulumi.Input

	ToMethodPolicyOutput() MethodPolicyOutput
	ToMethodPolicyOutputWithContext(context.Context) MethodPolicyOutput
}

MethodPolicyInput is an input type that accepts MethodPolicyArgs and MethodPolicyOutput values. You can construct a concrete instance of `MethodPolicyInput` via:

MethodPolicyArgs{...}

type MethodPolicyOutput added in v0.32.0

type MethodPolicyOutput struct{ *pulumi.OutputState }

Defines policies applying to an RPC method.

func (MethodPolicyOutput) ElementType added in v0.32.0

func (MethodPolicyOutput) ElementType() reflect.Type

func (MethodPolicyOutput) RequestPolicies added in v0.32.0

func (o MethodPolicyOutput) RequestPolicies() FieldPolicyArrayOutput

Policies that are applicable to the request message.

func (MethodPolicyOutput) Selector added in v0.32.0

Selects a method to which these policies should be enforced, for example, "google.pubsub.v1.Subscriber.CreateSubscription". Refer to selector for syntax details. NOTE: This field must not be set in the proto annotation. It will be automatically filled by the service config compiler .

func (MethodPolicyOutput) ToMethodPolicyOutput added in v0.32.0

func (o MethodPolicyOutput) ToMethodPolicyOutput() MethodPolicyOutput

func (MethodPolicyOutput) ToMethodPolicyOutputWithContext added in v0.32.0

func (o MethodPolicyOutput) ToMethodPolicyOutputWithContext(ctx context.Context) MethodPolicyOutput

type MethodPolicyResponse added in v0.32.0

type MethodPolicyResponse struct {
	// Policies that are applicable to the request message.
	RequestPolicies []FieldPolicyResponse `pulumi:"requestPolicies"`
	// Selects a method to which these policies should be enforced, for example, "google.pubsub.v1.Subscriber.CreateSubscription". Refer to selector for syntax details. NOTE: This field must not be set in the proto annotation. It will be automatically filled by the service config compiler .
	Selector string `pulumi:"selector"`
}

Defines policies applying to an RPC method.

type MethodPolicyResponseArrayOutput added in v0.32.0

type MethodPolicyResponseArrayOutput struct{ *pulumi.OutputState }

func (MethodPolicyResponseArrayOutput) ElementType added in v0.32.0

func (MethodPolicyResponseArrayOutput) Index added in v0.32.0

func (MethodPolicyResponseArrayOutput) ToMethodPolicyResponseArrayOutput added in v0.32.0

func (o MethodPolicyResponseArrayOutput) ToMethodPolicyResponseArrayOutput() MethodPolicyResponseArrayOutput

func (MethodPolicyResponseArrayOutput) ToMethodPolicyResponseArrayOutputWithContext added in v0.32.0

func (o MethodPolicyResponseArrayOutput) ToMethodPolicyResponseArrayOutputWithContext(ctx context.Context) MethodPolicyResponseArrayOutput

type MethodPolicyResponseOutput added in v0.32.0

type MethodPolicyResponseOutput struct{ *pulumi.OutputState }

Defines policies applying to an RPC method.

func (MethodPolicyResponseOutput) ElementType added in v0.32.0

func (MethodPolicyResponseOutput) ElementType() reflect.Type

func (MethodPolicyResponseOutput) RequestPolicies added in v0.32.0

Policies that are applicable to the request message.

func (MethodPolicyResponseOutput) Selector added in v0.32.0

Selects a method to which these policies should be enforced, for example, "google.pubsub.v1.Subscriber.CreateSubscription". Refer to selector for syntax details. NOTE: This field must not be set in the proto annotation. It will be automatically filled by the service config compiler .

func (MethodPolicyResponseOutput) ToMethodPolicyResponseOutput added in v0.32.0

func (o MethodPolicyResponseOutput) ToMethodPolicyResponseOutput() MethodPolicyResponseOutput

func (MethodPolicyResponseOutput) ToMethodPolicyResponseOutputWithContext added in v0.32.0

func (o MethodPolicyResponseOutput) ToMethodPolicyResponseOutputWithContext(ctx context.Context) MethodPolicyResponseOutput

type MethodResponse

type MethodResponse struct {
	// The simple name of this method.
	Name string `pulumi:"name"`
	// Any metadata attached to the method.
	Options []OptionResponse `pulumi:"options"`
	// If true, the request is streamed.
	RequestStreaming bool `pulumi:"requestStreaming"`
	// A URL of the input message type.
	RequestTypeUrl string `pulumi:"requestTypeUrl"`
	// If true, the response is streamed.
	ResponseStreaming bool `pulumi:"responseStreaming"`
	// The URL of the output message type.
	ResponseTypeUrl string `pulumi:"responseTypeUrl"`
	// The source syntax of this method.
	Syntax string `pulumi:"syntax"`
}

Method represents a method of an API interface.

type MethodResponseArrayOutput

type MethodResponseArrayOutput struct{ *pulumi.OutputState }

func (MethodResponseArrayOutput) ElementType

func (MethodResponseArrayOutput) ElementType() reflect.Type

func (MethodResponseArrayOutput) Index

func (MethodResponseArrayOutput) ToMethodResponseArrayOutput

func (o MethodResponseArrayOutput) ToMethodResponseArrayOutput() MethodResponseArrayOutput

func (MethodResponseArrayOutput) ToMethodResponseArrayOutputWithContext

func (o MethodResponseArrayOutput) ToMethodResponseArrayOutputWithContext(ctx context.Context) MethodResponseArrayOutput

type MethodResponseOutput

type MethodResponseOutput struct{ *pulumi.OutputState }

Method represents a method of an API interface.

func (MethodResponseOutput) ElementType

func (MethodResponseOutput) ElementType() reflect.Type

func (MethodResponseOutput) Name

The simple name of this method.

func (MethodResponseOutput) Options

Any metadata attached to the method.

func (MethodResponseOutput) RequestStreaming

func (o MethodResponseOutput) RequestStreaming() pulumi.BoolOutput

If true, the request is streamed.

func (MethodResponseOutput) RequestTypeUrl

func (o MethodResponseOutput) RequestTypeUrl() pulumi.StringOutput

A URL of the input message type.

func (MethodResponseOutput) ResponseStreaming

func (o MethodResponseOutput) ResponseStreaming() pulumi.BoolOutput

If true, the response is streamed.

func (MethodResponseOutput) ResponseTypeUrl

func (o MethodResponseOutput) ResponseTypeUrl() pulumi.StringOutput

The URL of the output message type.

func (MethodResponseOutput) Syntax

The source syntax of this method.

func (MethodResponseOutput) ToMethodResponseOutput

func (o MethodResponseOutput) ToMethodResponseOutput() MethodResponseOutput

func (MethodResponseOutput) ToMethodResponseOutputWithContext

func (o MethodResponseOutput) ToMethodResponseOutputWithContext(ctx context.Context) MethodResponseOutput

type MethodSettings added in v0.28.0

type MethodSettings struct {
	// Describes settings to use for long-running operations when generating API methods for RPCs. Complements RPCs that use the annotations in google/longrunning/operations.proto. Example of a YAML configuration:: publishing: method_settings: - selector: google.cloud.speech.v2.Speech.BatchRecognize long_running: initial_poll_delay: seconds: 60 # 1 minute poll_delay_multiplier: 1.5 max_poll_delay: seconds: 360 # 6 minutes total_poll_timeout: seconds: 54000 # 90 minutes
	LongRunning *LongRunning `pulumi:"longRunning"`
	// The fully qualified name of the method, for which the options below apply. This is used to find the method to apply the options.
	Selector *string `pulumi:"selector"`
}

Describes the generator configuration for a method.

type MethodSettingsArgs added in v0.28.0

type MethodSettingsArgs struct {
	// Describes settings to use for long-running operations when generating API methods for RPCs. Complements RPCs that use the annotations in google/longrunning/operations.proto. Example of a YAML configuration:: publishing: method_settings: - selector: google.cloud.speech.v2.Speech.BatchRecognize long_running: initial_poll_delay: seconds: 60 # 1 minute poll_delay_multiplier: 1.5 max_poll_delay: seconds: 360 # 6 minutes total_poll_timeout: seconds: 54000 # 90 minutes
	LongRunning LongRunningPtrInput `pulumi:"longRunning"`
	// The fully qualified name of the method, for which the options below apply. This is used to find the method to apply the options.
	Selector pulumi.StringPtrInput `pulumi:"selector"`
}

Describes the generator configuration for a method.

func (MethodSettingsArgs) ElementType added in v0.28.0

func (MethodSettingsArgs) ElementType() reflect.Type

func (MethodSettingsArgs) ToMethodSettingsOutput added in v0.28.0

func (i MethodSettingsArgs) ToMethodSettingsOutput() MethodSettingsOutput

func (MethodSettingsArgs) ToMethodSettingsOutputWithContext added in v0.28.0

func (i MethodSettingsArgs) ToMethodSettingsOutputWithContext(ctx context.Context) MethodSettingsOutput

type MethodSettingsArray added in v0.28.0

type MethodSettingsArray []MethodSettingsInput

func (MethodSettingsArray) ElementType added in v0.28.0

func (MethodSettingsArray) ElementType() reflect.Type

func (MethodSettingsArray) ToMethodSettingsArrayOutput added in v0.28.0

func (i MethodSettingsArray) ToMethodSettingsArrayOutput() MethodSettingsArrayOutput

func (MethodSettingsArray) ToMethodSettingsArrayOutputWithContext added in v0.28.0

func (i MethodSettingsArray) ToMethodSettingsArrayOutputWithContext(ctx context.Context) MethodSettingsArrayOutput

type MethodSettingsArrayInput added in v0.28.0

type MethodSettingsArrayInput interface {
	pulumi.Input

	ToMethodSettingsArrayOutput() MethodSettingsArrayOutput
	ToMethodSettingsArrayOutputWithContext(context.Context) MethodSettingsArrayOutput
}

MethodSettingsArrayInput is an input type that accepts MethodSettingsArray and MethodSettingsArrayOutput values. You can construct a concrete instance of `MethodSettingsArrayInput` via:

MethodSettingsArray{ MethodSettingsArgs{...} }

type MethodSettingsArrayOutput added in v0.28.0

type MethodSettingsArrayOutput struct{ *pulumi.OutputState }

func (MethodSettingsArrayOutput) ElementType added in v0.28.0

func (MethodSettingsArrayOutput) ElementType() reflect.Type

func (MethodSettingsArrayOutput) Index added in v0.28.0

func (MethodSettingsArrayOutput) ToMethodSettingsArrayOutput added in v0.28.0

func (o MethodSettingsArrayOutput) ToMethodSettingsArrayOutput() MethodSettingsArrayOutput

func (MethodSettingsArrayOutput) ToMethodSettingsArrayOutputWithContext added in v0.28.0

func (o MethodSettingsArrayOutput) ToMethodSettingsArrayOutputWithContext(ctx context.Context) MethodSettingsArrayOutput

type MethodSettingsInput added in v0.28.0

type MethodSettingsInput interface {
	pulumi.Input

	ToMethodSettingsOutput() MethodSettingsOutput
	ToMethodSettingsOutputWithContext(context.Context) MethodSettingsOutput
}

MethodSettingsInput is an input type that accepts MethodSettingsArgs and MethodSettingsOutput values. You can construct a concrete instance of `MethodSettingsInput` via:

MethodSettingsArgs{...}

type MethodSettingsOutput added in v0.28.0

type MethodSettingsOutput struct{ *pulumi.OutputState }

Describes the generator configuration for a method.

func (MethodSettingsOutput) ElementType added in v0.28.0

func (MethodSettingsOutput) ElementType() reflect.Type

func (MethodSettingsOutput) LongRunning added in v0.28.0

Describes settings to use for long-running operations when generating API methods for RPCs. Complements RPCs that use the annotations in google/longrunning/operations.proto. Example of a YAML configuration:: publishing: method_settings: - selector: google.cloud.speech.v2.Speech.BatchRecognize long_running: initial_poll_delay: seconds: 60 # 1 minute poll_delay_multiplier: 1.5 max_poll_delay: seconds: 360 # 6 minutes total_poll_timeout: seconds: 54000 # 90 minutes

func (MethodSettingsOutput) Selector added in v0.28.0

The fully qualified name of the method, for which the options below apply. This is used to find the method to apply the options.

func (MethodSettingsOutput) ToMethodSettingsOutput added in v0.28.0

func (o MethodSettingsOutput) ToMethodSettingsOutput() MethodSettingsOutput

func (MethodSettingsOutput) ToMethodSettingsOutputWithContext added in v0.28.0

func (o MethodSettingsOutput) ToMethodSettingsOutputWithContext(ctx context.Context) MethodSettingsOutput

type MethodSettingsResponse added in v0.28.0

type MethodSettingsResponse struct {
	// Describes settings to use for long-running operations when generating API methods for RPCs. Complements RPCs that use the annotations in google/longrunning/operations.proto. Example of a YAML configuration:: publishing: method_settings: - selector: google.cloud.speech.v2.Speech.BatchRecognize long_running: initial_poll_delay: seconds: 60 # 1 minute poll_delay_multiplier: 1.5 max_poll_delay: seconds: 360 # 6 minutes total_poll_timeout: seconds: 54000 # 90 minutes
	LongRunning LongRunningResponse `pulumi:"longRunning"`
	// The fully qualified name of the method, for which the options below apply. This is used to find the method to apply the options.
	Selector string `pulumi:"selector"`
}

Describes the generator configuration for a method.

type MethodSettingsResponseArrayOutput added in v0.28.0

type MethodSettingsResponseArrayOutput struct{ *pulumi.OutputState }

func (MethodSettingsResponseArrayOutput) ElementType added in v0.28.0

func (MethodSettingsResponseArrayOutput) Index added in v0.28.0

func (MethodSettingsResponseArrayOutput) ToMethodSettingsResponseArrayOutput added in v0.28.0

func (o MethodSettingsResponseArrayOutput) ToMethodSettingsResponseArrayOutput() MethodSettingsResponseArrayOutput

func (MethodSettingsResponseArrayOutput) ToMethodSettingsResponseArrayOutputWithContext added in v0.28.0

func (o MethodSettingsResponseArrayOutput) ToMethodSettingsResponseArrayOutputWithContext(ctx context.Context) MethodSettingsResponseArrayOutput

type MethodSettingsResponseOutput added in v0.28.0

type MethodSettingsResponseOutput struct{ *pulumi.OutputState }

Describes the generator configuration for a method.

func (MethodSettingsResponseOutput) ElementType added in v0.28.0

func (MethodSettingsResponseOutput) LongRunning added in v0.28.0

Describes settings to use for long-running operations when generating API methods for RPCs. Complements RPCs that use the annotations in google/longrunning/operations.proto. Example of a YAML configuration:: publishing: method_settings: - selector: google.cloud.speech.v2.Speech.BatchRecognize long_running: initial_poll_delay: seconds: 60 # 1 minute poll_delay_multiplier: 1.5 max_poll_delay: seconds: 360 # 6 minutes total_poll_timeout: seconds: 54000 # 90 minutes

func (MethodSettingsResponseOutput) Selector added in v0.28.0

The fully qualified name of the method, for which the options below apply. This is used to find the method to apply the options.

func (MethodSettingsResponseOutput) ToMethodSettingsResponseOutput added in v0.28.0

func (o MethodSettingsResponseOutput) ToMethodSettingsResponseOutput() MethodSettingsResponseOutput

func (MethodSettingsResponseOutput) ToMethodSettingsResponseOutputWithContext added in v0.28.0

func (o MethodSettingsResponseOutput) ToMethodSettingsResponseOutputWithContext(ctx context.Context) MethodSettingsResponseOutput

type MethodSyntax added in v0.4.0

type MethodSyntax string

The source syntax of this method.

func (MethodSyntax) ElementType added in v0.4.0

func (MethodSyntax) ElementType() reflect.Type

func (MethodSyntax) ToMethodSyntaxOutput added in v0.6.0

func (e MethodSyntax) ToMethodSyntaxOutput() MethodSyntaxOutput

func (MethodSyntax) ToMethodSyntaxOutputWithContext added in v0.6.0

func (e MethodSyntax) ToMethodSyntaxOutputWithContext(ctx context.Context) MethodSyntaxOutput

func (MethodSyntax) ToMethodSyntaxPtrOutput added in v0.6.0

func (e MethodSyntax) ToMethodSyntaxPtrOutput() MethodSyntaxPtrOutput

func (MethodSyntax) ToMethodSyntaxPtrOutputWithContext added in v0.6.0

func (e MethodSyntax) ToMethodSyntaxPtrOutputWithContext(ctx context.Context) MethodSyntaxPtrOutput

func (MethodSyntax) ToStringOutput added in v0.4.0

func (e MethodSyntax) ToStringOutput() pulumi.StringOutput

func (MethodSyntax) ToStringOutputWithContext added in v0.4.0

func (e MethodSyntax) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (MethodSyntax) ToStringPtrOutput added in v0.4.0

func (e MethodSyntax) ToStringPtrOutput() pulumi.StringPtrOutput

func (MethodSyntax) ToStringPtrOutputWithContext added in v0.4.0

func (e MethodSyntax) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type MethodSyntaxInput added in v0.6.0

type MethodSyntaxInput interface {
	pulumi.Input

	ToMethodSyntaxOutput() MethodSyntaxOutput
	ToMethodSyntaxOutputWithContext(context.Context) MethodSyntaxOutput
}

MethodSyntaxInput is an input type that accepts MethodSyntaxArgs and MethodSyntaxOutput values. You can construct a concrete instance of `MethodSyntaxInput` via:

MethodSyntaxArgs{...}

type MethodSyntaxOutput added in v0.6.0

type MethodSyntaxOutput struct{ *pulumi.OutputState }

func (MethodSyntaxOutput) ElementType added in v0.6.0

func (MethodSyntaxOutput) ElementType() reflect.Type

func (MethodSyntaxOutput) ToMethodSyntaxOutput added in v0.6.0

func (o MethodSyntaxOutput) ToMethodSyntaxOutput() MethodSyntaxOutput

func (MethodSyntaxOutput) ToMethodSyntaxOutputWithContext added in v0.6.0

func (o MethodSyntaxOutput) ToMethodSyntaxOutputWithContext(ctx context.Context) MethodSyntaxOutput

func (MethodSyntaxOutput) ToMethodSyntaxPtrOutput added in v0.6.0

func (o MethodSyntaxOutput) ToMethodSyntaxPtrOutput() MethodSyntaxPtrOutput

func (MethodSyntaxOutput) ToMethodSyntaxPtrOutputWithContext added in v0.6.0

func (o MethodSyntaxOutput) ToMethodSyntaxPtrOutputWithContext(ctx context.Context) MethodSyntaxPtrOutput

func (MethodSyntaxOutput) ToStringOutput added in v0.6.0

func (o MethodSyntaxOutput) ToStringOutput() pulumi.StringOutput

func (MethodSyntaxOutput) ToStringOutputWithContext added in v0.6.0

func (o MethodSyntaxOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (MethodSyntaxOutput) ToStringPtrOutput added in v0.6.0

func (o MethodSyntaxOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (MethodSyntaxOutput) ToStringPtrOutputWithContext added in v0.6.0

func (o MethodSyntaxOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type MethodSyntaxPtrInput added in v0.6.0

type MethodSyntaxPtrInput interface {
	pulumi.Input

	ToMethodSyntaxPtrOutput() MethodSyntaxPtrOutput
	ToMethodSyntaxPtrOutputWithContext(context.Context) MethodSyntaxPtrOutput
}

func MethodSyntaxPtr added in v0.6.0

func MethodSyntaxPtr(v string) MethodSyntaxPtrInput

type MethodSyntaxPtrOutput added in v0.6.0

type MethodSyntaxPtrOutput struct{ *pulumi.OutputState }

func (MethodSyntaxPtrOutput) Elem added in v0.6.0

func (MethodSyntaxPtrOutput) ElementType added in v0.6.0

func (MethodSyntaxPtrOutput) ElementType() reflect.Type

func (MethodSyntaxPtrOutput) ToMethodSyntaxPtrOutput added in v0.6.0

func (o MethodSyntaxPtrOutput) ToMethodSyntaxPtrOutput() MethodSyntaxPtrOutput

func (MethodSyntaxPtrOutput) ToMethodSyntaxPtrOutputWithContext added in v0.6.0

func (o MethodSyntaxPtrOutput) ToMethodSyntaxPtrOutputWithContext(ctx context.Context) MethodSyntaxPtrOutput

func (MethodSyntaxPtrOutput) ToStringPtrOutput added in v0.6.0

func (o MethodSyntaxPtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (MethodSyntaxPtrOutput) ToStringPtrOutputWithContext added in v0.6.0

func (o MethodSyntaxPtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type MetricDescriptor

type MetricDescriptor struct {
	// A detailed description of the metric, which can be used in documentation.
	Description *string `pulumi:"description"`
	// A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota.
	DisplayName *string `pulumi:"displayName"`
	// The set of labels that can be used to describe a specific instance of this metric type. For example, the `appengine.googleapis.com/http/server/response_latencies` metric type has a label for the HTTP response code, `response_code`, so you can look at latencies for successful responses or just for responses that failed.
	Labels []LabelDescriptor `pulumi:"labels"`
	// Optional. The launch stage of the metric definition.
	LaunchStage *MetricDescriptorLaunchStage `pulumi:"launchStage"`
	// Optional. Metadata which can be used to guide usage of the metric.
	Metadata *MetricDescriptorMetadata `pulumi:"metadata"`
	// Whether the metric records instantaneous values, changes to a value, etc. Some combinations of `metric_kind` and `value_type` might not be supported.
	MetricKind *MetricDescriptorMetricKind `pulumi:"metricKind"`
	// Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here.
	MonitoredResourceTypes []string `pulumi:"monitoredResourceTypes"`
	// The resource name of the metric descriptor.
	Name *string `pulumi:"name"`
	// The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name `custom.googleapis.com` or `external.googleapis.com`. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies"
	Type *string `pulumi:"type"`
	// The units in which the metric value is reported. It is only applicable if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit` defines the representation of the stored metric values. Different systems might scale the values to be more easily displayed (so a value of `0.02kBy` _might_ be displayed as `20By`, and a value of `3523kBy` _might_ be displayed as `3.5MBy`). However, if the `unit` is `kBy`, then the value of the metric is always in thousands of bytes, no matter how it might be displayed. If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an `INT64 CUMULATIVE` metric whose `unit` is `s{CPU}` (or equivalently `1s{CPU}` or just `s`). If the job uses 12,005 CPU-seconds, then the value is written as `12005`. Alternatively, if you want a custom metric to record data in a more granular way, you can create a `DOUBLE CUMULATIVE` metric whose `unit` is `ks{CPU}`, and then write the value `12.005` (which is `12005/1000`), or use `Kis{CPU}` and write `11.723` (which is `12005/1024`). The supported units are a subset of [The Unified Code for Units of Measure](https://unitsofmeasure.org/ucum.html) standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` second * `min` minute * `h` hour * `d` day * `1` dimensionless **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `E` exa (10^18) * `Z` zetta (10^21) * `Y` yotta (10^24) * `m` milli (10^-3) * `u` micro (10^-6) * `n` nano (10^-9) * `p` pico (10^-12) * `f` femto (10^-15) * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto (10^-24) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For examples, `kBy/{email}` or `MiBy/10ms` (although you should almost never have `/s` in a metric `unit`; rates should always be computed at query time from the underlying cumulative or delta value). * `.` multiplication or composition (as an infix operator). For examples, `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: * `Annotation` is just a comment if it follows a `UNIT`. If the annotation is used alone, then the unit is equivalent to `1`. For examples, `{request}/s == 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of non-blank printable ASCII characters not containing `{` or `}`. * `1` represents a unitary [dimensionless unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in `1/s`. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as `1/d` or `{new-users}/d` (and a metric value `5` would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as `1000/d` or `k1/d` or `k{page_views}/d` (and a metric value of `5.3` would mean "5300 page views per day"). * `%` represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value `3` means "3 percent"). * `10^2.%` indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value `0.03` means "3 percent").
	Unit *string `pulumi:"unit"`
	// Whether the measurement is an integer, a floating-point number, etc. Some combinations of `metric_kind` and `value_type` might not be supported.
	ValueType *MetricDescriptorValueType `pulumi:"valueType"`
}

Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.

type MetricDescriptorArgs

type MetricDescriptorArgs struct {
	// A detailed description of the metric, which can be used in documentation.
	Description pulumi.StringPtrInput `pulumi:"description"`
	// A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota.
	DisplayName pulumi.StringPtrInput `pulumi:"displayName"`
	// The set of labels that can be used to describe a specific instance of this metric type. For example, the `appengine.googleapis.com/http/server/response_latencies` metric type has a label for the HTTP response code, `response_code`, so you can look at latencies for successful responses or just for responses that failed.
	Labels LabelDescriptorArrayInput `pulumi:"labels"`
	// Optional. The launch stage of the metric definition.
	LaunchStage MetricDescriptorLaunchStagePtrInput `pulumi:"launchStage"`
	// Optional. Metadata which can be used to guide usage of the metric.
	Metadata MetricDescriptorMetadataPtrInput `pulumi:"metadata"`
	// Whether the metric records instantaneous values, changes to a value, etc. Some combinations of `metric_kind` and `value_type` might not be supported.
	MetricKind MetricDescriptorMetricKindPtrInput `pulumi:"metricKind"`
	// Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here.
	MonitoredResourceTypes pulumi.StringArrayInput `pulumi:"monitoredResourceTypes"`
	// The resource name of the metric descriptor.
	Name pulumi.StringPtrInput `pulumi:"name"`
	// The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name `custom.googleapis.com` or `external.googleapis.com`. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies"
	Type pulumi.StringPtrInput `pulumi:"type"`
	// The units in which the metric value is reported. It is only applicable if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit` defines the representation of the stored metric values. Different systems might scale the values to be more easily displayed (so a value of `0.02kBy` _might_ be displayed as `20By`, and a value of `3523kBy` _might_ be displayed as `3.5MBy`). However, if the `unit` is `kBy`, then the value of the metric is always in thousands of bytes, no matter how it might be displayed. If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an `INT64 CUMULATIVE` metric whose `unit` is `s{CPU}` (or equivalently `1s{CPU}` or just `s`). If the job uses 12,005 CPU-seconds, then the value is written as `12005`. Alternatively, if you want a custom metric to record data in a more granular way, you can create a `DOUBLE CUMULATIVE` metric whose `unit` is `ks{CPU}`, and then write the value `12.005` (which is `12005/1000`), or use `Kis{CPU}` and write `11.723` (which is `12005/1024`). The supported units are a subset of [The Unified Code for Units of Measure](https://unitsofmeasure.org/ucum.html) standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` second * `min` minute * `h` hour * `d` day * `1` dimensionless **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `E` exa (10^18) * `Z` zetta (10^21) * `Y` yotta (10^24) * `m` milli (10^-3) * `u` micro (10^-6) * `n` nano (10^-9) * `p` pico (10^-12) * `f` femto (10^-15) * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto (10^-24) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For examples, `kBy/{email}` or `MiBy/10ms` (although you should almost never have `/s` in a metric `unit`; rates should always be computed at query time from the underlying cumulative or delta value). * `.` multiplication or composition (as an infix operator). For examples, `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: * `Annotation` is just a comment if it follows a `UNIT`. If the annotation is used alone, then the unit is equivalent to `1`. For examples, `{request}/s == 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of non-blank printable ASCII characters not containing `{` or `}`. * `1` represents a unitary [dimensionless unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in `1/s`. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as `1/d` or `{new-users}/d` (and a metric value `5` would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as `1000/d` or `k1/d` or `k{page_views}/d` (and a metric value of `5.3` would mean "5300 page views per day"). * `%` represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value `3` means "3 percent"). * `10^2.%` indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value `0.03` means "3 percent").
	Unit pulumi.StringPtrInput `pulumi:"unit"`
	// Whether the measurement is an integer, a floating-point number, etc. Some combinations of `metric_kind` and `value_type` might not be supported.
	ValueType MetricDescriptorValueTypePtrInput `pulumi:"valueType"`
}

Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.

func (MetricDescriptorArgs) ElementType

func (MetricDescriptorArgs) ElementType() reflect.Type

func (MetricDescriptorArgs) ToMetricDescriptorOutput

func (i MetricDescriptorArgs) ToMetricDescriptorOutput() MetricDescriptorOutput

func (MetricDescriptorArgs) ToMetricDescriptorOutputWithContext

func (i MetricDescriptorArgs) ToMetricDescriptorOutputWithContext(ctx context.Context) MetricDescriptorOutput

type MetricDescriptorArray

type MetricDescriptorArray []MetricDescriptorInput

func (MetricDescriptorArray) ElementType

func (MetricDescriptorArray) ElementType() reflect.Type

func (MetricDescriptorArray) ToMetricDescriptorArrayOutput

func (i MetricDescriptorArray) ToMetricDescriptorArrayOutput() MetricDescriptorArrayOutput

func (MetricDescriptorArray) ToMetricDescriptorArrayOutputWithContext

func (i MetricDescriptorArray) ToMetricDescriptorArrayOutputWithContext(ctx context.Context) MetricDescriptorArrayOutput

type MetricDescriptorArrayInput

type MetricDescriptorArrayInput interface {
	pulumi.Input

	ToMetricDescriptorArrayOutput() MetricDescriptorArrayOutput
	ToMetricDescriptorArrayOutputWithContext(context.Context) MetricDescriptorArrayOutput
}

MetricDescriptorArrayInput is an input type that accepts MetricDescriptorArray and MetricDescriptorArrayOutput values. You can construct a concrete instance of `MetricDescriptorArrayInput` via:

MetricDescriptorArray{ MetricDescriptorArgs{...} }

type MetricDescriptorArrayOutput

type MetricDescriptorArrayOutput struct{ *pulumi.OutputState }

func (MetricDescriptorArrayOutput) ElementType

func (MetricDescriptorArrayOutput) Index

func (MetricDescriptorArrayOutput) ToMetricDescriptorArrayOutput

func (o MetricDescriptorArrayOutput) ToMetricDescriptorArrayOutput() MetricDescriptorArrayOutput

func (MetricDescriptorArrayOutput) ToMetricDescriptorArrayOutputWithContext

func (o MetricDescriptorArrayOutput) ToMetricDescriptorArrayOutputWithContext(ctx context.Context) MetricDescriptorArrayOutput

type MetricDescriptorInput

type MetricDescriptorInput interface {
	pulumi.Input

	ToMetricDescriptorOutput() MetricDescriptorOutput
	ToMetricDescriptorOutputWithContext(context.Context) MetricDescriptorOutput
}

MetricDescriptorInput is an input type that accepts MetricDescriptorArgs and MetricDescriptorOutput values. You can construct a concrete instance of `MetricDescriptorInput` via:

MetricDescriptorArgs{...}

type MetricDescriptorLaunchStage added in v0.4.0

type MetricDescriptorLaunchStage string

Optional. The launch stage of the metric definition.

func (MetricDescriptorLaunchStage) ElementType added in v0.4.0

func (MetricDescriptorLaunchStage) ToMetricDescriptorLaunchStageOutput added in v0.6.0

func (e MetricDescriptorLaunchStage) ToMetricDescriptorLaunchStageOutput() MetricDescriptorLaunchStageOutput

func (MetricDescriptorLaunchStage) ToMetricDescriptorLaunchStageOutputWithContext added in v0.6.0

func (e MetricDescriptorLaunchStage) ToMetricDescriptorLaunchStageOutputWithContext(ctx context.Context) MetricDescriptorLaunchStageOutput

func (MetricDescriptorLaunchStage) ToMetricDescriptorLaunchStagePtrOutput added in v0.6.0

func (e MetricDescriptorLaunchStage) ToMetricDescriptorLaunchStagePtrOutput() MetricDescriptorLaunchStagePtrOutput

func (MetricDescriptorLaunchStage) ToMetricDescriptorLaunchStagePtrOutputWithContext added in v0.6.0

func (e MetricDescriptorLaunchStage) ToMetricDescriptorLaunchStagePtrOutputWithContext(ctx context.Context) MetricDescriptorLaunchStagePtrOutput

func (MetricDescriptorLaunchStage) ToStringOutput added in v0.4.0

func (e MetricDescriptorLaunchStage) ToStringOutput() pulumi.StringOutput

func (MetricDescriptorLaunchStage) ToStringOutputWithContext added in v0.4.0

func (e MetricDescriptorLaunchStage) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (MetricDescriptorLaunchStage) ToStringPtrOutput added in v0.4.0

func (e MetricDescriptorLaunchStage) ToStringPtrOutput() pulumi.StringPtrOutput

func (MetricDescriptorLaunchStage) ToStringPtrOutputWithContext added in v0.4.0

func (e MetricDescriptorLaunchStage) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type MetricDescriptorLaunchStageInput added in v0.6.0

type MetricDescriptorLaunchStageInput interface {
	pulumi.Input

	ToMetricDescriptorLaunchStageOutput() MetricDescriptorLaunchStageOutput
	ToMetricDescriptorLaunchStageOutputWithContext(context.Context) MetricDescriptorLaunchStageOutput
}

MetricDescriptorLaunchStageInput is an input type that accepts MetricDescriptorLaunchStageArgs and MetricDescriptorLaunchStageOutput values. You can construct a concrete instance of `MetricDescriptorLaunchStageInput` via:

MetricDescriptorLaunchStageArgs{...}

type MetricDescriptorLaunchStageOutput added in v0.6.0

type MetricDescriptorLaunchStageOutput struct{ *pulumi.OutputState }

func (MetricDescriptorLaunchStageOutput) ElementType added in v0.6.0

func (MetricDescriptorLaunchStageOutput) ToMetricDescriptorLaunchStageOutput added in v0.6.0

func (o MetricDescriptorLaunchStageOutput) ToMetricDescriptorLaunchStageOutput() MetricDescriptorLaunchStageOutput

func (MetricDescriptorLaunchStageOutput) ToMetricDescriptorLaunchStageOutputWithContext added in v0.6.0

func (o MetricDescriptorLaunchStageOutput) ToMetricDescriptorLaunchStageOutputWithContext(ctx context.Context) MetricDescriptorLaunchStageOutput

func (MetricDescriptorLaunchStageOutput) ToMetricDescriptorLaunchStagePtrOutput added in v0.6.0

func (o MetricDescriptorLaunchStageOutput) ToMetricDescriptorLaunchStagePtrOutput() MetricDescriptorLaunchStagePtrOutput

func (MetricDescriptorLaunchStageOutput) ToMetricDescriptorLaunchStagePtrOutputWithContext added in v0.6.0

func (o MetricDescriptorLaunchStageOutput) ToMetricDescriptorLaunchStagePtrOutputWithContext(ctx context.Context) MetricDescriptorLaunchStagePtrOutput

func (MetricDescriptorLaunchStageOutput) ToStringOutput added in v0.6.0

func (MetricDescriptorLaunchStageOutput) ToStringOutputWithContext added in v0.6.0

func (o MetricDescriptorLaunchStageOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (MetricDescriptorLaunchStageOutput) ToStringPtrOutput added in v0.6.0

func (MetricDescriptorLaunchStageOutput) ToStringPtrOutputWithContext added in v0.6.0

func (o MetricDescriptorLaunchStageOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type MetricDescriptorLaunchStagePtrInput added in v0.6.0

type MetricDescriptorLaunchStagePtrInput interface {
	pulumi.Input

	ToMetricDescriptorLaunchStagePtrOutput() MetricDescriptorLaunchStagePtrOutput
	ToMetricDescriptorLaunchStagePtrOutputWithContext(context.Context) MetricDescriptorLaunchStagePtrOutput
}

func MetricDescriptorLaunchStagePtr added in v0.6.0

func MetricDescriptorLaunchStagePtr(v string) MetricDescriptorLaunchStagePtrInput

type MetricDescriptorLaunchStagePtrOutput added in v0.6.0

type MetricDescriptorLaunchStagePtrOutput struct{ *pulumi.OutputState }

func (MetricDescriptorLaunchStagePtrOutput) Elem added in v0.6.0

func (MetricDescriptorLaunchStagePtrOutput) ElementType added in v0.6.0

func (MetricDescriptorLaunchStagePtrOutput) ToMetricDescriptorLaunchStagePtrOutput added in v0.6.0

func (o MetricDescriptorLaunchStagePtrOutput) ToMetricDescriptorLaunchStagePtrOutput() MetricDescriptorLaunchStagePtrOutput

func (MetricDescriptorLaunchStagePtrOutput) ToMetricDescriptorLaunchStagePtrOutputWithContext added in v0.6.0

func (o MetricDescriptorLaunchStagePtrOutput) ToMetricDescriptorLaunchStagePtrOutputWithContext(ctx context.Context) MetricDescriptorLaunchStagePtrOutput

func (MetricDescriptorLaunchStagePtrOutput) ToStringPtrOutput added in v0.6.0

func (MetricDescriptorLaunchStagePtrOutput) ToStringPtrOutputWithContext added in v0.6.0

func (o MetricDescriptorLaunchStagePtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type MetricDescriptorMetadata

type MetricDescriptorMetadata struct {
	// The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.
	IngestDelay *string `pulumi:"ingestDelay"`
	// Deprecated. Must use the MetricDescriptor.launch_stage instead.
	//
	// Deprecated: Deprecated. Must use the MetricDescriptor.launch_stage instead.
	LaunchStage *MetricDescriptorMetadataLaunchStage `pulumi:"launchStage"`
	// The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.
	SamplePeriod *string `pulumi:"samplePeriod"`
}

Additional annotations that can be used to guide the usage of a metric.

type MetricDescriptorMetadataArgs

type MetricDescriptorMetadataArgs struct {
	// The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.
	IngestDelay pulumi.StringPtrInput `pulumi:"ingestDelay"`
	// Deprecated. Must use the MetricDescriptor.launch_stage instead.
	//
	// Deprecated: Deprecated. Must use the MetricDescriptor.launch_stage instead.
	LaunchStage MetricDescriptorMetadataLaunchStagePtrInput `pulumi:"launchStage"`
	// The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.
	SamplePeriod pulumi.StringPtrInput `pulumi:"samplePeriod"`
}

Additional annotations that can be used to guide the usage of a metric.

func (MetricDescriptorMetadataArgs) ElementType

func (MetricDescriptorMetadataArgs) ToMetricDescriptorMetadataOutput

func (i MetricDescriptorMetadataArgs) ToMetricDescriptorMetadataOutput() MetricDescriptorMetadataOutput

func (MetricDescriptorMetadataArgs) ToMetricDescriptorMetadataOutputWithContext

func (i MetricDescriptorMetadataArgs) ToMetricDescriptorMetadataOutputWithContext(ctx context.Context) MetricDescriptorMetadataOutput

func (MetricDescriptorMetadataArgs) ToMetricDescriptorMetadataPtrOutput

func (i MetricDescriptorMetadataArgs) ToMetricDescriptorMetadataPtrOutput() MetricDescriptorMetadataPtrOutput

func (MetricDescriptorMetadataArgs) ToMetricDescriptorMetadataPtrOutputWithContext

func (i MetricDescriptorMetadataArgs) ToMetricDescriptorMetadataPtrOutputWithContext(ctx context.Context) MetricDescriptorMetadataPtrOutput

type MetricDescriptorMetadataInput

type MetricDescriptorMetadataInput interface {
	pulumi.Input

	ToMetricDescriptorMetadataOutput() MetricDescriptorMetadataOutput
	ToMetricDescriptorMetadataOutputWithContext(context.Context) MetricDescriptorMetadataOutput
}

MetricDescriptorMetadataInput is an input type that accepts MetricDescriptorMetadataArgs and MetricDescriptorMetadataOutput values. You can construct a concrete instance of `MetricDescriptorMetadataInput` via:

MetricDescriptorMetadataArgs{...}

type MetricDescriptorMetadataLaunchStage added in v0.17.0

type MetricDescriptorMetadataLaunchStage string

Deprecated. Must use the MetricDescriptor.launch_stage instead.

func (MetricDescriptorMetadataLaunchStage) ElementType added in v0.17.0

func (MetricDescriptorMetadataLaunchStage) ToMetricDescriptorMetadataLaunchStageOutput added in v0.17.0

func (e MetricDescriptorMetadataLaunchStage) ToMetricDescriptorMetadataLaunchStageOutput() MetricDescriptorMetadataLaunchStageOutput

func (MetricDescriptorMetadataLaunchStage) ToMetricDescriptorMetadataLaunchStageOutputWithContext added in v0.17.0

func (e MetricDescriptorMetadataLaunchStage) ToMetricDescriptorMetadataLaunchStageOutputWithContext(ctx context.Context) MetricDescriptorMetadataLaunchStageOutput

func (MetricDescriptorMetadataLaunchStage) ToMetricDescriptorMetadataLaunchStagePtrOutput added in v0.17.0

func (e MetricDescriptorMetadataLaunchStage) ToMetricDescriptorMetadataLaunchStagePtrOutput() MetricDescriptorMetadataLaunchStagePtrOutput

func (MetricDescriptorMetadataLaunchStage) ToMetricDescriptorMetadataLaunchStagePtrOutputWithContext added in v0.17.0

func (e MetricDescriptorMetadataLaunchStage) ToMetricDescriptorMetadataLaunchStagePtrOutputWithContext(ctx context.Context) MetricDescriptorMetadataLaunchStagePtrOutput

func (MetricDescriptorMetadataLaunchStage) ToStringOutput added in v0.17.0

func (MetricDescriptorMetadataLaunchStage) ToStringOutputWithContext added in v0.17.0

func (e MetricDescriptorMetadataLaunchStage) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (MetricDescriptorMetadataLaunchStage) ToStringPtrOutput added in v0.17.0

func (MetricDescriptorMetadataLaunchStage) ToStringPtrOutputWithContext added in v0.17.0

func (e MetricDescriptorMetadataLaunchStage) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type MetricDescriptorMetadataLaunchStageInput added in v0.17.0

type MetricDescriptorMetadataLaunchStageInput interface {
	pulumi.Input

	ToMetricDescriptorMetadataLaunchStageOutput() MetricDescriptorMetadataLaunchStageOutput
	ToMetricDescriptorMetadataLaunchStageOutputWithContext(context.Context) MetricDescriptorMetadataLaunchStageOutput
}

MetricDescriptorMetadataLaunchStageInput is an input type that accepts MetricDescriptorMetadataLaunchStageArgs and MetricDescriptorMetadataLaunchStageOutput values. You can construct a concrete instance of `MetricDescriptorMetadataLaunchStageInput` via:

MetricDescriptorMetadataLaunchStageArgs{...}

type MetricDescriptorMetadataLaunchStageOutput added in v0.17.0

type MetricDescriptorMetadataLaunchStageOutput struct{ *pulumi.OutputState }

func (MetricDescriptorMetadataLaunchStageOutput) ElementType added in v0.17.0

func (MetricDescriptorMetadataLaunchStageOutput) ToMetricDescriptorMetadataLaunchStageOutput added in v0.17.0

func (o MetricDescriptorMetadataLaunchStageOutput) ToMetricDescriptorMetadataLaunchStageOutput() MetricDescriptorMetadataLaunchStageOutput

func (MetricDescriptorMetadataLaunchStageOutput) ToMetricDescriptorMetadataLaunchStageOutputWithContext added in v0.17.0

func (o MetricDescriptorMetadataLaunchStageOutput) ToMetricDescriptorMetadataLaunchStageOutputWithContext(ctx context.Context) MetricDescriptorMetadataLaunchStageOutput

func (MetricDescriptorMetadataLaunchStageOutput) ToMetricDescriptorMetadataLaunchStagePtrOutput added in v0.17.0

func (o MetricDescriptorMetadataLaunchStageOutput) ToMetricDescriptorMetadataLaunchStagePtrOutput() MetricDescriptorMetadataLaunchStagePtrOutput

func (MetricDescriptorMetadataLaunchStageOutput) ToMetricDescriptorMetadataLaunchStagePtrOutputWithContext added in v0.17.0

func (o MetricDescriptorMetadataLaunchStageOutput) ToMetricDescriptorMetadataLaunchStagePtrOutputWithContext(ctx context.Context) MetricDescriptorMetadataLaunchStagePtrOutput

func (MetricDescriptorMetadataLaunchStageOutput) ToStringOutput added in v0.17.0

func (MetricDescriptorMetadataLaunchStageOutput) ToStringOutputWithContext added in v0.17.0

func (MetricDescriptorMetadataLaunchStageOutput) ToStringPtrOutput added in v0.17.0

func (MetricDescriptorMetadataLaunchStageOutput) ToStringPtrOutputWithContext added in v0.17.0

type MetricDescriptorMetadataLaunchStagePtrInput added in v0.17.0

type MetricDescriptorMetadataLaunchStagePtrInput interface {
	pulumi.Input

	ToMetricDescriptorMetadataLaunchStagePtrOutput() MetricDescriptorMetadataLaunchStagePtrOutput
	ToMetricDescriptorMetadataLaunchStagePtrOutputWithContext(context.Context) MetricDescriptorMetadataLaunchStagePtrOutput
}

func MetricDescriptorMetadataLaunchStagePtr added in v0.17.0

func MetricDescriptorMetadataLaunchStagePtr(v string) MetricDescriptorMetadataLaunchStagePtrInput

type MetricDescriptorMetadataLaunchStagePtrOutput added in v0.17.0

type MetricDescriptorMetadataLaunchStagePtrOutput struct{ *pulumi.OutputState }

func (MetricDescriptorMetadataLaunchStagePtrOutput) Elem added in v0.17.0

func (MetricDescriptorMetadataLaunchStagePtrOutput) ElementType added in v0.17.0

func (MetricDescriptorMetadataLaunchStagePtrOutput) ToMetricDescriptorMetadataLaunchStagePtrOutput added in v0.17.0

func (o MetricDescriptorMetadataLaunchStagePtrOutput) ToMetricDescriptorMetadataLaunchStagePtrOutput() MetricDescriptorMetadataLaunchStagePtrOutput

func (MetricDescriptorMetadataLaunchStagePtrOutput) ToMetricDescriptorMetadataLaunchStagePtrOutputWithContext added in v0.17.0

func (o MetricDescriptorMetadataLaunchStagePtrOutput) ToMetricDescriptorMetadataLaunchStagePtrOutputWithContext(ctx context.Context) MetricDescriptorMetadataLaunchStagePtrOutput

func (MetricDescriptorMetadataLaunchStagePtrOutput) ToStringPtrOutput added in v0.17.0

func (MetricDescriptorMetadataLaunchStagePtrOutput) ToStringPtrOutputWithContext added in v0.17.0

type MetricDescriptorMetadataOutput

type MetricDescriptorMetadataOutput struct{ *pulumi.OutputState }

Additional annotations that can be used to guide the usage of a metric.

func (MetricDescriptorMetadataOutput) ElementType

func (MetricDescriptorMetadataOutput) IngestDelay

The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.

func (MetricDescriptorMetadataOutput) LaunchStage deprecated added in v0.17.0

Deprecated. Must use the MetricDescriptor.launch_stage instead.

Deprecated: Deprecated. Must use the MetricDescriptor.launch_stage instead.

func (MetricDescriptorMetadataOutput) SamplePeriod

The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.

func (MetricDescriptorMetadataOutput) ToMetricDescriptorMetadataOutput

func (o MetricDescriptorMetadataOutput) ToMetricDescriptorMetadataOutput() MetricDescriptorMetadataOutput

func (MetricDescriptorMetadataOutput) ToMetricDescriptorMetadataOutputWithContext

func (o MetricDescriptorMetadataOutput) ToMetricDescriptorMetadataOutputWithContext(ctx context.Context) MetricDescriptorMetadataOutput

func (MetricDescriptorMetadataOutput) ToMetricDescriptorMetadataPtrOutput

func (o MetricDescriptorMetadataOutput) ToMetricDescriptorMetadataPtrOutput() MetricDescriptorMetadataPtrOutput

func (MetricDescriptorMetadataOutput) ToMetricDescriptorMetadataPtrOutputWithContext

func (o MetricDescriptorMetadataOutput) ToMetricDescriptorMetadataPtrOutputWithContext(ctx context.Context) MetricDescriptorMetadataPtrOutput

type MetricDescriptorMetadataPtrInput

type MetricDescriptorMetadataPtrInput interface {
	pulumi.Input

	ToMetricDescriptorMetadataPtrOutput() MetricDescriptorMetadataPtrOutput
	ToMetricDescriptorMetadataPtrOutputWithContext(context.Context) MetricDescriptorMetadataPtrOutput
}

MetricDescriptorMetadataPtrInput is an input type that accepts MetricDescriptorMetadataArgs, MetricDescriptorMetadataPtr and MetricDescriptorMetadataPtrOutput values. You can construct a concrete instance of `MetricDescriptorMetadataPtrInput` via:

        MetricDescriptorMetadataArgs{...}

or:

        nil

type MetricDescriptorMetadataPtrOutput

type MetricDescriptorMetadataPtrOutput struct{ *pulumi.OutputState }

func (MetricDescriptorMetadataPtrOutput) Elem

func (MetricDescriptorMetadataPtrOutput) ElementType

func (MetricDescriptorMetadataPtrOutput) IngestDelay

The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.

func (MetricDescriptorMetadataPtrOutput) LaunchStage deprecated added in v0.17.0

Deprecated. Must use the MetricDescriptor.launch_stage instead.

Deprecated: Deprecated. Must use the MetricDescriptor.launch_stage instead.

func (MetricDescriptorMetadataPtrOutput) SamplePeriod

The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.

func (MetricDescriptorMetadataPtrOutput) ToMetricDescriptorMetadataPtrOutput

func (o MetricDescriptorMetadataPtrOutput) ToMetricDescriptorMetadataPtrOutput() MetricDescriptorMetadataPtrOutput

func (MetricDescriptorMetadataPtrOutput) ToMetricDescriptorMetadataPtrOutputWithContext

func (o MetricDescriptorMetadataPtrOutput) ToMetricDescriptorMetadataPtrOutputWithContext(ctx context.Context) MetricDescriptorMetadataPtrOutput

type MetricDescriptorMetadataResponse

type MetricDescriptorMetadataResponse struct {
	// The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.
	IngestDelay string `pulumi:"ingestDelay"`
	// Deprecated. Must use the MetricDescriptor.launch_stage instead.
	//
	// Deprecated: Deprecated. Must use the MetricDescriptor.launch_stage instead.
	LaunchStage string `pulumi:"launchStage"`
	// The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.
	SamplePeriod string `pulumi:"samplePeriod"`
}

Additional annotations that can be used to guide the usage of a metric.

type MetricDescriptorMetadataResponseOutput

type MetricDescriptorMetadataResponseOutput struct{ *pulumi.OutputState }

Additional annotations that can be used to guide the usage of a metric.

func (MetricDescriptorMetadataResponseOutput) ElementType

func (MetricDescriptorMetadataResponseOutput) IngestDelay

The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.

func (MetricDescriptorMetadataResponseOutput) LaunchStage deprecated added in v0.17.0

Deprecated. Must use the MetricDescriptor.launch_stage instead.

Deprecated: Deprecated. Must use the MetricDescriptor.launch_stage instead.

func (MetricDescriptorMetadataResponseOutput) SamplePeriod

The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.

func (MetricDescriptorMetadataResponseOutput) ToMetricDescriptorMetadataResponseOutput

func (o MetricDescriptorMetadataResponseOutput) ToMetricDescriptorMetadataResponseOutput() MetricDescriptorMetadataResponseOutput

func (MetricDescriptorMetadataResponseOutput) ToMetricDescriptorMetadataResponseOutputWithContext

func (o MetricDescriptorMetadataResponseOutput) ToMetricDescriptorMetadataResponseOutputWithContext(ctx context.Context) MetricDescriptorMetadataResponseOutput

type MetricDescriptorMetricKind added in v0.4.0

type MetricDescriptorMetricKind string

Whether the metric records instantaneous values, changes to a value, etc. Some combinations of `metric_kind` and `value_type` might not be supported.

func (MetricDescriptorMetricKind) ElementType added in v0.4.0

func (MetricDescriptorMetricKind) ElementType() reflect.Type

func (MetricDescriptorMetricKind) ToMetricDescriptorMetricKindOutput added in v0.6.0

func (e MetricDescriptorMetricKind) ToMetricDescriptorMetricKindOutput() MetricDescriptorMetricKindOutput

func (MetricDescriptorMetricKind) ToMetricDescriptorMetricKindOutputWithContext added in v0.6.0

func (e MetricDescriptorMetricKind) ToMetricDescriptorMetricKindOutputWithContext(ctx context.Context) MetricDescriptorMetricKindOutput

func (MetricDescriptorMetricKind) ToMetricDescriptorMetricKindPtrOutput added in v0.6.0

func (e MetricDescriptorMetricKind) ToMetricDescriptorMetricKindPtrOutput() MetricDescriptorMetricKindPtrOutput

func (MetricDescriptorMetricKind) ToMetricDescriptorMetricKindPtrOutputWithContext added in v0.6.0

func (e MetricDescriptorMetricKind) ToMetricDescriptorMetricKindPtrOutputWithContext(ctx context.Context) MetricDescriptorMetricKindPtrOutput

func (MetricDescriptorMetricKind) ToStringOutput added in v0.4.0

func (e MetricDescriptorMetricKind) ToStringOutput() pulumi.StringOutput

func (MetricDescriptorMetricKind) ToStringOutputWithContext added in v0.4.0

func (e MetricDescriptorMetricKind) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (MetricDescriptorMetricKind) ToStringPtrOutput added in v0.4.0

func (e MetricDescriptorMetricKind) ToStringPtrOutput() pulumi.StringPtrOutput

func (MetricDescriptorMetricKind) ToStringPtrOutputWithContext added in v0.4.0

func (e MetricDescriptorMetricKind) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type MetricDescriptorMetricKindInput added in v0.6.0

type MetricDescriptorMetricKindInput interface {
	pulumi.Input

	ToMetricDescriptorMetricKindOutput() MetricDescriptorMetricKindOutput
	ToMetricDescriptorMetricKindOutputWithContext(context.Context) MetricDescriptorMetricKindOutput
}

MetricDescriptorMetricKindInput is an input type that accepts MetricDescriptorMetricKindArgs and MetricDescriptorMetricKindOutput values. You can construct a concrete instance of `MetricDescriptorMetricKindInput` via:

MetricDescriptorMetricKindArgs{...}

type MetricDescriptorMetricKindOutput added in v0.6.0

type MetricDescriptorMetricKindOutput struct{ *pulumi.OutputState }

func (MetricDescriptorMetricKindOutput) ElementType added in v0.6.0

func (MetricDescriptorMetricKindOutput) ToMetricDescriptorMetricKindOutput added in v0.6.0

func (o MetricDescriptorMetricKindOutput) ToMetricDescriptorMetricKindOutput() MetricDescriptorMetricKindOutput

func (MetricDescriptorMetricKindOutput) ToMetricDescriptorMetricKindOutputWithContext added in v0.6.0

func (o MetricDescriptorMetricKindOutput) ToMetricDescriptorMetricKindOutputWithContext(ctx context.Context) MetricDescriptorMetricKindOutput

func (MetricDescriptorMetricKindOutput) ToMetricDescriptorMetricKindPtrOutput added in v0.6.0

func (o MetricDescriptorMetricKindOutput) ToMetricDescriptorMetricKindPtrOutput() MetricDescriptorMetricKindPtrOutput

func (MetricDescriptorMetricKindOutput) ToMetricDescriptorMetricKindPtrOutputWithContext added in v0.6.0

func (o MetricDescriptorMetricKindOutput) ToMetricDescriptorMetricKindPtrOutputWithContext(ctx context.Context) MetricDescriptorMetricKindPtrOutput

func (MetricDescriptorMetricKindOutput) ToStringOutput added in v0.6.0

func (MetricDescriptorMetricKindOutput) ToStringOutputWithContext added in v0.6.0

func (o MetricDescriptorMetricKindOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (MetricDescriptorMetricKindOutput) ToStringPtrOutput added in v0.6.0

func (MetricDescriptorMetricKindOutput) ToStringPtrOutputWithContext added in v0.6.0

func (o MetricDescriptorMetricKindOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type MetricDescriptorMetricKindPtrInput added in v0.6.0

type MetricDescriptorMetricKindPtrInput interface {
	pulumi.Input

	ToMetricDescriptorMetricKindPtrOutput() MetricDescriptorMetricKindPtrOutput
	ToMetricDescriptorMetricKindPtrOutputWithContext(context.Context) MetricDescriptorMetricKindPtrOutput
}

func MetricDescriptorMetricKindPtr added in v0.6.0

func MetricDescriptorMetricKindPtr(v string) MetricDescriptorMetricKindPtrInput

type MetricDescriptorMetricKindPtrOutput added in v0.6.0

type MetricDescriptorMetricKindPtrOutput struct{ *pulumi.OutputState }

func (MetricDescriptorMetricKindPtrOutput) Elem added in v0.6.0

func (MetricDescriptorMetricKindPtrOutput) ElementType added in v0.6.0

func (MetricDescriptorMetricKindPtrOutput) ToMetricDescriptorMetricKindPtrOutput added in v0.6.0

func (o MetricDescriptorMetricKindPtrOutput) ToMetricDescriptorMetricKindPtrOutput() MetricDescriptorMetricKindPtrOutput

func (MetricDescriptorMetricKindPtrOutput) ToMetricDescriptorMetricKindPtrOutputWithContext added in v0.6.0

func (o MetricDescriptorMetricKindPtrOutput) ToMetricDescriptorMetricKindPtrOutputWithContext(ctx context.Context) MetricDescriptorMetricKindPtrOutput

func (MetricDescriptorMetricKindPtrOutput) ToStringPtrOutput added in v0.6.0

func (MetricDescriptorMetricKindPtrOutput) ToStringPtrOutputWithContext added in v0.6.0

func (o MetricDescriptorMetricKindPtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type MetricDescriptorOutput

type MetricDescriptorOutput struct{ *pulumi.OutputState }

Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.

func (MetricDescriptorOutput) Description

A detailed description of the metric, which can be used in documentation.

func (MetricDescriptorOutput) DisplayName

A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota.

func (MetricDescriptorOutput) ElementType

func (MetricDescriptorOutput) ElementType() reflect.Type

func (MetricDescriptorOutput) Labels

The set of labels that can be used to describe a specific instance of this metric type. For example, the `appengine.googleapis.com/http/server/response_latencies` metric type has a label for the HTTP response code, `response_code`, so you can look at latencies for successful responses or just for responses that failed.

func (MetricDescriptorOutput) LaunchStage

Optional. The launch stage of the metric definition.

func (MetricDescriptorOutput) Metadata

Optional. Metadata which can be used to guide usage of the metric.

func (MetricDescriptorOutput) MetricKind

Whether the metric records instantaneous values, changes to a value, etc. Some combinations of `metric_kind` and `value_type` might not be supported.

func (MetricDescriptorOutput) MonitoredResourceTypes

func (o MetricDescriptorOutput) MonitoredResourceTypes() pulumi.StringArrayOutput

Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here.

func (MetricDescriptorOutput) Name

The resource name of the metric descriptor.

func (MetricDescriptorOutput) ToMetricDescriptorOutput

func (o MetricDescriptorOutput) ToMetricDescriptorOutput() MetricDescriptorOutput

func (MetricDescriptorOutput) ToMetricDescriptorOutputWithContext

func (o MetricDescriptorOutput) ToMetricDescriptorOutputWithContext(ctx context.Context) MetricDescriptorOutput

func (MetricDescriptorOutput) Type

The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name `custom.googleapis.com` or `external.googleapis.com`. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies"

func (MetricDescriptorOutput) Unit

The units in which the metric value is reported. It is only applicable if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit` defines the representation of the stored metric values. Different systems might scale the values to be more easily displayed (so a value of `0.02kBy` _might_ be displayed as `20By`, and a value of `3523kBy` _might_ be displayed as `3.5MBy`). However, if the `unit` is `kBy`, then the value of the metric is always in thousands of bytes, no matter how it might be displayed. If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an `INT64 CUMULATIVE` metric whose `unit` is `s{CPU}` (or equivalently `1s{CPU}` or just `s`). If the job uses 12,005 CPU-seconds, then the value is written as `12005`. Alternatively, if you want a custom metric to record data in a more granular way, you can create a `DOUBLE CUMULATIVE` metric whose `unit` is `ks{CPU}`, and then write the value `12.005` (which is `12005/1000`), or use `Kis{CPU}` and write `11.723` (which is `12005/1024`). The supported units are a subset of [The Unified Code for Units of Measure](https://unitsofmeasure.org/ucum.html) standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` second * `min` minute * `h` hour * `d` day * `1` dimensionless **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `E` exa (10^18) * `Z` zetta (10^21) * `Y` yotta (10^24) * `m` milli (10^-3) * `u` micro (10^-6) * `n` nano (10^-9) * `p` pico (10^-12) * `f` femto (10^-15) * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto (10^-24) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For examples, `kBy/{email}` or `MiBy/10ms` (although you should almost never have `/s` in a metric `unit`; rates should always be computed at query time from the underlying cumulative or delta value). * `.` multiplication or composition (as an infix operator). For examples, `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: * `Annotation` is just a comment if it follows a `UNIT`. If the annotation is used alone, then the unit is equivalent to `1`. For examples, `{request}/s == 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of non-blank printable ASCII characters not containing `{` or `}`. * `1` represents a unitary [dimensionless unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in `1/s`. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as `1/d` or `{new-users}/d` (and a metric value `5` would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as `1000/d` or `k1/d` or `k{page_views}/d` (and a metric value of `5.3` would mean "5300 page views per day"). * `%` represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value `3` means "3 percent"). * `10^2.%` indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value `0.03` means "3 percent").

func (MetricDescriptorOutput) ValueType

Whether the measurement is an integer, a floating-point number, etc. Some combinations of `metric_kind` and `value_type` might not be supported.

type MetricDescriptorResponse

type MetricDescriptorResponse struct {
	// A detailed description of the metric, which can be used in documentation.
	Description string `pulumi:"description"`
	// A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota.
	DisplayName string `pulumi:"displayName"`
	// The set of labels that can be used to describe a specific instance of this metric type. For example, the `appengine.googleapis.com/http/server/response_latencies` metric type has a label for the HTTP response code, `response_code`, so you can look at latencies for successful responses or just for responses that failed.
	Labels []LabelDescriptorResponse `pulumi:"labels"`
	// Optional. The launch stage of the metric definition.
	LaunchStage string `pulumi:"launchStage"`
	// Optional. Metadata which can be used to guide usage of the metric.
	Metadata MetricDescriptorMetadataResponse `pulumi:"metadata"`
	// Whether the metric records instantaneous values, changes to a value, etc. Some combinations of `metric_kind` and `value_type` might not be supported.
	MetricKind string `pulumi:"metricKind"`
	// Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here.
	MonitoredResourceTypes []string `pulumi:"monitoredResourceTypes"`
	// The resource name of the metric descriptor.
	Name string `pulumi:"name"`
	// The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name `custom.googleapis.com` or `external.googleapis.com`. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies"
	Type string `pulumi:"type"`
	// The units in which the metric value is reported. It is only applicable if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit` defines the representation of the stored metric values. Different systems might scale the values to be more easily displayed (so a value of `0.02kBy` _might_ be displayed as `20By`, and a value of `3523kBy` _might_ be displayed as `3.5MBy`). However, if the `unit` is `kBy`, then the value of the metric is always in thousands of bytes, no matter how it might be displayed. If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an `INT64 CUMULATIVE` metric whose `unit` is `s{CPU}` (or equivalently `1s{CPU}` or just `s`). If the job uses 12,005 CPU-seconds, then the value is written as `12005`. Alternatively, if you want a custom metric to record data in a more granular way, you can create a `DOUBLE CUMULATIVE` metric whose `unit` is `ks{CPU}`, and then write the value `12.005` (which is `12005/1000`), or use `Kis{CPU}` and write `11.723` (which is `12005/1024`). The supported units are a subset of [The Unified Code for Units of Measure](https://unitsofmeasure.org/ucum.html) standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` second * `min` minute * `h` hour * `d` day * `1` dimensionless **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `E` exa (10^18) * `Z` zetta (10^21) * `Y` yotta (10^24) * `m` milli (10^-3) * `u` micro (10^-6) * `n` nano (10^-9) * `p` pico (10^-12) * `f` femto (10^-15) * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto (10^-24) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For examples, `kBy/{email}` or `MiBy/10ms` (although you should almost never have `/s` in a metric `unit`; rates should always be computed at query time from the underlying cumulative or delta value). * `.` multiplication or composition (as an infix operator). For examples, `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: * `Annotation` is just a comment if it follows a `UNIT`. If the annotation is used alone, then the unit is equivalent to `1`. For examples, `{request}/s == 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of non-blank printable ASCII characters not containing `{` or `}`. * `1` represents a unitary [dimensionless unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in `1/s`. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as `1/d` or `{new-users}/d` (and a metric value `5` would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as `1000/d` or `k1/d` or `k{page_views}/d` (and a metric value of `5.3` would mean "5300 page views per day"). * `%` represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value `3` means "3 percent"). * `10^2.%` indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value `0.03` means "3 percent").
	Unit string `pulumi:"unit"`
	// Whether the measurement is an integer, a floating-point number, etc. Some combinations of `metric_kind` and `value_type` might not be supported.
	ValueType string `pulumi:"valueType"`
}

Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.

type MetricDescriptorResponseArrayOutput

type MetricDescriptorResponseArrayOutput struct{ *pulumi.OutputState }

func (MetricDescriptorResponseArrayOutput) ElementType

func (MetricDescriptorResponseArrayOutput) Index

func (MetricDescriptorResponseArrayOutput) ToMetricDescriptorResponseArrayOutput

func (o MetricDescriptorResponseArrayOutput) ToMetricDescriptorResponseArrayOutput() MetricDescriptorResponseArrayOutput

func (MetricDescriptorResponseArrayOutput) ToMetricDescriptorResponseArrayOutputWithContext

func (o MetricDescriptorResponseArrayOutput) ToMetricDescriptorResponseArrayOutputWithContext(ctx context.Context) MetricDescriptorResponseArrayOutput

type MetricDescriptorResponseOutput

type MetricDescriptorResponseOutput struct{ *pulumi.OutputState }

Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.

func (MetricDescriptorResponseOutput) Description

A detailed description of the metric, which can be used in documentation.

func (MetricDescriptorResponseOutput) DisplayName

A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota.

func (MetricDescriptorResponseOutput) ElementType

func (MetricDescriptorResponseOutput) Labels

The set of labels that can be used to describe a specific instance of this metric type. For example, the `appengine.googleapis.com/http/server/response_latencies` metric type has a label for the HTTP response code, `response_code`, so you can look at latencies for successful responses or just for responses that failed.

func (MetricDescriptorResponseOutput) LaunchStage

Optional. The launch stage of the metric definition.

func (MetricDescriptorResponseOutput) Metadata

Optional. Metadata which can be used to guide usage of the metric.

func (MetricDescriptorResponseOutput) MetricKind

Whether the metric records instantaneous values, changes to a value, etc. Some combinations of `metric_kind` and `value_type` might not be supported.

func (MetricDescriptorResponseOutput) MonitoredResourceTypes

func (o MetricDescriptorResponseOutput) MonitoredResourceTypes() pulumi.StringArrayOutput

Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here.

func (MetricDescriptorResponseOutput) Name

The resource name of the metric descriptor.

func (MetricDescriptorResponseOutput) ToMetricDescriptorResponseOutput

func (o MetricDescriptorResponseOutput) ToMetricDescriptorResponseOutput() MetricDescriptorResponseOutput

func (MetricDescriptorResponseOutput) ToMetricDescriptorResponseOutputWithContext

func (o MetricDescriptorResponseOutput) ToMetricDescriptorResponseOutputWithContext(ctx context.Context) MetricDescriptorResponseOutput

func (MetricDescriptorResponseOutput) Type

The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name `custom.googleapis.com` or `external.googleapis.com`. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies"

func (MetricDescriptorResponseOutput) Unit

The units in which the metric value is reported. It is only applicable if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit` defines the representation of the stored metric values. Different systems might scale the values to be more easily displayed (so a value of `0.02kBy` _might_ be displayed as `20By`, and a value of `3523kBy` _might_ be displayed as `3.5MBy`). However, if the `unit` is `kBy`, then the value of the metric is always in thousands of bytes, no matter how it might be displayed. If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an `INT64 CUMULATIVE` metric whose `unit` is `s{CPU}` (or equivalently `1s{CPU}` or just `s`). If the job uses 12,005 CPU-seconds, then the value is written as `12005`. Alternatively, if you want a custom metric to record data in a more granular way, you can create a `DOUBLE CUMULATIVE` metric whose `unit` is `ks{CPU}`, and then write the value `12.005` (which is `12005/1000`), or use `Kis{CPU}` and write `11.723` (which is `12005/1024`). The supported units are a subset of [The Unified Code for Units of Measure](https://unitsofmeasure.org/ucum.html) standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` second * `min` minute * `h` hour * `d` day * `1` dimensionless **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `E` exa (10^18) * `Z` zetta (10^21) * `Y` yotta (10^24) * `m` milli (10^-3) * `u` micro (10^-6) * `n` nano (10^-9) * `p` pico (10^-12) * `f` femto (10^-15) * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto (10^-24) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For examples, `kBy/{email}` or `MiBy/10ms` (although you should almost never have `/s` in a metric `unit`; rates should always be computed at query time from the underlying cumulative or delta value). * `.` multiplication or composition (as an infix operator). For examples, `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: * `Annotation` is just a comment if it follows a `UNIT`. If the annotation is used alone, then the unit is equivalent to `1`. For examples, `{request}/s == 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of non-blank printable ASCII characters not containing `{` or `}`. * `1` represents a unitary [dimensionless unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in `1/s`. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as `1/d` or `{new-users}/d` (and a metric value `5` would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as `1000/d` or `k1/d` or `k{page_views}/d` (and a metric value of `5.3` would mean "5300 page views per day"). * `%` represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value `3` means "3 percent"). * `10^2.%` indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value `0.03` means "3 percent").

func (MetricDescriptorResponseOutput) ValueType

Whether the measurement is an integer, a floating-point number, etc. Some combinations of `metric_kind` and `value_type` might not be supported.

type MetricDescriptorValueType added in v0.4.0

type MetricDescriptorValueType string

Whether the measurement is an integer, a floating-point number, etc. Some combinations of `metric_kind` and `value_type` might not be supported.

func (MetricDescriptorValueType) ElementType added in v0.4.0

func (MetricDescriptorValueType) ElementType() reflect.Type

func (MetricDescriptorValueType) ToMetricDescriptorValueTypeOutput added in v0.6.0

func (e MetricDescriptorValueType) ToMetricDescriptorValueTypeOutput() MetricDescriptorValueTypeOutput

func (MetricDescriptorValueType) ToMetricDescriptorValueTypeOutputWithContext added in v0.6.0

func (e MetricDescriptorValueType) ToMetricDescriptorValueTypeOutputWithContext(ctx context.Context) MetricDescriptorValueTypeOutput

func (MetricDescriptorValueType) ToMetricDescriptorValueTypePtrOutput added in v0.6.0

func (e MetricDescriptorValueType) ToMetricDescriptorValueTypePtrOutput() MetricDescriptorValueTypePtrOutput

func (MetricDescriptorValueType) ToMetricDescriptorValueTypePtrOutputWithContext added in v0.6.0

func (e MetricDescriptorValueType) ToMetricDescriptorValueTypePtrOutputWithContext(ctx context.Context) MetricDescriptorValueTypePtrOutput

func (MetricDescriptorValueType) ToStringOutput added in v0.4.0

func (e MetricDescriptorValueType) ToStringOutput() pulumi.StringOutput

func (MetricDescriptorValueType) ToStringOutputWithContext added in v0.4.0

func (e MetricDescriptorValueType) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (MetricDescriptorValueType) ToStringPtrOutput added in v0.4.0

func (e MetricDescriptorValueType) ToStringPtrOutput() pulumi.StringPtrOutput

func (MetricDescriptorValueType) ToStringPtrOutputWithContext added in v0.4.0

func (e MetricDescriptorValueType) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type MetricDescriptorValueTypeInput added in v0.6.0

type MetricDescriptorValueTypeInput interface {
	pulumi.Input

	ToMetricDescriptorValueTypeOutput() MetricDescriptorValueTypeOutput
	ToMetricDescriptorValueTypeOutputWithContext(context.Context) MetricDescriptorValueTypeOutput
}

MetricDescriptorValueTypeInput is an input type that accepts MetricDescriptorValueTypeArgs and MetricDescriptorValueTypeOutput values. You can construct a concrete instance of `MetricDescriptorValueTypeInput` via:

MetricDescriptorValueTypeArgs{...}

type MetricDescriptorValueTypeOutput added in v0.6.0

type MetricDescriptorValueTypeOutput struct{ *pulumi.OutputState }

func (MetricDescriptorValueTypeOutput) ElementType added in v0.6.0

func (MetricDescriptorValueTypeOutput) ToMetricDescriptorValueTypeOutput added in v0.6.0

func (o MetricDescriptorValueTypeOutput) ToMetricDescriptorValueTypeOutput() MetricDescriptorValueTypeOutput

func (MetricDescriptorValueTypeOutput) ToMetricDescriptorValueTypeOutputWithContext added in v0.6.0

func (o MetricDescriptorValueTypeOutput) ToMetricDescriptorValueTypeOutputWithContext(ctx context.Context) MetricDescriptorValueTypeOutput

func (MetricDescriptorValueTypeOutput) ToMetricDescriptorValueTypePtrOutput added in v0.6.0

func (o MetricDescriptorValueTypeOutput) ToMetricDescriptorValueTypePtrOutput() MetricDescriptorValueTypePtrOutput

func (MetricDescriptorValueTypeOutput) ToMetricDescriptorValueTypePtrOutputWithContext added in v0.6.0

func (o MetricDescriptorValueTypeOutput) ToMetricDescriptorValueTypePtrOutputWithContext(ctx context.Context) MetricDescriptorValueTypePtrOutput

func (MetricDescriptorValueTypeOutput) ToStringOutput added in v0.6.0

func (MetricDescriptorValueTypeOutput) ToStringOutputWithContext added in v0.6.0

func (o MetricDescriptorValueTypeOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (MetricDescriptorValueTypeOutput) ToStringPtrOutput added in v0.6.0

func (MetricDescriptorValueTypeOutput) ToStringPtrOutputWithContext added in v0.6.0

func (o MetricDescriptorValueTypeOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type MetricDescriptorValueTypePtrInput added in v0.6.0

type MetricDescriptorValueTypePtrInput interface {
	pulumi.Input

	ToMetricDescriptorValueTypePtrOutput() MetricDescriptorValueTypePtrOutput
	ToMetricDescriptorValueTypePtrOutputWithContext(context.Context) MetricDescriptorValueTypePtrOutput
}

func MetricDescriptorValueTypePtr added in v0.6.0

func MetricDescriptorValueTypePtr(v string) MetricDescriptorValueTypePtrInput

type MetricDescriptorValueTypePtrOutput added in v0.6.0

type MetricDescriptorValueTypePtrOutput struct{ *pulumi.OutputState }

func (MetricDescriptorValueTypePtrOutput) Elem added in v0.6.0

func (MetricDescriptorValueTypePtrOutput) ElementType added in v0.6.0

func (MetricDescriptorValueTypePtrOutput) ToMetricDescriptorValueTypePtrOutput added in v0.6.0

func (o MetricDescriptorValueTypePtrOutput) ToMetricDescriptorValueTypePtrOutput() MetricDescriptorValueTypePtrOutput

func (MetricDescriptorValueTypePtrOutput) ToMetricDescriptorValueTypePtrOutputWithContext added in v0.6.0

func (o MetricDescriptorValueTypePtrOutput) ToMetricDescriptorValueTypePtrOutputWithContext(ctx context.Context) MetricDescriptorValueTypePtrOutput

func (MetricDescriptorValueTypePtrOutput) ToStringPtrOutput added in v0.6.0

func (MetricDescriptorValueTypePtrOutput) ToStringPtrOutputWithContext added in v0.6.0

func (o MetricDescriptorValueTypePtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type MetricRule

type MetricRule struct {
	// Metrics to update when the selected methods are called, and the associated cost applied to each metric. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative.
	MetricCosts map[string]string `pulumi:"metricCosts"`
	// Selects the methods to which this rule applies. Refer to selector for syntax details.
	Selector *string `pulumi:"selector"`
}

Bind API methods to metrics. Binding a method to a metric causes that metric's configured quota behaviors to apply to the method call.

type MetricRuleArgs

type MetricRuleArgs struct {
	// Metrics to update when the selected methods are called, and the associated cost applied to each metric. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative.
	MetricCosts pulumi.StringMapInput `pulumi:"metricCosts"`
	// Selects the methods to which this rule applies. Refer to selector for syntax details.
	Selector pulumi.StringPtrInput `pulumi:"selector"`
}

Bind API methods to metrics. Binding a method to a metric causes that metric's configured quota behaviors to apply to the method call.

func (MetricRuleArgs) ElementType

func (MetricRuleArgs) ElementType() reflect.Type

func (MetricRuleArgs) ToMetricRuleOutput

func (i MetricRuleArgs) ToMetricRuleOutput() MetricRuleOutput

func (MetricRuleArgs) ToMetricRuleOutputWithContext

func (i MetricRuleArgs) ToMetricRuleOutputWithContext(ctx context.Context) MetricRuleOutput

type MetricRuleArray

type MetricRuleArray []MetricRuleInput

func (MetricRuleArray) ElementType

func (MetricRuleArray) ElementType() reflect.Type

func (MetricRuleArray) ToMetricRuleArrayOutput

func (i MetricRuleArray) ToMetricRuleArrayOutput() MetricRuleArrayOutput

func (MetricRuleArray) ToMetricRuleArrayOutputWithContext

func (i MetricRuleArray) ToMetricRuleArrayOutputWithContext(ctx context.Context) MetricRuleArrayOutput

type MetricRuleArrayInput

type MetricRuleArrayInput interface {
	pulumi.Input

	ToMetricRuleArrayOutput() MetricRuleArrayOutput
	ToMetricRuleArrayOutputWithContext(context.Context) MetricRuleArrayOutput
}

MetricRuleArrayInput is an input type that accepts MetricRuleArray and MetricRuleArrayOutput values. You can construct a concrete instance of `MetricRuleArrayInput` via:

MetricRuleArray{ MetricRuleArgs{...} }

type MetricRuleArrayOutput

type MetricRuleArrayOutput struct{ *pulumi.OutputState }

func (MetricRuleArrayOutput) ElementType

func (MetricRuleArrayOutput) ElementType() reflect.Type

func (MetricRuleArrayOutput) Index

func (MetricRuleArrayOutput) ToMetricRuleArrayOutput

func (o MetricRuleArrayOutput) ToMetricRuleArrayOutput() MetricRuleArrayOutput

func (MetricRuleArrayOutput) ToMetricRuleArrayOutputWithContext

func (o MetricRuleArrayOutput) ToMetricRuleArrayOutputWithContext(ctx context.Context) MetricRuleArrayOutput

type MetricRuleInput

type MetricRuleInput interface {
	pulumi.Input

	ToMetricRuleOutput() MetricRuleOutput
	ToMetricRuleOutputWithContext(context.Context) MetricRuleOutput
}

MetricRuleInput is an input type that accepts MetricRuleArgs and MetricRuleOutput values. You can construct a concrete instance of `MetricRuleInput` via:

MetricRuleArgs{...}

type MetricRuleOutput

type MetricRuleOutput struct{ *pulumi.OutputState }

Bind API methods to metrics. Binding a method to a metric causes that metric's configured quota behaviors to apply to the method call.

func (MetricRuleOutput) ElementType

func (MetricRuleOutput) ElementType() reflect.Type

func (MetricRuleOutput) MetricCosts

func (o MetricRuleOutput) MetricCosts() pulumi.StringMapOutput

Metrics to update when the selected methods are called, and the associated cost applied to each metric. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative.

func (MetricRuleOutput) Selector

Selects the methods to which this rule applies. Refer to selector for syntax details.

func (MetricRuleOutput) ToMetricRuleOutput

func (o MetricRuleOutput) ToMetricRuleOutput() MetricRuleOutput

func (MetricRuleOutput) ToMetricRuleOutputWithContext

func (o MetricRuleOutput) ToMetricRuleOutputWithContext(ctx context.Context) MetricRuleOutput

type MetricRuleResponse

type MetricRuleResponse struct {
	// Metrics to update when the selected methods are called, and the associated cost applied to each metric. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative.
	MetricCosts map[string]string `pulumi:"metricCosts"`
	// Selects the methods to which this rule applies. Refer to selector for syntax details.
	Selector string `pulumi:"selector"`
}

Bind API methods to metrics. Binding a method to a metric causes that metric's configured quota behaviors to apply to the method call.

type MetricRuleResponseArrayOutput

type MetricRuleResponseArrayOutput struct{ *pulumi.OutputState }

func (MetricRuleResponseArrayOutput) ElementType

func (MetricRuleResponseArrayOutput) Index

func (MetricRuleResponseArrayOutput) ToMetricRuleResponseArrayOutput

func (o MetricRuleResponseArrayOutput) ToMetricRuleResponseArrayOutput() MetricRuleResponseArrayOutput

func (MetricRuleResponseArrayOutput) ToMetricRuleResponseArrayOutputWithContext

func (o MetricRuleResponseArrayOutput) ToMetricRuleResponseArrayOutputWithContext(ctx context.Context) MetricRuleResponseArrayOutput

type MetricRuleResponseOutput

type MetricRuleResponseOutput struct{ *pulumi.OutputState }

Bind API methods to metrics. Binding a method to a metric causes that metric's configured quota behaviors to apply to the method call.

func (MetricRuleResponseOutput) ElementType

func (MetricRuleResponseOutput) ElementType() reflect.Type

func (MetricRuleResponseOutput) MetricCosts

Metrics to update when the selected methods are called, and the associated cost applied to each metric. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative.

func (MetricRuleResponseOutput) Selector

Selects the methods to which this rule applies. Refer to selector for syntax details.

func (MetricRuleResponseOutput) ToMetricRuleResponseOutput

func (o MetricRuleResponseOutput) ToMetricRuleResponseOutput() MetricRuleResponseOutput

func (MetricRuleResponseOutput) ToMetricRuleResponseOutputWithContext

func (o MetricRuleResponseOutput) ToMetricRuleResponseOutputWithContext(ctx context.Context) MetricRuleResponseOutput

type Mixin

type Mixin struct {
	// The fully qualified name of the interface which is included.
	Name *string `pulumi:"name"`
	// If non-empty specifies a path under which inherited HTTP paths are rooted.
	Root *string `pulumi:"root"`
}

Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows: - If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method. - Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited. - If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v1/{resource=**}:getAcl"; } } package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = "/v2/{resource=**}"; } } Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inherting documentation and annotations as follows: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/{resource=**}:getAcl"; } ... } Note how the version in the path pattern changed from `v1` to `v2`. If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; } ... }

type MixinArgs

type MixinArgs struct {
	// The fully qualified name of the interface which is included.
	Name pulumi.StringPtrInput `pulumi:"name"`
	// If non-empty specifies a path under which inherited HTTP paths are rooted.
	Root pulumi.StringPtrInput `pulumi:"root"`
}

Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows: - If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method. - Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited. - If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v1/{resource=**}:getAcl"; } } package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = "/v2/{resource=**}"; } } Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inherting documentation and annotations as follows: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/{resource=**}:getAcl"; } ... } Note how the version in the path pattern changed from `v1` to `v2`. If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; } ... }

func (MixinArgs) ElementType

func (MixinArgs) ElementType() reflect.Type

func (MixinArgs) ToMixinOutput

func (i MixinArgs) ToMixinOutput() MixinOutput

func (MixinArgs) ToMixinOutputWithContext

func (i MixinArgs) ToMixinOutputWithContext(ctx context.Context) MixinOutput

type MixinArray

type MixinArray []MixinInput

func (MixinArray) ElementType

func (MixinArray) ElementType() reflect.Type

func (MixinArray) ToMixinArrayOutput

func (i MixinArray) ToMixinArrayOutput() MixinArrayOutput

func (MixinArray) ToMixinArrayOutputWithContext

func (i MixinArray) ToMixinArrayOutputWithContext(ctx context.Context) MixinArrayOutput

type MixinArrayInput

type MixinArrayInput interface {
	pulumi.Input

	ToMixinArrayOutput() MixinArrayOutput
	ToMixinArrayOutputWithContext(context.Context) MixinArrayOutput
}

MixinArrayInput is an input type that accepts MixinArray and MixinArrayOutput values. You can construct a concrete instance of `MixinArrayInput` via:

MixinArray{ MixinArgs{...} }

type MixinArrayOutput

type MixinArrayOutput struct{ *pulumi.OutputState }

func (MixinArrayOutput) ElementType

func (MixinArrayOutput) ElementType() reflect.Type

func (MixinArrayOutput) Index

func (MixinArrayOutput) ToMixinArrayOutput

func (o MixinArrayOutput) ToMixinArrayOutput() MixinArrayOutput

func (MixinArrayOutput) ToMixinArrayOutputWithContext

func (o MixinArrayOutput) ToMixinArrayOutputWithContext(ctx context.Context) MixinArrayOutput

type MixinInput

type MixinInput interface {
	pulumi.Input

	ToMixinOutput() MixinOutput
	ToMixinOutputWithContext(context.Context) MixinOutput
}

MixinInput is an input type that accepts MixinArgs and MixinOutput values. You can construct a concrete instance of `MixinInput` via:

MixinArgs{...}

type MixinOutput

type MixinOutput struct{ *pulumi.OutputState }

Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows: - If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method. - Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited. - If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v1/{resource=**}:getAcl"; } } package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = "/v2/{resource=**}"; } } Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inherting documentation and annotations as follows: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/{resource=**}:getAcl"; } ... } Note how the version in the path pattern changed from `v1` to `v2`. If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; } ... }

func (MixinOutput) ElementType

func (MixinOutput) ElementType() reflect.Type

func (MixinOutput) Name

The fully qualified name of the interface which is included.

func (MixinOutput) Root

If non-empty specifies a path under which inherited HTTP paths are rooted.

func (MixinOutput) ToMixinOutput

func (o MixinOutput) ToMixinOutput() MixinOutput

func (MixinOutput) ToMixinOutputWithContext

func (o MixinOutput) ToMixinOutputWithContext(ctx context.Context) MixinOutput

type MixinResponse

type MixinResponse struct {
	// The fully qualified name of the interface which is included.
	Name string `pulumi:"name"`
	// If non-empty specifies a path under which inherited HTTP paths are rooted.
	Root string `pulumi:"root"`
}

Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows: - If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method. - Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited. - If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v1/{resource=**}:getAcl"; } } package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = "/v2/{resource=**}"; } } Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inherting documentation and annotations as follows: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/{resource=**}:getAcl"; } ... } Note how the version in the path pattern changed from `v1` to `v2`. If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; } ... }

type MixinResponseArrayOutput

type MixinResponseArrayOutput struct{ *pulumi.OutputState }

func (MixinResponseArrayOutput) ElementType

func (MixinResponseArrayOutput) ElementType() reflect.Type

func (MixinResponseArrayOutput) Index

func (MixinResponseArrayOutput) ToMixinResponseArrayOutput

func (o MixinResponseArrayOutput) ToMixinResponseArrayOutput() MixinResponseArrayOutput

func (MixinResponseArrayOutput) ToMixinResponseArrayOutputWithContext

func (o MixinResponseArrayOutput) ToMixinResponseArrayOutputWithContext(ctx context.Context) MixinResponseArrayOutput

type MixinResponseOutput

type MixinResponseOutput struct{ *pulumi.OutputState }

Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows: - If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method. - Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited. - If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v1/{resource=**}:getAcl"; } } package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = "/v2/{resource=**}"; } } Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inherting documentation and annotations as follows: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/{resource=**}:getAcl"; } ... } Note how the version in the path pattern changed from `v1` to `v2`. If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; } ... }

func (MixinResponseOutput) ElementType

func (MixinResponseOutput) ElementType() reflect.Type

func (MixinResponseOutput) Name

The fully qualified name of the interface which is included.

func (MixinResponseOutput) Root

If non-empty specifies a path under which inherited HTTP paths are rooted.

func (MixinResponseOutput) ToMixinResponseOutput

func (o MixinResponseOutput) ToMixinResponseOutput() MixinResponseOutput

func (MixinResponseOutput) ToMixinResponseOutputWithContext

func (o MixinResponseOutput) ToMixinResponseOutputWithContext(ctx context.Context) MixinResponseOutput

type MonitoredResourceDescriptor

type MonitoredResourceDescriptor struct {
	// Optional. A detailed description of the monitored resource type that might be used in documentation.
	Description *string `pulumi:"description"`
	// Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, `"Google Cloud SQL Database"`.
	DisplayName *string `pulumi:"displayName"`
	// A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels `"database_id"` and `"zone"`.
	Labels []LabelDescriptor `pulumi:"labels"`
	// Optional. The launch stage of the monitored resource definition.
	LaunchStage *MonitoredResourceDescriptorLaunchStage `pulumi:"launchStage"`
	// Optional. The resource name of the monitored resource descriptor: `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where {type} is the value of the `type` field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format `"monitoredResourceDescriptors/{type}"`.
	Name *string `pulumi:"name"`
	// The monitored resource type. For example, the type `"cloudsql_database"` represents databases in Google Cloud SQL. For a list of types, see [Monitoring resource types](https://cloud.google.com/monitoring/api/resources) and [Logging resource types](https://cloud.google.com/logging/docs/api/v2/resource-list).
	Type string `pulumi:"type"`
}

An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of `"gce_instance"` and specifies the use of the labels `"instance_id"` and `"zone"` to identify particular VM instances. Different APIs can support different monitored resource types. APIs generally provide a `list` method that returns the monitored resource descriptors used by the API.

type MonitoredResourceDescriptorArgs

type MonitoredResourceDescriptorArgs struct {
	// Optional. A detailed description of the monitored resource type that might be used in documentation.
	Description pulumi.StringPtrInput `pulumi:"description"`
	// Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, `"Google Cloud SQL Database"`.
	DisplayName pulumi.StringPtrInput `pulumi:"displayName"`
	// A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels `"database_id"` and `"zone"`.
	Labels LabelDescriptorArrayInput `pulumi:"labels"`
	// Optional. The launch stage of the monitored resource definition.
	LaunchStage MonitoredResourceDescriptorLaunchStagePtrInput `pulumi:"launchStage"`
	// Optional. The resource name of the monitored resource descriptor: `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where {type} is the value of the `type` field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format `"monitoredResourceDescriptors/{type}"`.
	Name pulumi.StringPtrInput `pulumi:"name"`
	// The monitored resource type. For example, the type `"cloudsql_database"` represents databases in Google Cloud SQL. For a list of types, see [Monitoring resource types](https://cloud.google.com/monitoring/api/resources) and [Logging resource types](https://cloud.google.com/logging/docs/api/v2/resource-list).
	Type pulumi.StringInput `pulumi:"type"`
}

An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of `"gce_instance"` and specifies the use of the labels `"instance_id"` and `"zone"` to identify particular VM instances. Different APIs can support different monitored resource types. APIs generally provide a `list` method that returns the monitored resource descriptors used by the API.

func (MonitoredResourceDescriptorArgs) ElementType

func (MonitoredResourceDescriptorArgs) ToMonitoredResourceDescriptorOutput

func (i MonitoredResourceDescriptorArgs) ToMonitoredResourceDescriptorOutput() MonitoredResourceDescriptorOutput

func (MonitoredResourceDescriptorArgs) ToMonitoredResourceDescriptorOutputWithContext

func (i MonitoredResourceDescriptorArgs) ToMonitoredResourceDescriptorOutputWithContext(ctx context.Context) MonitoredResourceDescriptorOutput

type MonitoredResourceDescriptorArray

type MonitoredResourceDescriptorArray []MonitoredResourceDescriptorInput

func (MonitoredResourceDescriptorArray) ElementType

func (MonitoredResourceDescriptorArray) ToMonitoredResourceDescriptorArrayOutput

func (i MonitoredResourceDescriptorArray) ToMonitoredResourceDescriptorArrayOutput() MonitoredResourceDescriptorArrayOutput

func (MonitoredResourceDescriptorArray) ToMonitoredResourceDescriptorArrayOutputWithContext

func (i MonitoredResourceDescriptorArray) ToMonitoredResourceDescriptorArrayOutputWithContext(ctx context.Context) MonitoredResourceDescriptorArrayOutput

type MonitoredResourceDescriptorArrayInput

type MonitoredResourceDescriptorArrayInput interface {
	pulumi.Input

	ToMonitoredResourceDescriptorArrayOutput() MonitoredResourceDescriptorArrayOutput
	ToMonitoredResourceDescriptorArrayOutputWithContext(context.Context) MonitoredResourceDescriptorArrayOutput
}

MonitoredResourceDescriptorArrayInput is an input type that accepts MonitoredResourceDescriptorArray and MonitoredResourceDescriptorArrayOutput values. You can construct a concrete instance of `MonitoredResourceDescriptorArrayInput` via:

MonitoredResourceDescriptorArray{ MonitoredResourceDescriptorArgs{...} }

type MonitoredResourceDescriptorArrayOutput

type MonitoredResourceDescriptorArrayOutput struct{ *pulumi.OutputState }

func (MonitoredResourceDescriptorArrayOutput) ElementType

func (MonitoredResourceDescriptorArrayOutput) Index

func (MonitoredResourceDescriptorArrayOutput) ToMonitoredResourceDescriptorArrayOutput

func (o MonitoredResourceDescriptorArrayOutput) ToMonitoredResourceDescriptorArrayOutput() MonitoredResourceDescriptorArrayOutput

func (MonitoredResourceDescriptorArrayOutput) ToMonitoredResourceDescriptorArrayOutputWithContext

func (o MonitoredResourceDescriptorArrayOutput) ToMonitoredResourceDescriptorArrayOutputWithContext(ctx context.Context) MonitoredResourceDescriptorArrayOutput

type MonitoredResourceDescriptorInput

type MonitoredResourceDescriptorInput interface {
	pulumi.Input

	ToMonitoredResourceDescriptorOutput() MonitoredResourceDescriptorOutput
	ToMonitoredResourceDescriptorOutputWithContext(context.Context) MonitoredResourceDescriptorOutput
}

MonitoredResourceDescriptorInput is an input type that accepts MonitoredResourceDescriptorArgs and MonitoredResourceDescriptorOutput values. You can construct a concrete instance of `MonitoredResourceDescriptorInput` via:

MonitoredResourceDescriptorArgs{...}

type MonitoredResourceDescriptorLaunchStage added in v0.4.0

type MonitoredResourceDescriptorLaunchStage string

Optional. The launch stage of the monitored resource definition.

func (MonitoredResourceDescriptorLaunchStage) ElementType added in v0.4.0

func (MonitoredResourceDescriptorLaunchStage) ToMonitoredResourceDescriptorLaunchStageOutput added in v0.6.0

func (e MonitoredResourceDescriptorLaunchStage) ToMonitoredResourceDescriptorLaunchStageOutput() MonitoredResourceDescriptorLaunchStageOutput

func (MonitoredResourceDescriptorLaunchStage) ToMonitoredResourceDescriptorLaunchStageOutputWithContext added in v0.6.0

func (e MonitoredResourceDescriptorLaunchStage) ToMonitoredResourceDescriptorLaunchStageOutputWithContext(ctx context.Context) MonitoredResourceDescriptorLaunchStageOutput

func (MonitoredResourceDescriptorLaunchStage) ToMonitoredResourceDescriptorLaunchStagePtrOutput added in v0.6.0

func (e MonitoredResourceDescriptorLaunchStage) ToMonitoredResourceDescriptorLaunchStagePtrOutput() MonitoredResourceDescriptorLaunchStagePtrOutput

func (MonitoredResourceDescriptorLaunchStage) ToMonitoredResourceDescriptorLaunchStagePtrOutputWithContext added in v0.6.0

func (e MonitoredResourceDescriptorLaunchStage) ToMonitoredResourceDescriptorLaunchStagePtrOutputWithContext(ctx context.Context) MonitoredResourceDescriptorLaunchStagePtrOutput

func (MonitoredResourceDescriptorLaunchStage) ToStringOutput added in v0.4.0

func (MonitoredResourceDescriptorLaunchStage) ToStringOutputWithContext added in v0.4.0

func (MonitoredResourceDescriptorLaunchStage) ToStringPtrOutput added in v0.4.0

func (MonitoredResourceDescriptorLaunchStage) ToStringPtrOutputWithContext added in v0.4.0

func (e MonitoredResourceDescriptorLaunchStage) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type MonitoredResourceDescriptorLaunchStageInput added in v0.6.0

type MonitoredResourceDescriptorLaunchStageInput interface {
	pulumi.Input

	ToMonitoredResourceDescriptorLaunchStageOutput() MonitoredResourceDescriptorLaunchStageOutput
	ToMonitoredResourceDescriptorLaunchStageOutputWithContext(context.Context) MonitoredResourceDescriptorLaunchStageOutput
}

MonitoredResourceDescriptorLaunchStageInput is an input type that accepts MonitoredResourceDescriptorLaunchStageArgs and MonitoredResourceDescriptorLaunchStageOutput values. You can construct a concrete instance of `MonitoredResourceDescriptorLaunchStageInput` via:

MonitoredResourceDescriptorLaunchStageArgs{...}

type MonitoredResourceDescriptorLaunchStageOutput added in v0.6.0

type MonitoredResourceDescriptorLaunchStageOutput struct{ *pulumi.OutputState }

func (MonitoredResourceDescriptorLaunchStageOutput) ElementType added in v0.6.0

func (MonitoredResourceDescriptorLaunchStageOutput) ToMonitoredResourceDescriptorLaunchStageOutput added in v0.6.0

func (o MonitoredResourceDescriptorLaunchStageOutput) ToMonitoredResourceDescriptorLaunchStageOutput() MonitoredResourceDescriptorLaunchStageOutput

func (MonitoredResourceDescriptorLaunchStageOutput) ToMonitoredResourceDescriptorLaunchStageOutputWithContext added in v0.6.0

func (o MonitoredResourceDescriptorLaunchStageOutput) ToMonitoredResourceDescriptorLaunchStageOutputWithContext(ctx context.Context) MonitoredResourceDescriptorLaunchStageOutput

func (MonitoredResourceDescriptorLaunchStageOutput) ToMonitoredResourceDescriptorLaunchStagePtrOutput added in v0.6.0

func (o MonitoredResourceDescriptorLaunchStageOutput) ToMonitoredResourceDescriptorLaunchStagePtrOutput() MonitoredResourceDescriptorLaunchStagePtrOutput

func (MonitoredResourceDescriptorLaunchStageOutput) ToMonitoredResourceDescriptorLaunchStagePtrOutputWithContext added in v0.6.0

func (o MonitoredResourceDescriptorLaunchStageOutput) ToMonitoredResourceDescriptorLaunchStagePtrOutputWithContext(ctx context.Context) MonitoredResourceDescriptorLaunchStagePtrOutput

func (MonitoredResourceDescriptorLaunchStageOutput) ToStringOutput added in v0.6.0

func (MonitoredResourceDescriptorLaunchStageOutput) ToStringOutputWithContext added in v0.6.0

func (MonitoredResourceDescriptorLaunchStageOutput) ToStringPtrOutput added in v0.6.0

func (MonitoredResourceDescriptorLaunchStageOutput) ToStringPtrOutputWithContext added in v0.6.0

type MonitoredResourceDescriptorLaunchStagePtrInput added in v0.6.0

type MonitoredResourceDescriptorLaunchStagePtrInput interface {
	pulumi.Input

	ToMonitoredResourceDescriptorLaunchStagePtrOutput() MonitoredResourceDescriptorLaunchStagePtrOutput
	ToMonitoredResourceDescriptorLaunchStagePtrOutputWithContext(context.Context) MonitoredResourceDescriptorLaunchStagePtrOutput
}

func MonitoredResourceDescriptorLaunchStagePtr added in v0.6.0

func MonitoredResourceDescriptorLaunchStagePtr(v string) MonitoredResourceDescriptorLaunchStagePtrInput

type MonitoredResourceDescriptorLaunchStagePtrOutput added in v0.6.0

type MonitoredResourceDescriptorLaunchStagePtrOutput struct{ *pulumi.OutputState }

func (MonitoredResourceDescriptorLaunchStagePtrOutput) Elem added in v0.6.0

func (MonitoredResourceDescriptorLaunchStagePtrOutput) ElementType added in v0.6.0

func (MonitoredResourceDescriptorLaunchStagePtrOutput) ToMonitoredResourceDescriptorLaunchStagePtrOutput added in v0.6.0

func (o MonitoredResourceDescriptorLaunchStagePtrOutput) ToMonitoredResourceDescriptorLaunchStagePtrOutput() MonitoredResourceDescriptorLaunchStagePtrOutput

func (MonitoredResourceDescriptorLaunchStagePtrOutput) ToMonitoredResourceDescriptorLaunchStagePtrOutputWithContext added in v0.6.0

func (o MonitoredResourceDescriptorLaunchStagePtrOutput) ToMonitoredResourceDescriptorLaunchStagePtrOutputWithContext(ctx context.Context) MonitoredResourceDescriptorLaunchStagePtrOutput

func (MonitoredResourceDescriptorLaunchStagePtrOutput) ToStringPtrOutput added in v0.6.0

func (MonitoredResourceDescriptorLaunchStagePtrOutput) ToStringPtrOutputWithContext added in v0.6.0

type MonitoredResourceDescriptorOutput

type MonitoredResourceDescriptorOutput struct{ *pulumi.OutputState }

An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of `"gce_instance"` and specifies the use of the labels `"instance_id"` and `"zone"` to identify particular VM instances. Different APIs can support different monitored resource types. APIs generally provide a `list` method that returns the monitored resource descriptors used by the API.

func (MonitoredResourceDescriptorOutput) Description

Optional. A detailed description of the monitored resource type that might be used in documentation.

func (MonitoredResourceDescriptorOutput) DisplayName

Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, `"Google Cloud SQL Database"`.

func (MonitoredResourceDescriptorOutput) ElementType

func (MonitoredResourceDescriptorOutput) Labels

A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels `"database_id"` and `"zone"`.

func (MonitoredResourceDescriptorOutput) LaunchStage

Optional. The launch stage of the monitored resource definition.

func (MonitoredResourceDescriptorOutput) Name

Optional. The resource name of the monitored resource descriptor: `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where {type} is the value of the `type` field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format `"monitoredResourceDescriptors/{type}"`.

func (MonitoredResourceDescriptorOutput) ToMonitoredResourceDescriptorOutput

func (o MonitoredResourceDescriptorOutput) ToMonitoredResourceDescriptorOutput() MonitoredResourceDescriptorOutput

func (MonitoredResourceDescriptorOutput) ToMonitoredResourceDescriptorOutputWithContext

func (o MonitoredResourceDescriptorOutput) ToMonitoredResourceDescriptorOutputWithContext(ctx context.Context) MonitoredResourceDescriptorOutput

func (MonitoredResourceDescriptorOutput) Type

The monitored resource type. For example, the type `"cloudsql_database"` represents databases in Google Cloud SQL. For a list of types, see [Monitoring resource types](https://cloud.google.com/monitoring/api/resources) and [Logging resource types](https://cloud.google.com/logging/docs/api/v2/resource-list).

type MonitoredResourceDescriptorResponse

type MonitoredResourceDescriptorResponse struct {
	// Optional. A detailed description of the monitored resource type that might be used in documentation.
	Description string `pulumi:"description"`
	// Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, `"Google Cloud SQL Database"`.
	DisplayName string `pulumi:"displayName"`
	// A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels `"database_id"` and `"zone"`.
	Labels []LabelDescriptorResponse `pulumi:"labels"`
	// Optional. The launch stage of the monitored resource definition.
	LaunchStage string `pulumi:"launchStage"`
	// Optional. The resource name of the monitored resource descriptor: `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where {type} is the value of the `type` field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format `"monitoredResourceDescriptors/{type}"`.
	Name string `pulumi:"name"`
	// The monitored resource type. For example, the type `"cloudsql_database"` represents databases in Google Cloud SQL. For a list of types, see [Monitoring resource types](https://cloud.google.com/monitoring/api/resources) and [Logging resource types](https://cloud.google.com/logging/docs/api/v2/resource-list).
	Type string `pulumi:"type"`
}

An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of `"gce_instance"` and specifies the use of the labels `"instance_id"` and `"zone"` to identify particular VM instances. Different APIs can support different monitored resource types. APIs generally provide a `list` method that returns the monitored resource descriptors used by the API.

type MonitoredResourceDescriptorResponseArrayOutput

type MonitoredResourceDescriptorResponseArrayOutput struct{ *pulumi.OutputState }

func (MonitoredResourceDescriptorResponseArrayOutput) ElementType

func (MonitoredResourceDescriptorResponseArrayOutput) Index

func (MonitoredResourceDescriptorResponseArrayOutput) ToMonitoredResourceDescriptorResponseArrayOutput

func (o MonitoredResourceDescriptorResponseArrayOutput) ToMonitoredResourceDescriptorResponseArrayOutput() MonitoredResourceDescriptorResponseArrayOutput

func (MonitoredResourceDescriptorResponseArrayOutput) ToMonitoredResourceDescriptorResponseArrayOutputWithContext

func (o MonitoredResourceDescriptorResponseArrayOutput) ToMonitoredResourceDescriptorResponseArrayOutputWithContext(ctx context.Context) MonitoredResourceDescriptorResponseArrayOutput

type MonitoredResourceDescriptorResponseOutput

type MonitoredResourceDescriptorResponseOutput struct{ *pulumi.OutputState }

An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of `"gce_instance"` and specifies the use of the labels `"instance_id"` and `"zone"` to identify particular VM instances. Different APIs can support different monitored resource types. APIs generally provide a `list` method that returns the monitored resource descriptors used by the API.

func (MonitoredResourceDescriptorResponseOutput) Description

Optional. A detailed description of the monitored resource type that might be used in documentation.

func (MonitoredResourceDescriptorResponseOutput) DisplayName

Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, `"Google Cloud SQL Database"`.

func (MonitoredResourceDescriptorResponseOutput) ElementType

func (MonitoredResourceDescriptorResponseOutput) Labels

A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels `"database_id"` and `"zone"`.

func (MonitoredResourceDescriptorResponseOutput) LaunchStage

Optional. The launch stage of the monitored resource definition.

func (MonitoredResourceDescriptorResponseOutput) Name

Optional. The resource name of the monitored resource descriptor: `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where {type} is the value of the `type` field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format `"monitoredResourceDescriptors/{type}"`.

func (MonitoredResourceDescriptorResponseOutput) ToMonitoredResourceDescriptorResponseOutput

func (o MonitoredResourceDescriptorResponseOutput) ToMonitoredResourceDescriptorResponseOutput() MonitoredResourceDescriptorResponseOutput

func (MonitoredResourceDescriptorResponseOutput) ToMonitoredResourceDescriptorResponseOutputWithContext

func (o MonitoredResourceDescriptorResponseOutput) ToMonitoredResourceDescriptorResponseOutputWithContext(ctx context.Context) MonitoredResourceDescriptorResponseOutput

func (MonitoredResourceDescriptorResponseOutput) Type

The monitored resource type. For example, the type `"cloudsql_database"` represents databases in Google Cloud SQL. For a list of types, see [Monitoring resource types](https://cloud.google.com/monitoring/api/resources) and [Logging resource types](https://cloud.google.com/logging/docs/api/v2/resource-list).

type Monitoring

type Monitoring struct {
	// Monitoring configurations for sending metrics to the consumer project. There can be multiple consumer destinations. A monitored resource type may appear in multiple monitoring destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used once in the Monitoring configuration.
	ConsumerDestinations []MonitoringDestination `pulumi:"consumerDestinations"`
	// Monitoring configurations for sending metrics to the producer project. There can be multiple producer destinations. A monitored resource type may appear in multiple monitoring destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used once in the Monitoring configuration.
	ProducerDestinations []MonitoringDestination `pulumi:"producerDestinations"`
}

Monitoring configuration of the service. The example below shows how to configure monitored resources and metrics for monitoring. In the example, a monitored resource and two metrics are defined. The `library.googleapis.com/book/returned_count` metric is sent to both producer and consumer projects, whereas the `library.googleapis.com/book/num_overdue` metric is only sent to the consumer project. monitored_resources: - type: library.googleapis.com/Branch display_name: "Library Branch" description: "A branch of a library." launch_stage: GA labels: - key: resource_container description: "The Cloud container (ie. project id) for the Branch." - key: location description: "The location of the library branch." - key: branch_id description: "The id of the branch." metrics: - name: library.googleapis.com/book/returned_count display_name: "Books Returned" description: "The count of books that have been returned." launch_stage: GA metric_kind: DELTA value_type: INT64 unit: "1" labels: - key: customer_id description: "The id of the customer." - name: library.googleapis.com/book/num_overdue display_name: "Books Overdue" description: "The current number of overdue books." launch_stage: GA metric_kind: GAUGE value_type: INT64 unit: "1" labels: - key: customer_id description: "The id of the customer." monitoring: producer_destinations: - monitored_resource: library.googleapis.com/Branch metrics: - library.googleapis.com/book/returned_count consumer_destinations: - monitored_resource: library.googleapis.com/Branch metrics: - library.googleapis.com/book/returned_count - library.googleapis.com/book/num_overdue

type MonitoringArgs

type MonitoringArgs struct {
	// Monitoring configurations for sending metrics to the consumer project. There can be multiple consumer destinations. A monitored resource type may appear in multiple monitoring destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used once in the Monitoring configuration.
	ConsumerDestinations MonitoringDestinationArrayInput `pulumi:"consumerDestinations"`
	// Monitoring configurations for sending metrics to the producer project. There can be multiple producer destinations. A monitored resource type may appear in multiple monitoring destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used once in the Monitoring configuration.
	ProducerDestinations MonitoringDestinationArrayInput `pulumi:"producerDestinations"`
}

Monitoring configuration of the service. The example below shows how to configure monitored resources and metrics for monitoring. In the example, a monitored resource and two metrics are defined. The `library.googleapis.com/book/returned_count` metric is sent to both producer and consumer projects, whereas the `library.googleapis.com/book/num_overdue` metric is only sent to the consumer project. monitored_resources: - type: library.googleapis.com/Branch display_name: "Library Branch" description: "A branch of a library." launch_stage: GA labels: - key: resource_container description: "The Cloud container (ie. project id) for the Branch." - key: location description: "The location of the library branch." - key: branch_id description: "The id of the branch." metrics: - name: library.googleapis.com/book/returned_count display_name: "Books Returned" description: "The count of books that have been returned." launch_stage: GA metric_kind: DELTA value_type: INT64 unit: "1" labels: - key: customer_id description: "The id of the customer." - name: library.googleapis.com/book/num_overdue display_name: "Books Overdue" description: "The current number of overdue books." launch_stage: GA metric_kind: GAUGE value_type: INT64 unit: "1" labels: - key: customer_id description: "The id of the customer." monitoring: producer_destinations: - monitored_resource: library.googleapis.com/Branch metrics: - library.googleapis.com/book/returned_count consumer_destinations: - monitored_resource: library.googleapis.com/Branch metrics: - library.googleapis.com/book/returned_count - library.googleapis.com/book/num_overdue

func (MonitoringArgs) ElementType

func (MonitoringArgs) ElementType() reflect.Type

func (MonitoringArgs) ToMonitoringOutput

func (i MonitoringArgs) ToMonitoringOutput() MonitoringOutput

func (MonitoringArgs) ToMonitoringOutputWithContext

func (i MonitoringArgs) ToMonitoringOutputWithContext(ctx context.Context) MonitoringOutput

func (MonitoringArgs) ToMonitoringPtrOutput

func (i MonitoringArgs) ToMonitoringPtrOutput() MonitoringPtrOutput

func (MonitoringArgs) ToMonitoringPtrOutputWithContext

func (i MonitoringArgs) ToMonitoringPtrOutputWithContext(ctx context.Context) MonitoringPtrOutput

type MonitoringDestination

type MonitoringDestination struct {
	// Types of the metrics to report to this monitoring destination. Each type must be defined in Service.metrics section.
	Metrics []string `pulumi:"metrics"`
	// The monitored resource type. The type must be defined in Service.monitored_resources section.
	MonitoredResource *string `pulumi:"monitoredResource"`
}

Configuration of a specific monitoring destination (the producer project or the consumer project).

type MonitoringDestinationArgs

type MonitoringDestinationArgs struct {
	// Types of the metrics to report to this monitoring destination. Each type must be defined in Service.metrics section.
	Metrics pulumi.StringArrayInput `pulumi:"metrics"`
	// The monitored resource type. The type must be defined in Service.monitored_resources section.
	MonitoredResource pulumi.StringPtrInput `pulumi:"monitoredResource"`
}

Configuration of a specific monitoring destination (the producer project or the consumer project).

func (MonitoringDestinationArgs) ElementType

func (MonitoringDestinationArgs) ElementType() reflect.Type

func (MonitoringDestinationArgs) ToMonitoringDestinationOutput

func (i MonitoringDestinationArgs) ToMonitoringDestinationOutput() MonitoringDestinationOutput

func (MonitoringDestinationArgs) ToMonitoringDestinationOutputWithContext

func (i MonitoringDestinationArgs) ToMonitoringDestinationOutputWithContext(ctx context.Context) MonitoringDestinationOutput

type MonitoringDestinationArray

type MonitoringDestinationArray []MonitoringDestinationInput

func (MonitoringDestinationArray) ElementType

func (MonitoringDestinationArray) ElementType() reflect.Type

func (MonitoringDestinationArray) ToMonitoringDestinationArrayOutput

func (i MonitoringDestinationArray) ToMonitoringDestinationArrayOutput() MonitoringDestinationArrayOutput

func (MonitoringDestinationArray) ToMonitoringDestinationArrayOutputWithContext

func (i MonitoringDestinationArray) ToMonitoringDestinationArrayOutputWithContext(ctx context.Context) MonitoringDestinationArrayOutput

type MonitoringDestinationArrayInput

type MonitoringDestinationArrayInput interface {
	pulumi.Input

	ToMonitoringDestinationArrayOutput() MonitoringDestinationArrayOutput
	ToMonitoringDestinationArrayOutputWithContext(context.Context) MonitoringDestinationArrayOutput
}

MonitoringDestinationArrayInput is an input type that accepts MonitoringDestinationArray and MonitoringDestinationArrayOutput values. You can construct a concrete instance of `MonitoringDestinationArrayInput` via:

MonitoringDestinationArray{ MonitoringDestinationArgs{...} }

type MonitoringDestinationArrayOutput

type MonitoringDestinationArrayOutput struct{ *pulumi.OutputState }

func (MonitoringDestinationArrayOutput) ElementType

func (MonitoringDestinationArrayOutput) Index

func (MonitoringDestinationArrayOutput) ToMonitoringDestinationArrayOutput

func (o MonitoringDestinationArrayOutput) ToMonitoringDestinationArrayOutput() MonitoringDestinationArrayOutput

func (MonitoringDestinationArrayOutput) ToMonitoringDestinationArrayOutputWithContext

func (o MonitoringDestinationArrayOutput) ToMonitoringDestinationArrayOutputWithContext(ctx context.Context) MonitoringDestinationArrayOutput

type MonitoringDestinationInput

type MonitoringDestinationInput interface {
	pulumi.Input

	ToMonitoringDestinationOutput() MonitoringDestinationOutput
	ToMonitoringDestinationOutputWithContext(context.Context) MonitoringDestinationOutput
}

MonitoringDestinationInput is an input type that accepts MonitoringDestinationArgs and MonitoringDestinationOutput values. You can construct a concrete instance of `MonitoringDestinationInput` via:

MonitoringDestinationArgs{...}

type MonitoringDestinationOutput

type MonitoringDestinationOutput struct{ *pulumi.OutputState }

Configuration of a specific monitoring destination (the producer project or the consumer project).

func (MonitoringDestinationOutput) ElementType

func (MonitoringDestinationOutput) Metrics

Types of the metrics to report to this monitoring destination. Each type must be defined in Service.metrics section.

func (MonitoringDestinationOutput) MonitoredResource

func (o MonitoringDestinationOutput) MonitoredResource() pulumi.StringPtrOutput

The monitored resource type. The type must be defined in Service.monitored_resources section.

func (MonitoringDestinationOutput) ToMonitoringDestinationOutput

func (o MonitoringDestinationOutput) ToMonitoringDestinationOutput() MonitoringDestinationOutput

func (MonitoringDestinationOutput) ToMonitoringDestinationOutputWithContext

func (o MonitoringDestinationOutput) ToMonitoringDestinationOutputWithContext(ctx context.Context) MonitoringDestinationOutput

type MonitoringDestinationResponse

type MonitoringDestinationResponse struct {
	// Types of the metrics to report to this monitoring destination. Each type must be defined in Service.metrics section.
	Metrics []string `pulumi:"metrics"`
	// The monitored resource type. The type must be defined in Service.monitored_resources section.
	MonitoredResource string `pulumi:"monitoredResource"`
}

Configuration of a specific monitoring destination (the producer project or the consumer project).

type MonitoringDestinationResponseArrayOutput

type MonitoringDestinationResponseArrayOutput struct{ *pulumi.OutputState }

func (MonitoringDestinationResponseArrayOutput) ElementType

func (MonitoringDestinationResponseArrayOutput) Index

func (MonitoringDestinationResponseArrayOutput) ToMonitoringDestinationResponseArrayOutput

func (o MonitoringDestinationResponseArrayOutput) ToMonitoringDestinationResponseArrayOutput() MonitoringDestinationResponseArrayOutput

func (MonitoringDestinationResponseArrayOutput) ToMonitoringDestinationResponseArrayOutputWithContext

func (o MonitoringDestinationResponseArrayOutput) ToMonitoringDestinationResponseArrayOutputWithContext(ctx context.Context) MonitoringDestinationResponseArrayOutput

type MonitoringDestinationResponseOutput

type MonitoringDestinationResponseOutput struct{ *pulumi.OutputState }

Configuration of a specific monitoring destination (the producer project or the consumer project).

func (MonitoringDestinationResponseOutput) ElementType

func (MonitoringDestinationResponseOutput) Metrics

Types of the metrics to report to this monitoring destination. Each type must be defined in Service.metrics section.

func (MonitoringDestinationResponseOutput) MonitoredResource

The monitored resource type. The type must be defined in Service.monitored_resources section.

func (MonitoringDestinationResponseOutput) ToMonitoringDestinationResponseOutput

func (o MonitoringDestinationResponseOutput) ToMonitoringDestinationResponseOutput() MonitoringDestinationResponseOutput

func (MonitoringDestinationResponseOutput) ToMonitoringDestinationResponseOutputWithContext

func (o MonitoringDestinationResponseOutput) ToMonitoringDestinationResponseOutputWithContext(ctx context.Context) MonitoringDestinationResponseOutput

type MonitoringInput

type MonitoringInput interface {
	pulumi.Input

	ToMonitoringOutput() MonitoringOutput
	ToMonitoringOutputWithContext(context.Context) MonitoringOutput
}

MonitoringInput is an input type that accepts MonitoringArgs and MonitoringOutput values. You can construct a concrete instance of `MonitoringInput` via:

MonitoringArgs{...}

type MonitoringOutput

type MonitoringOutput struct{ *pulumi.OutputState }

Monitoring configuration of the service. The example below shows how to configure monitored resources and metrics for monitoring. In the example, a monitored resource and two metrics are defined. The `library.googleapis.com/book/returned_count` metric is sent to both producer and consumer projects, whereas the `library.googleapis.com/book/num_overdue` metric is only sent to the consumer project. monitored_resources: - type: library.googleapis.com/Branch display_name: "Library Branch" description: "A branch of a library." launch_stage: GA labels: - key: resource_container description: "The Cloud container (ie. project id) for the Branch." - key: location description: "The location of the library branch." - key: branch_id description: "The id of the branch." metrics: - name: library.googleapis.com/book/returned_count display_name: "Books Returned" description: "The count of books that have been returned." launch_stage: GA metric_kind: DELTA value_type: INT64 unit: "1" labels: - key: customer_id description: "The id of the customer." - name: library.googleapis.com/book/num_overdue display_name: "Books Overdue" description: "The current number of overdue books." launch_stage: GA metric_kind: GAUGE value_type: INT64 unit: "1" labels: - key: customer_id description: "The id of the customer." monitoring: producer_destinations: - monitored_resource: library.googleapis.com/Branch metrics: - library.googleapis.com/book/returned_count consumer_destinations: - monitored_resource: library.googleapis.com/Branch metrics: - library.googleapis.com/book/returned_count - library.googleapis.com/book/num_overdue

func (MonitoringOutput) ConsumerDestinations

func (o MonitoringOutput) ConsumerDestinations() MonitoringDestinationArrayOutput

Monitoring configurations for sending metrics to the consumer project. There can be multiple consumer destinations. A monitored resource type may appear in multiple monitoring destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used once in the Monitoring configuration.

func (MonitoringOutput) ElementType

func (MonitoringOutput) ElementType() reflect.Type

func (MonitoringOutput) ProducerDestinations

func (o MonitoringOutput) ProducerDestinations() MonitoringDestinationArrayOutput

Monitoring configurations for sending metrics to the producer project. There can be multiple producer destinations. A monitored resource type may appear in multiple monitoring destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used once in the Monitoring configuration.

func (MonitoringOutput) ToMonitoringOutput

func (o MonitoringOutput) ToMonitoringOutput() MonitoringOutput

func (MonitoringOutput) ToMonitoringOutputWithContext

func (o MonitoringOutput) ToMonitoringOutputWithContext(ctx context.Context) MonitoringOutput

func (MonitoringOutput) ToMonitoringPtrOutput

func (o MonitoringOutput) ToMonitoringPtrOutput() MonitoringPtrOutput

func (MonitoringOutput) ToMonitoringPtrOutputWithContext

func (o MonitoringOutput) ToMonitoringPtrOutputWithContext(ctx context.Context) MonitoringPtrOutput

type MonitoringPtrInput

type MonitoringPtrInput interface {
	pulumi.Input

	ToMonitoringPtrOutput() MonitoringPtrOutput
	ToMonitoringPtrOutputWithContext(context.Context) MonitoringPtrOutput
}

MonitoringPtrInput is an input type that accepts MonitoringArgs, MonitoringPtr and MonitoringPtrOutput values. You can construct a concrete instance of `MonitoringPtrInput` via:

        MonitoringArgs{...}

or:

        nil

func MonitoringPtr

func MonitoringPtr(v *MonitoringArgs) MonitoringPtrInput

type MonitoringPtrOutput

type MonitoringPtrOutput struct{ *pulumi.OutputState }

func (MonitoringPtrOutput) ConsumerDestinations

func (o MonitoringPtrOutput) ConsumerDestinations() MonitoringDestinationArrayOutput

Monitoring configurations for sending metrics to the consumer project. There can be multiple consumer destinations. A monitored resource type may appear in multiple monitoring destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used once in the Monitoring configuration.

func (MonitoringPtrOutput) Elem

func (MonitoringPtrOutput) ElementType

func (MonitoringPtrOutput) ElementType() reflect.Type

func (MonitoringPtrOutput) ProducerDestinations

func (o MonitoringPtrOutput) ProducerDestinations() MonitoringDestinationArrayOutput

Monitoring configurations for sending metrics to the producer project. There can be multiple producer destinations. A monitored resource type may appear in multiple monitoring destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used once in the Monitoring configuration.

func (MonitoringPtrOutput) ToMonitoringPtrOutput

func (o MonitoringPtrOutput) ToMonitoringPtrOutput() MonitoringPtrOutput

func (MonitoringPtrOutput) ToMonitoringPtrOutputWithContext

func (o MonitoringPtrOutput) ToMonitoringPtrOutputWithContext(ctx context.Context) MonitoringPtrOutput

type MonitoringResponse

type MonitoringResponse struct {
	// Monitoring configurations for sending metrics to the consumer project. There can be multiple consumer destinations. A monitored resource type may appear in multiple monitoring destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used once in the Monitoring configuration.
	ConsumerDestinations []MonitoringDestinationResponse `pulumi:"consumerDestinations"`
	// Monitoring configurations for sending metrics to the producer project. There can be multiple producer destinations. A monitored resource type may appear in multiple monitoring destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used once in the Monitoring configuration.
	ProducerDestinations []MonitoringDestinationResponse `pulumi:"producerDestinations"`
}

Monitoring configuration of the service. The example below shows how to configure monitored resources and metrics for monitoring. In the example, a monitored resource and two metrics are defined. The `library.googleapis.com/book/returned_count` metric is sent to both producer and consumer projects, whereas the `library.googleapis.com/book/num_overdue` metric is only sent to the consumer project. monitored_resources: - type: library.googleapis.com/Branch display_name: "Library Branch" description: "A branch of a library." launch_stage: GA labels: - key: resource_container description: "The Cloud container (ie. project id) for the Branch." - key: location description: "The location of the library branch." - key: branch_id description: "The id of the branch." metrics: - name: library.googleapis.com/book/returned_count display_name: "Books Returned" description: "The count of books that have been returned." launch_stage: GA metric_kind: DELTA value_type: INT64 unit: "1" labels: - key: customer_id description: "The id of the customer." - name: library.googleapis.com/book/num_overdue display_name: "Books Overdue" description: "The current number of overdue books." launch_stage: GA metric_kind: GAUGE value_type: INT64 unit: "1" labels: - key: customer_id description: "The id of the customer." monitoring: producer_destinations: - monitored_resource: library.googleapis.com/Branch metrics: - library.googleapis.com/book/returned_count consumer_destinations: - monitored_resource: library.googleapis.com/Branch metrics: - library.googleapis.com/book/returned_count - library.googleapis.com/book/num_overdue

type MonitoringResponseOutput

type MonitoringResponseOutput struct{ *pulumi.OutputState }

Monitoring configuration of the service. The example below shows how to configure monitored resources and metrics for monitoring. In the example, a monitored resource and two metrics are defined. The `library.googleapis.com/book/returned_count` metric is sent to both producer and consumer projects, whereas the `library.googleapis.com/book/num_overdue` metric is only sent to the consumer project. monitored_resources: - type: library.googleapis.com/Branch display_name: "Library Branch" description: "A branch of a library." launch_stage: GA labels: - key: resource_container description: "The Cloud container (ie. project id) for the Branch." - key: location description: "The location of the library branch." - key: branch_id description: "The id of the branch." metrics: - name: library.googleapis.com/book/returned_count display_name: "Books Returned" description: "The count of books that have been returned." launch_stage: GA metric_kind: DELTA value_type: INT64 unit: "1" labels: - key: customer_id description: "The id of the customer." - name: library.googleapis.com/book/num_overdue display_name: "Books Overdue" description: "The current number of overdue books." launch_stage: GA metric_kind: GAUGE value_type: INT64 unit: "1" labels: - key: customer_id description: "The id of the customer." monitoring: producer_destinations: - monitored_resource: library.googleapis.com/Branch metrics: - library.googleapis.com/book/returned_count consumer_destinations: - monitored_resource: library.googleapis.com/Branch metrics: - library.googleapis.com/book/returned_count - library.googleapis.com/book/num_overdue

func (MonitoringResponseOutput) ConsumerDestinations

Monitoring configurations for sending metrics to the consumer project. There can be multiple consumer destinations. A monitored resource type may appear in multiple monitoring destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used once in the Monitoring configuration.

func (MonitoringResponseOutput) ElementType

func (MonitoringResponseOutput) ElementType() reflect.Type

func (MonitoringResponseOutput) ProducerDestinations

Monitoring configurations for sending metrics to the producer project. There can be multiple producer destinations. A monitored resource type may appear in multiple monitoring destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used once in the Monitoring configuration.

func (MonitoringResponseOutput) ToMonitoringResponseOutput

func (o MonitoringResponseOutput) ToMonitoringResponseOutput() MonitoringResponseOutput

func (MonitoringResponseOutput) ToMonitoringResponseOutputWithContext

func (o MonitoringResponseOutput) ToMonitoringResponseOutputWithContext(ctx context.Context) MonitoringResponseOutput

type NodeSettings added in v0.28.0

type NodeSettings struct {
	// Some settings.
	Common *CommonLanguageSettings `pulumi:"common"`
}

Settings for Node client libraries.

type NodeSettingsArgs added in v0.28.0

type NodeSettingsArgs struct {
	// Some settings.
	Common CommonLanguageSettingsPtrInput `pulumi:"common"`
}

Settings for Node client libraries.

func (NodeSettingsArgs) ElementType added in v0.28.0

func (NodeSettingsArgs) ElementType() reflect.Type

func (NodeSettingsArgs) ToNodeSettingsOutput added in v0.28.0

func (i NodeSettingsArgs) ToNodeSettingsOutput() NodeSettingsOutput

func (NodeSettingsArgs) ToNodeSettingsOutputWithContext added in v0.28.0

func (i NodeSettingsArgs) ToNodeSettingsOutputWithContext(ctx context.Context) NodeSettingsOutput

func (NodeSettingsArgs) ToNodeSettingsPtrOutput added in v0.28.0

func (i NodeSettingsArgs) ToNodeSettingsPtrOutput() NodeSettingsPtrOutput

func (NodeSettingsArgs) ToNodeSettingsPtrOutputWithContext added in v0.28.0

func (i NodeSettingsArgs) ToNodeSettingsPtrOutputWithContext(ctx context.Context) NodeSettingsPtrOutput

type NodeSettingsInput added in v0.28.0

type NodeSettingsInput interface {
	pulumi.Input

	ToNodeSettingsOutput() NodeSettingsOutput
	ToNodeSettingsOutputWithContext(context.Context) NodeSettingsOutput
}

NodeSettingsInput is an input type that accepts NodeSettingsArgs and NodeSettingsOutput values. You can construct a concrete instance of `NodeSettingsInput` via:

NodeSettingsArgs{...}

type NodeSettingsOutput added in v0.28.0

type NodeSettingsOutput struct{ *pulumi.OutputState }

Settings for Node client libraries.

func (NodeSettingsOutput) Common added in v0.28.0

Some settings.

func (NodeSettingsOutput) ElementType added in v0.28.0

func (NodeSettingsOutput) ElementType() reflect.Type

func (NodeSettingsOutput) ToNodeSettingsOutput added in v0.28.0

func (o NodeSettingsOutput) ToNodeSettingsOutput() NodeSettingsOutput

func (NodeSettingsOutput) ToNodeSettingsOutputWithContext added in v0.28.0

func (o NodeSettingsOutput) ToNodeSettingsOutputWithContext(ctx context.Context) NodeSettingsOutput

func (NodeSettingsOutput) ToNodeSettingsPtrOutput added in v0.28.0

func (o NodeSettingsOutput) ToNodeSettingsPtrOutput() NodeSettingsPtrOutput

func (NodeSettingsOutput) ToNodeSettingsPtrOutputWithContext added in v0.28.0

func (o NodeSettingsOutput) ToNodeSettingsPtrOutputWithContext(ctx context.Context) NodeSettingsPtrOutput

type NodeSettingsPtrInput added in v0.28.0

type NodeSettingsPtrInput interface {
	pulumi.Input

	ToNodeSettingsPtrOutput() NodeSettingsPtrOutput
	ToNodeSettingsPtrOutputWithContext(context.Context) NodeSettingsPtrOutput
}

NodeSettingsPtrInput is an input type that accepts NodeSettingsArgs, NodeSettingsPtr and NodeSettingsPtrOutput values. You can construct a concrete instance of `NodeSettingsPtrInput` via:

        NodeSettingsArgs{...}

or:

        nil

func NodeSettingsPtr added in v0.28.0

func NodeSettingsPtr(v *NodeSettingsArgs) NodeSettingsPtrInput

type NodeSettingsPtrOutput added in v0.28.0

type NodeSettingsPtrOutput struct{ *pulumi.OutputState }

func (NodeSettingsPtrOutput) Common added in v0.28.0

Some settings.

func (NodeSettingsPtrOutput) Elem added in v0.28.0

func (NodeSettingsPtrOutput) ElementType added in v0.28.0

func (NodeSettingsPtrOutput) ElementType() reflect.Type

func (NodeSettingsPtrOutput) ToNodeSettingsPtrOutput added in v0.28.0

func (o NodeSettingsPtrOutput) ToNodeSettingsPtrOutput() NodeSettingsPtrOutput

func (NodeSettingsPtrOutput) ToNodeSettingsPtrOutputWithContext added in v0.28.0

func (o NodeSettingsPtrOutput) ToNodeSettingsPtrOutputWithContext(ctx context.Context) NodeSettingsPtrOutput

type NodeSettingsResponse added in v0.28.0

type NodeSettingsResponse struct {
	// Some settings.
	Common CommonLanguageSettingsResponse `pulumi:"common"`
}

Settings for Node client libraries.

type NodeSettingsResponseOutput added in v0.28.0

type NodeSettingsResponseOutput struct{ *pulumi.OutputState }

Settings for Node client libraries.

func (NodeSettingsResponseOutput) Common added in v0.28.0

Some settings.

func (NodeSettingsResponseOutput) ElementType added in v0.28.0

func (NodeSettingsResponseOutput) ElementType() reflect.Type

func (NodeSettingsResponseOutput) ToNodeSettingsResponseOutput added in v0.28.0

func (o NodeSettingsResponseOutput) ToNodeSettingsResponseOutput() NodeSettingsResponseOutput

func (NodeSettingsResponseOutput) ToNodeSettingsResponseOutputWithContext added in v0.28.0

func (o NodeSettingsResponseOutput) ToNodeSettingsResponseOutputWithContext(ctx context.Context) NodeSettingsResponseOutput

type OAuthRequirements

type OAuthRequirements struct {
	// The list of publicly documented OAuth scopes that are allowed access. An OAuth token containing any of these scopes will be accepted. Example: canonical_scopes: https://www.googleapis.com/auth/calendar, https://www.googleapis.com/auth/calendar.read
	CanonicalScopes *string `pulumi:"canonicalScopes"`
}

OAuth scopes are a way to define data and permissions on data. For example, there are scopes defined for "Read-only access to Google Calendar" and "Access to Cloud Platform". Users can consent to a scope for an application, giving it permission to access that data on their behalf. OAuth scope specifications should be fairly coarse grained; a user will need to see and understand the text description of what your scope means. In most cases: use one or at most two OAuth scopes for an entire family of products. If your product has multiple APIs, you should probably be sharing the OAuth scope across all of those APIs. When you need finer grained OAuth consent screens: talk with your product management about how developers will use them in practice. Please note that even though each of the canonical scopes is enough for a request to be accepted and passed to the backend, a request can still fail due to the backend requiring additional scopes or permissions.

type OAuthRequirementsArgs

type OAuthRequirementsArgs struct {
	// The list of publicly documented OAuth scopes that are allowed access. An OAuth token containing any of these scopes will be accepted. Example: canonical_scopes: https://www.googleapis.com/auth/calendar, https://www.googleapis.com/auth/calendar.read
	CanonicalScopes pulumi.StringPtrInput `pulumi:"canonicalScopes"`
}

OAuth scopes are a way to define data and permissions on data. For example, there are scopes defined for "Read-only access to Google Calendar" and "Access to Cloud Platform". Users can consent to a scope for an application, giving it permission to access that data on their behalf. OAuth scope specifications should be fairly coarse grained; a user will need to see and understand the text description of what your scope means. In most cases: use one or at most two OAuth scopes for an entire family of products. If your product has multiple APIs, you should probably be sharing the OAuth scope across all of those APIs. When you need finer grained OAuth consent screens: talk with your product management about how developers will use them in practice. Please note that even though each of the canonical scopes is enough for a request to be accepted and passed to the backend, a request can still fail due to the backend requiring additional scopes or permissions.

func (OAuthRequirementsArgs) ElementType

func (OAuthRequirementsArgs) ElementType() reflect.Type

func (OAuthRequirementsArgs) ToOAuthRequirementsOutput

func (i OAuthRequirementsArgs) ToOAuthRequirementsOutput() OAuthRequirementsOutput

func (OAuthRequirementsArgs) ToOAuthRequirementsOutputWithContext

func (i OAuthRequirementsArgs) ToOAuthRequirementsOutputWithContext(ctx context.Context) OAuthRequirementsOutput

func (OAuthRequirementsArgs) ToOAuthRequirementsPtrOutput

func (i OAuthRequirementsArgs) ToOAuthRequirementsPtrOutput() OAuthRequirementsPtrOutput

func (OAuthRequirementsArgs) ToOAuthRequirementsPtrOutputWithContext

func (i OAuthRequirementsArgs) ToOAuthRequirementsPtrOutputWithContext(ctx context.Context) OAuthRequirementsPtrOutput

type OAuthRequirementsInput

type OAuthRequirementsInput interface {
	pulumi.Input

	ToOAuthRequirementsOutput() OAuthRequirementsOutput
	ToOAuthRequirementsOutputWithContext(context.Context) OAuthRequirementsOutput
}

OAuthRequirementsInput is an input type that accepts OAuthRequirementsArgs and OAuthRequirementsOutput values. You can construct a concrete instance of `OAuthRequirementsInput` via:

OAuthRequirementsArgs{...}

type OAuthRequirementsOutput

type OAuthRequirementsOutput struct{ *pulumi.OutputState }

OAuth scopes are a way to define data and permissions on data. For example, there are scopes defined for "Read-only access to Google Calendar" and "Access to Cloud Platform". Users can consent to a scope for an application, giving it permission to access that data on their behalf. OAuth scope specifications should be fairly coarse grained; a user will need to see and understand the text description of what your scope means. In most cases: use one or at most two OAuth scopes for an entire family of products. If your product has multiple APIs, you should probably be sharing the OAuth scope across all of those APIs. When you need finer grained OAuth consent screens: talk with your product management about how developers will use them in practice. Please note that even though each of the canonical scopes is enough for a request to be accepted and passed to the backend, a request can still fail due to the backend requiring additional scopes or permissions.

func (OAuthRequirementsOutput) CanonicalScopes

func (o OAuthRequirementsOutput) CanonicalScopes() pulumi.StringPtrOutput

The list of publicly documented OAuth scopes that are allowed access. An OAuth token containing any of these scopes will be accepted. Example: canonical_scopes: https://www.googleapis.com/auth/calendar, https://www.googleapis.com/auth/calendar.read

func (OAuthRequirementsOutput) ElementType

func (OAuthRequirementsOutput) ElementType() reflect.Type

func (OAuthRequirementsOutput) ToOAuthRequirementsOutput

func (o OAuthRequirementsOutput) ToOAuthRequirementsOutput() OAuthRequirementsOutput

func (OAuthRequirementsOutput) ToOAuthRequirementsOutputWithContext

func (o OAuthRequirementsOutput) ToOAuthRequirementsOutputWithContext(ctx context.Context) OAuthRequirementsOutput

func (OAuthRequirementsOutput) ToOAuthRequirementsPtrOutput

func (o OAuthRequirementsOutput) ToOAuthRequirementsPtrOutput() OAuthRequirementsPtrOutput

func (OAuthRequirementsOutput) ToOAuthRequirementsPtrOutputWithContext

func (o OAuthRequirementsOutput) ToOAuthRequirementsPtrOutputWithContext(ctx context.Context) OAuthRequirementsPtrOutput

type OAuthRequirementsPtrInput

type OAuthRequirementsPtrInput interface {
	pulumi.Input

	ToOAuthRequirementsPtrOutput() OAuthRequirementsPtrOutput
	ToOAuthRequirementsPtrOutputWithContext(context.Context) OAuthRequirementsPtrOutput
}

OAuthRequirementsPtrInput is an input type that accepts OAuthRequirementsArgs, OAuthRequirementsPtr and OAuthRequirementsPtrOutput values. You can construct a concrete instance of `OAuthRequirementsPtrInput` via:

        OAuthRequirementsArgs{...}

or:

        nil

type OAuthRequirementsPtrOutput

type OAuthRequirementsPtrOutput struct{ *pulumi.OutputState }

func (OAuthRequirementsPtrOutput) CanonicalScopes

The list of publicly documented OAuth scopes that are allowed access. An OAuth token containing any of these scopes will be accepted. Example: canonical_scopes: https://www.googleapis.com/auth/calendar, https://www.googleapis.com/auth/calendar.read

func (OAuthRequirementsPtrOutput) Elem

func (OAuthRequirementsPtrOutput) ElementType

func (OAuthRequirementsPtrOutput) ElementType() reflect.Type

func (OAuthRequirementsPtrOutput) ToOAuthRequirementsPtrOutput

func (o OAuthRequirementsPtrOutput) ToOAuthRequirementsPtrOutput() OAuthRequirementsPtrOutput

func (OAuthRequirementsPtrOutput) ToOAuthRequirementsPtrOutputWithContext

func (o OAuthRequirementsPtrOutput) ToOAuthRequirementsPtrOutputWithContext(ctx context.Context) OAuthRequirementsPtrOutput

type OAuthRequirementsResponse

type OAuthRequirementsResponse struct {
	// The list of publicly documented OAuth scopes that are allowed access. An OAuth token containing any of these scopes will be accepted. Example: canonical_scopes: https://www.googleapis.com/auth/calendar, https://www.googleapis.com/auth/calendar.read
	CanonicalScopes string `pulumi:"canonicalScopes"`
}

OAuth scopes are a way to define data and permissions on data. For example, there are scopes defined for "Read-only access to Google Calendar" and "Access to Cloud Platform". Users can consent to a scope for an application, giving it permission to access that data on their behalf. OAuth scope specifications should be fairly coarse grained; a user will need to see and understand the text description of what your scope means. In most cases: use one or at most two OAuth scopes for an entire family of products. If your product has multiple APIs, you should probably be sharing the OAuth scope across all of those APIs. When you need finer grained OAuth consent screens: talk with your product management about how developers will use them in practice. Please note that even though each of the canonical scopes is enough for a request to be accepted and passed to the backend, a request can still fail due to the backend requiring additional scopes or permissions.

type OAuthRequirementsResponseOutput

type OAuthRequirementsResponseOutput struct{ *pulumi.OutputState }

OAuth scopes are a way to define data and permissions on data. For example, there are scopes defined for "Read-only access to Google Calendar" and "Access to Cloud Platform". Users can consent to a scope for an application, giving it permission to access that data on their behalf. OAuth scope specifications should be fairly coarse grained; a user will need to see and understand the text description of what your scope means. In most cases: use one or at most two OAuth scopes for an entire family of products. If your product has multiple APIs, you should probably be sharing the OAuth scope across all of those APIs. When you need finer grained OAuth consent screens: talk with your product management about how developers will use them in practice. Please note that even though each of the canonical scopes is enough for a request to be accepted and passed to the backend, a request can still fail due to the backend requiring additional scopes or permissions.

func (OAuthRequirementsResponseOutput) CanonicalScopes

The list of publicly documented OAuth scopes that are allowed access. An OAuth token containing any of these scopes will be accepted. Example: canonical_scopes: https://www.googleapis.com/auth/calendar, https://www.googleapis.com/auth/calendar.read

func (OAuthRequirementsResponseOutput) ElementType

func (OAuthRequirementsResponseOutput) ToOAuthRequirementsResponseOutput

func (o OAuthRequirementsResponseOutput) ToOAuthRequirementsResponseOutput() OAuthRequirementsResponseOutput

func (OAuthRequirementsResponseOutput) ToOAuthRequirementsResponseOutputWithContext

func (o OAuthRequirementsResponseOutput) ToOAuthRequirementsResponseOutputWithContext(ctx context.Context) OAuthRequirementsResponseOutput

type Option

type Option struct {
	// The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`.
	Name *string `pulumi:"name"`
	// The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type.
	Value map[string]string `pulumi:"value"`
}

A protocol buffer option, which can be attached to a message, field, enumeration, etc.

type OptionArgs

type OptionArgs struct {
	// The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`.
	Name pulumi.StringPtrInput `pulumi:"name"`
	// The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type.
	Value pulumi.StringMapInput `pulumi:"value"`
}

A protocol buffer option, which can be attached to a message, field, enumeration, etc.

func (OptionArgs) ElementType

func (OptionArgs) ElementType() reflect.Type

func (OptionArgs) ToOptionOutput

func (i OptionArgs) ToOptionOutput() OptionOutput

func (OptionArgs) ToOptionOutputWithContext

func (i OptionArgs) ToOptionOutputWithContext(ctx context.Context) OptionOutput

type OptionArray

type OptionArray []OptionInput

func (OptionArray) ElementType

func (OptionArray) ElementType() reflect.Type

func (OptionArray) ToOptionArrayOutput

func (i OptionArray) ToOptionArrayOutput() OptionArrayOutput

func (OptionArray) ToOptionArrayOutputWithContext

func (i OptionArray) ToOptionArrayOutputWithContext(ctx context.Context) OptionArrayOutput

type OptionArrayInput

type OptionArrayInput interface {
	pulumi.Input

	ToOptionArrayOutput() OptionArrayOutput
	ToOptionArrayOutputWithContext(context.Context) OptionArrayOutput
}

OptionArrayInput is an input type that accepts OptionArray and OptionArrayOutput values. You can construct a concrete instance of `OptionArrayInput` via:

OptionArray{ OptionArgs{...} }

type OptionArrayOutput

type OptionArrayOutput struct{ *pulumi.OutputState }

func (OptionArrayOutput) ElementType

func (OptionArrayOutput) ElementType() reflect.Type

func (OptionArrayOutput) Index

func (OptionArrayOutput) ToOptionArrayOutput

func (o OptionArrayOutput) ToOptionArrayOutput() OptionArrayOutput

func (OptionArrayOutput) ToOptionArrayOutputWithContext

func (o OptionArrayOutput) ToOptionArrayOutputWithContext(ctx context.Context) OptionArrayOutput

type OptionInput

type OptionInput interface {
	pulumi.Input

	ToOptionOutput() OptionOutput
	ToOptionOutputWithContext(context.Context) OptionOutput
}

OptionInput is an input type that accepts OptionArgs and OptionOutput values. You can construct a concrete instance of `OptionInput` via:

OptionArgs{...}

type OptionOutput

type OptionOutput struct{ *pulumi.OutputState }

A protocol buffer option, which can be attached to a message, field, enumeration, etc.

func (OptionOutput) ElementType

func (OptionOutput) ElementType() reflect.Type

func (OptionOutput) Name

The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`.

func (OptionOutput) ToOptionOutput

func (o OptionOutput) ToOptionOutput() OptionOutput

func (OptionOutput) ToOptionOutputWithContext

func (o OptionOutput) ToOptionOutputWithContext(ctx context.Context) OptionOutput

func (OptionOutput) Value

The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type.

type OptionResponse

type OptionResponse struct {
	// The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`.
	Name string `pulumi:"name"`
	// The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type.
	Value map[string]string `pulumi:"value"`
}

A protocol buffer option, which can be attached to a message, field, enumeration, etc.

type OptionResponseArrayOutput

type OptionResponseArrayOutput struct{ *pulumi.OutputState }

func (OptionResponseArrayOutput) ElementType

func (OptionResponseArrayOutput) ElementType() reflect.Type

func (OptionResponseArrayOutput) Index

func (OptionResponseArrayOutput) ToOptionResponseArrayOutput

func (o OptionResponseArrayOutput) ToOptionResponseArrayOutput() OptionResponseArrayOutput

func (OptionResponseArrayOutput) ToOptionResponseArrayOutputWithContext

func (o OptionResponseArrayOutput) ToOptionResponseArrayOutputWithContext(ctx context.Context) OptionResponseArrayOutput

type OptionResponseOutput

type OptionResponseOutput struct{ *pulumi.OutputState }

A protocol buffer option, which can be attached to a message, field, enumeration, etc.

func (OptionResponseOutput) ElementType

func (OptionResponseOutput) ElementType() reflect.Type

func (OptionResponseOutput) Name

The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`.

func (OptionResponseOutput) ToOptionResponseOutput

func (o OptionResponseOutput) ToOptionResponseOutput() OptionResponseOutput

func (OptionResponseOutput) ToOptionResponseOutputWithContext

func (o OptionResponseOutput) ToOptionResponseOutputWithContext(ctx context.Context) OptionResponseOutput

func (OptionResponseOutput) Value

The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type.

type Page

type Page struct {
	// The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.
	Content *string `pulumi:"content"`
	// The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with `.`) can be used as reference to the page in your documentation. For example: pages: - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java content: (== include tutorial_java.md ==) You can reference `Java` page using Markdown reference link syntax: `Java`.
	Name *string `pulumi:"name"`
	// Subpages of this page. The order of subpages specified here will be honored in the generated docset.
	Subpages []Page `pulumi:"subpages"`
}

Represents a documentation page. A page can contain subpages to represent nested documentation set structure.

type PageArgs

type PageArgs struct {
	// The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.
	Content pulumi.StringPtrInput `pulumi:"content"`
	// The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with `.`) can be used as reference to the page in your documentation. For example: pages: - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java content: (== include tutorial_java.md ==) You can reference `Java` page using Markdown reference link syntax: `Java`.
	Name pulumi.StringPtrInput `pulumi:"name"`
	// Subpages of this page. The order of subpages specified here will be honored in the generated docset.
	Subpages PageArrayInput `pulumi:"subpages"`
}

Represents a documentation page. A page can contain subpages to represent nested documentation set structure.

func (PageArgs) ElementType

func (PageArgs) ElementType() reflect.Type

func (PageArgs) ToPageOutput

func (i PageArgs) ToPageOutput() PageOutput

func (PageArgs) ToPageOutputWithContext

func (i PageArgs) ToPageOutputWithContext(ctx context.Context) PageOutput

type PageArray

type PageArray []PageInput

func (PageArray) ElementType

func (PageArray) ElementType() reflect.Type

func (PageArray) ToPageArrayOutput

func (i PageArray) ToPageArrayOutput() PageArrayOutput

func (PageArray) ToPageArrayOutputWithContext

func (i PageArray) ToPageArrayOutputWithContext(ctx context.Context) PageArrayOutput

type PageArrayInput

type PageArrayInput interface {
	pulumi.Input

	ToPageArrayOutput() PageArrayOutput
	ToPageArrayOutputWithContext(context.Context) PageArrayOutput
}

PageArrayInput is an input type that accepts PageArray and PageArrayOutput values. You can construct a concrete instance of `PageArrayInput` via:

PageArray{ PageArgs{...} }

type PageArrayOutput

type PageArrayOutput struct{ *pulumi.OutputState }

func (PageArrayOutput) ElementType

func (PageArrayOutput) ElementType() reflect.Type

func (PageArrayOutput) Index

func (PageArrayOutput) ToPageArrayOutput

func (o PageArrayOutput) ToPageArrayOutput() PageArrayOutput

func (PageArrayOutput) ToPageArrayOutputWithContext

func (o PageArrayOutput) ToPageArrayOutputWithContext(ctx context.Context) PageArrayOutput

type PageInput

type PageInput interface {
	pulumi.Input

	ToPageOutput() PageOutput
	ToPageOutputWithContext(context.Context) PageOutput
}

PageInput is an input type that accepts PageArgs and PageOutput values. You can construct a concrete instance of `PageInput` via:

PageArgs{...}

type PageOutput

type PageOutput struct{ *pulumi.OutputState }

Represents a documentation page. A page can contain subpages to represent nested documentation set structure.

func (PageOutput) Content

func (o PageOutput) Content() pulumi.StringPtrOutput

The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.

func (PageOutput) ElementType

func (PageOutput) ElementType() reflect.Type

func (PageOutput) Name

The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with `.`) can be used as reference to the page in your documentation. For example: pages: - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java content: (== include tutorial_java.md ==) You can reference `Java` page using Markdown reference link syntax: `Java`.

func (PageOutput) Subpages

func (o PageOutput) Subpages() PageArrayOutput

Subpages of this page. The order of subpages specified here will be honored in the generated docset.

func (PageOutput) ToPageOutput

func (o PageOutput) ToPageOutput() PageOutput

func (PageOutput) ToPageOutputWithContext

func (o PageOutput) ToPageOutputWithContext(ctx context.Context) PageOutput

type PageResponse

type PageResponse struct {
	// The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.
	Content string `pulumi:"content"`
	// The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with `.`) can be used as reference to the page in your documentation. For example: pages: - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java content: (== include tutorial_java.md ==) You can reference `Java` page using Markdown reference link syntax: `Java`.
	Name string `pulumi:"name"`
	// Subpages of this page. The order of subpages specified here will be honored in the generated docset.
	Subpages []PageResponse `pulumi:"subpages"`
}

Represents a documentation page. A page can contain subpages to represent nested documentation set structure.

type PageResponseArrayOutput

type PageResponseArrayOutput struct{ *pulumi.OutputState }

func (PageResponseArrayOutput) ElementType

func (PageResponseArrayOutput) ElementType() reflect.Type

func (PageResponseArrayOutput) Index

func (PageResponseArrayOutput) ToPageResponseArrayOutput

func (o PageResponseArrayOutput) ToPageResponseArrayOutput() PageResponseArrayOutput

func (PageResponseArrayOutput) ToPageResponseArrayOutputWithContext

func (o PageResponseArrayOutput) ToPageResponseArrayOutputWithContext(ctx context.Context) PageResponseArrayOutput

type PageResponseOutput

type PageResponseOutput struct{ *pulumi.OutputState }

Represents a documentation page. A page can contain subpages to represent nested documentation set structure.

func (PageResponseOutput) Content

The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.

func (PageResponseOutput) ElementType

func (PageResponseOutput) ElementType() reflect.Type

func (PageResponseOutput) Name

The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with `.`) can be used as reference to the page in your documentation. For example: pages: - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java content: (== include tutorial_java.md ==) You can reference `Java` page using Markdown reference link syntax: `Java`.

func (PageResponseOutput) Subpages

Subpages of this page. The order of subpages specified here will be honored in the generated docset.

func (PageResponseOutput) ToPageResponseOutput

func (o PageResponseOutput) ToPageResponseOutput() PageResponseOutput

func (PageResponseOutput) ToPageResponseOutputWithContext

func (o PageResponseOutput) ToPageResponseOutputWithContext(ctx context.Context) PageResponseOutput

type PhpSettings added in v0.28.0

type PhpSettings struct {
	// Some settings.
	Common *CommonLanguageSettings `pulumi:"common"`
}

Settings for Php client libraries.

type PhpSettingsArgs added in v0.28.0

type PhpSettingsArgs struct {
	// Some settings.
	Common CommonLanguageSettingsPtrInput `pulumi:"common"`
}

Settings for Php client libraries.

func (PhpSettingsArgs) ElementType added in v0.28.0

func (PhpSettingsArgs) ElementType() reflect.Type

func (PhpSettingsArgs) ToPhpSettingsOutput added in v0.28.0

func (i PhpSettingsArgs) ToPhpSettingsOutput() PhpSettingsOutput

func (PhpSettingsArgs) ToPhpSettingsOutputWithContext added in v0.28.0

func (i PhpSettingsArgs) ToPhpSettingsOutputWithContext(ctx context.Context) PhpSettingsOutput

func (PhpSettingsArgs) ToPhpSettingsPtrOutput added in v0.28.0

func (i PhpSettingsArgs) ToPhpSettingsPtrOutput() PhpSettingsPtrOutput

func (PhpSettingsArgs) ToPhpSettingsPtrOutputWithContext added in v0.28.0

func (i PhpSettingsArgs) ToPhpSettingsPtrOutputWithContext(ctx context.Context) PhpSettingsPtrOutput

type PhpSettingsInput added in v0.28.0

type PhpSettingsInput interface {
	pulumi.Input

	ToPhpSettingsOutput() PhpSettingsOutput
	ToPhpSettingsOutputWithContext(context.Context) PhpSettingsOutput
}

PhpSettingsInput is an input type that accepts PhpSettingsArgs and PhpSettingsOutput values. You can construct a concrete instance of `PhpSettingsInput` via:

PhpSettingsArgs{...}

type PhpSettingsOutput added in v0.28.0

type PhpSettingsOutput struct{ *pulumi.OutputState }

Settings for Php client libraries.

func (PhpSettingsOutput) Common added in v0.28.0

Some settings.

func (PhpSettingsOutput) ElementType added in v0.28.0

func (PhpSettingsOutput) ElementType() reflect.Type

func (PhpSettingsOutput) ToPhpSettingsOutput added in v0.28.0

func (o PhpSettingsOutput) ToPhpSettingsOutput() PhpSettingsOutput

func (PhpSettingsOutput) ToPhpSettingsOutputWithContext added in v0.28.0

func (o PhpSettingsOutput) ToPhpSettingsOutputWithContext(ctx context.Context) PhpSettingsOutput

func (PhpSettingsOutput) ToPhpSettingsPtrOutput added in v0.28.0

func (o PhpSettingsOutput) ToPhpSettingsPtrOutput() PhpSettingsPtrOutput

func (PhpSettingsOutput) ToPhpSettingsPtrOutputWithContext added in v0.28.0

func (o PhpSettingsOutput) ToPhpSettingsPtrOutputWithContext(ctx context.Context) PhpSettingsPtrOutput

type PhpSettingsPtrInput added in v0.28.0

type PhpSettingsPtrInput interface {
	pulumi.Input

	ToPhpSettingsPtrOutput() PhpSettingsPtrOutput
	ToPhpSettingsPtrOutputWithContext(context.Context) PhpSettingsPtrOutput
}

PhpSettingsPtrInput is an input type that accepts PhpSettingsArgs, PhpSettingsPtr and PhpSettingsPtrOutput values. You can construct a concrete instance of `PhpSettingsPtrInput` via:

        PhpSettingsArgs{...}

or:

        nil

func PhpSettingsPtr added in v0.28.0

func PhpSettingsPtr(v *PhpSettingsArgs) PhpSettingsPtrInput

type PhpSettingsPtrOutput added in v0.28.0

type PhpSettingsPtrOutput struct{ *pulumi.OutputState }

func (PhpSettingsPtrOutput) Common added in v0.28.0

Some settings.

func (PhpSettingsPtrOutput) Elem added in v0.28.0

func (PhpSettingsPtrOutput) ElementType added in v0.28.0

func (PhpSettingsPtrOutput) ElementType() reflect.Type

func (PhpSettingsPtrOutput) ToPhpSettingsPtrOutput added in v0.28.0

func (o PhpSettingsPtrOutput) ToPhpSettingsPtrOutput() PhpSettingsPtrOutput

func (PhpSettingsPtrOutput) ToPhpSettingsPtrOutputWithContext added in v0.28.0

func (o PhpSettingsPtrOutput) ToPhpSettingsPtrOutputWithContext(ctx context.Context) PhpSettingsPtrOutput

type PhpSettingsResponse added in v0.28.0

type PhpSettingsResponse struct {
	// Some settings.
	Common CommonLanguageSettingsResponse `pulumi:"common"`
}

Settings for Php client libraries.

type PhpSettingsResponseOutput added in v0.28.0

type PhpSettingsResponseOutput struct{ *pulumi.OutputState }

Settings for Php client libraries.

func (PhpSettingsResponseOutput) Common added in v0.28.0

Some settings.

func (PhpSettingsResponseOutput) ElementType added in v0.28.0

func (PhpSettingsResponseOutput) ElementType() reflect.Type

func (PhpSettingsResponseOutput) ToPhpSettingsResponseOutput added in v0.28.0

func (o PhpSettingsResponseOutput) ToPhpSettingsResponseOutput() PhpSettingsResponseOutput

func (PhpSettingsResponseOutput) ToPhpSettingsResponseOutputWithContext added in v0.28.0

func (o PhpSettingsResponseOutput) ToPhpSettingsResponseOutputWithContext(ctx context.Context) PhpSettingsResponseOutput

type Publishing added in v0.28.0

type Publishing struct {
	// Used as a tracking tag when collecting data about the APIs developer relations artifacts like docs, packages delivered to package managers, etc. Example: "speech".
	ApiShortName *string `pulumi:"apiShortName"`
	// GitHub teams to be added to CODEOWNERS in the directory in GitHub containing source code for the client libraries for this API.
	CodeownerGithubTeams []string `pulumi:"codeownerGithubTeams"`
	// A prefix used in sample code when demarking regions to be included in documentation.
	DocTagPrefix *string `pulumi:"docTagPrefix"`
	// Link to product home page. Example: https://cloud.google.com/asset-inventory/docs/overview
	DocumentationUri *string `pulumi:"documentationUri"`
	// GitHub label to apply to issues and pull requests opened for this API.
	GithubLabel *string `pulumi:"githubLabel"`
	// Client library settings. If the same version string appears multiple times in this list, then the last one wins. Settings from earlier settings with the same version string are discarded.
	LibrarySettings []ClientLibrarySettings `pulumi:"librarySettings"`
	// A list of API method settings, e.g. the behavior for methods that use the long-running operation pattern.
	MethodSettings []MethodSettings `pulumi:"methodSettings"`
	// Link to a *public* URI where users can report issues. Example: https://issuetracker.google.com/issues/new?component=190865&template=1161103
	NewIssueUri *string `pulumi:"newIssueUri"`
	// For whom the client library is being published.
	Organization *PublishingOrganization `pulumi:"organization"`
	// Optional link to proto reference documentation. Example: https://cloud.google.com/pubsub/lite/docs/reference/rpc
	ProtoReferenceDocumentationUri *string `pulumi:"protoReferenceDocumentationUri"`
}

This message configures the settings for publishing [Google Cloud Client libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) generated from the service config.

type PublishingArgs added in v0.28.0

type PublishingArgs struct {
	// Used as a tracking tag when collecting data about the APIs developer relations artifacts like docs, packages delivered to package managers, etc. Example: "speech".
	ApiShortName pulumi.StringPtrInput `pulumi:"apiShortName"`
	// GitHub teams to be added to CODEOWNERS in the directory in GitHub containing source code for the client libraries for this API.
	CodeownerGithubTeams pulumi.StringArrayInput `pulumi:"codeownerGithubTeams"`
	// A prefix used in sample code when demarking regions to be included in documentation.
	DocTagPrefix pulumi.StringPtrInput `pulumi:"docTagPrefix"`
	// Link to product home page. Example: https://cloud.google.com/asset-inventory/docs/overview
	DocumentationUri pulumi.StringPtrInput `pulumi:"documentationUri"`
	// GitHub label to apply to issues and pull requests opened for this API.
	GithubLabel pulumi.StringPtrInput `pulumi:"githubLabel"`
	// Client library settings. If the same version string appears multiple times in this list, then the last one wins. Settings from earlier settings with the same version string are discarded.
	LibrarySettings ClientLibrarySettingsArrayInput `pulumi:"librarySettings"`
	// A list of API method settings, e.g. the behavior for methods that use the long-running operation pattern.
	MethodSettings MethodSettingsArrayInput `pulumi:"methodSettings"`
	// Link to a *public* URI where users can report issues. Example: https://issuetracker.google.com/issues/new?component=190865&template=1161103
	NewIssueUri pulumi.StringPtrInput `pulumi:"newIssueUri"`
	// For whom the client library is being published.
	Organization PublishingOrganizationPtrInput `pulumi:"organization"`
	// Optional link to proto reference documentation. Example: https://cloud.google.com/pubsub/lite/docs/reference/rpc
	ProtoReferenceDocumentationUri pulumi.StringPtrInput `pulumi:"protoReferenceDocumentationUri"`
}

This message configures the settings for publishing [Google Cloud Client libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) generated from the service config.

func (PublishingArgs) ElementType added in v0.28.0

func (PublishingArgs) ElementType() reflect.Type

func (PublishingArgs) ToPublishingOutput added in v0.28.0

func (i PublishingArgs) ToPublishingOutput() PublishingOutput

func (PublishingArgs) ToPublishingOutputWithContext added in v0.28.0

func (i PublishingArgs) ToPublishingOutputWithContext(ctx context.Context) PublishingOutput

func (PublishingArgs) ToPublishingPtrOutput added in v0.28.0

func (i PublishingArgs) ToPublishingPtrOutput() PublishingPtrOutput

func (PublishingArgs) ToPublishingPtrOutputWithContext added in v0.28.0

func (i PublishingArgs) ToPublishingPtrOutputWithContext(ctx context.Context) PublishingPtrOutput

type PublishingInput added in v0.28.0

type PublishingInput interface {
	pulumi.Input

	ToPublishingOutput() PublishingOutput
	ToPublishingOutputWithContext(context.Context) PublishingOutput
}

PublishingInput is an input type that accepts PublishingArgs and PublishingOutput values. You can construct a concrete instance of `PublishingInput` via:

PublishingArgs{...}

type PublishingOrganization added in v0.28.0

type PublishingOrganization string

For whom the client library is being published.

func (PublishingOrganization) ElementType added in v0.28.0

func (PublishingOrganization) ElementType() reflect.Type

func (PublishingOrganization) ToPublishingOrganizationOutput added in v0.28.0

func (e PublishingOrganization) ToPublishingOrganizationOutput() PublishingOrganizationOutput

func (PublishingOrganization) ToPublishingOrganizationOutputWithContext added in v0.28.0

func (e PublishingOrganization) ToPublishingOrganizationOutputWithContext(ctx context.Context) PublishingOrganizationOutput

func (PublishingOrganization) ToPublishingOrganizationPtrOutput added in v0.28.0

func (e PublishingOrganization) ToPublishingOrganizationPtrOutput() PublishingOrganizationPtrOutput

func (PublishingOrganization) ToPublishingOrganizationPtrOutputWithContext added in v0.28.0

func (e PublishingOrganization) ToPublishingOrganizationPtrOutputWithContext(ctx context.Context) PublishingOrganizationPtrOutput

func (PublishingOrganization) ToStringOutput added in v0.28.0

func (e PublishingOrganization) ToStringOutput() pulumi.StringOutput

func (PublishingOrganization) ToStringOutputWithContext added in v0.28.0

func (e PublishingOrganization) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (PublishingOrganization) ToStringPtrOutput added in v0.28.0

func (e PublishingOrganization) ToStringPtrOutput() pulumi.StringPtrOutput

func (PublishingOrganization) ToStringPtrOutputWithContext added in v0.28.0

func (e PublishingOrganization) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type PublishingOrganizationInput added in v0.28.0

type PublishingOrganizationInput interface {
	pulumi.Input

	ToPublishingOrganizationOutput() PublishingOrganizationOutput
	ToPublishingOrganizationOutputWithContext(context.Context) PublishingOrganizationOutput
}

PublishingOrganizationInput is an input type that accepts PublishingOrganizationArgs and PublishingOrganizationOutput values. You can construct a concrete instance of `PublishingOrganizationInput` via:

PublishingOrganizationArgs{...}

type PublishingOrganizationOutput added in v0.28.0

type PublishingOrganizationOutput struct{ *pulumi.OutputState }

func (PublishingOrganizationOutput) ElementType added in v0.28.0

func (PublishingOrganizationOutput) ToPublishingOrganizationOutput added in v0.28.0

func (o PublishingOrganizationOutput) ToPublishingOrganizationOutput() PublishingOrganizationOutput

func (PublishingOrganizationOutput) ToPublishingOrganizationOutputWithContext added in v0.28.0

func (o PublishingOrganizationOutput) ToPublishingOrganizationOutputWithContext(ctx context.Context) PublishingOrganizationOutput

func (PublishingOrganizationOutput) ToPublishingOrganizationPtrOutput added in v0.28.0

func (o PublishingOrganizationOutput) ToPublishingOrganizationPtrOutput() PublishingOrganizationPtrOutput

func (PublishingOrganizationOutput) ToPublishingOrganizationPtrOutputWithContext added in v0.28.0

func (o PublishingOrganizationOutput) ToPublishingOrganizationPtrOutputWithContext(ctx context.Context) PublishingOrganizationPtrOutput

func (PublishingOrganizationOutput) ToStringOutput added in v0.28.0

func (PublishingOrganizationOutput) ToStringOutputWithContext added in v0.28.0

func (o PublishingOrganizationOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (PublishingOrganizationOutput) ToStringPtrOutput added in v0.28.0

func (o PublishingOrganizationOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (PublishingOrganizationOutput) ToStringPtrOutputWithContext added in v0.28.0

func (o PublishingOrganizationOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type PublishingOrganizationPtrInput added in v0.28.0

type PublishingOrganizationPtrInput interface {
	pulumi.Input

	ToPublishingOrganizationPtrOutput() PublishingOrganizationPtrOutput
	ToPublishingOrganizationPtrOutputWithContext(context.Context) PublishingOrganizationPtrOutput
}

func PublishingOrganizationPtr added in v0.28.0

func PublishingOrganizationPtr(v string) PublishingOrganizationPtrInput

type PublishingOrganizationPtrOutput added in v0.28.0

type PublishingOrganizationPtrOutput struct{ *pulumi.OutputState }

func (PublishingOrganizationPtrOutput) Elem added in v0.28.0

func (PublishingOrganizationPtrOutput) ElementType added in v0.28.0

func (PublishingOrganizationPtrOutput) ToPublishingOrganizationPtrOutput added in v0.28.0

func (o PublishingOrganizationPtrOutput) ToPublishingOrganizationPtrOutput() PublishingOrganizationPtrOutput

func (PublishingOrganizationPtrOutput) ToPublishingOrganizationPtrOutputWithContext added in v0.28.0

func (o PublishingOrganizationPtrOutput) ToPublishingOrganizationPtrOutputWithContext(ctx context.Context) PublishingOrganizationPtrOutput

func (PublishingOrganizationPtrOutput) ToStringPtrOutput added in v0.28.0

func (PublishingOrganizationPtrOutput) ToStringPtrOutputWithContext added in v0.28.0

func (o PublishingOrganizationPtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type PublishingOutput added in v0.28.0

type PublishingOutput struct{ *pulumi.OutputState }

This message configures the settings for publishing [Google Cloud Client libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) generated from the service config.

func (PublishingOutput) ApiShortName added in v0.28.0

func (o PublishingOutput) ApiShortName() pulumi.StringPtrOutput

Used as a tracking tag when collecting data about the APIs developer relations artifacts like docs, packages delivered to package managers, etc. Example: "speech".

func (PublishingOutput) CodeownerGithubTeams added in v0.28.0

func (o PublishingOutput) CodeownerGithubTeams() pulumi.StringArrayOutput

GitHub teams to be added to CODEOWNERS in the directory in GitHub containing source code for the client libraries for this API.

func (PublishingOutput) DocTagPrefix added in v0.28.0

func (o PublishingOutput) DocTagPrefix() pulumi.StringPtrOutput

A prefix used in sample code when demarking regions to be included in documentation.

func (PublishingOutput) DocumentationUri added in v0.28.0

func (o PublishingOutput) DocumentationUri() pulumi.StringPtrOutput

Link to product home page. Example: https://cloud.google.com/asset-inventory/docs/overview

func (PublishingOutput) ElementType added in v0.28.0

func (PublishingOutput) ElementType() reflect.Type

func (PublishingOutput) GithubLabel added in v0.28.0

func (o PublishingOutput) GithubLabel() pulumi.StringPtrOutput

GitHub label to apply to issues and pull requests opened for this API.

func (PublishingOutput) LibrarySettings added in v0.28.0

Client library settings. If the same version string appears multiple times in this list, then the last one wins. Settings from earlier settings with the same version string are discarded.

func (PublishingOutput) MethodSettings added in v0.28.0

func (o PublishingOutput) MethodSettings() MethodSettingsArrayOutput

A list of API method settings, e.g. the behavior for methods that use the long-running operation pattern.

func (PublishingOutput) NewIssueUri added in v0.28.0

func (o PublishingOutput) NewIssueUri() pulumi.StringPtrOutput

Link to a *public* URI where users can report issues. Example: https://issuetracker.google.com/issues/new?component=190865&template=1161103

func (PublishingOutput) Organization added in v0.28.0

For whom the client library is being published.

func (PublishingOutput) ProtoReferenceDocumentationUri added in v0.29.0

func (o PublishingOutput) ProtoReferenceDocumentationUri() pulumi.StringPtrOutput

Optional link to proto reference documentation. Example: https://cloud.google.com/pubsub/lite/docs/reference/rpc

func (PublishingOutput) ToPublishingOutput added in v0.28.0

func (o PublishingOutput) ToPublishingOutput() PublishingOutput

func (PublishingOutput) ToPublishingOutputWithContext added in v0.28.0

func (o PublishingOutput) ToPublishingOutputWithContext(ctx context.Context) PublishingOutput

func (PublishingOutput) ToPublishingPtrOutput added in v0.28.0

func (o PublishingOutput) ToPublishingPtrOutput() PublishingPtrOutput

func (PublishingOutput) ToPublishingPtrOutputWithContext added in v0.28.0

func (o PublishingOutput) ToPublishingPtrOutputWithContext(ctx context.Context) PublishingPtrOutput

type PublishingPtrInput added in v0.28.0

type PublishingPtrInput interface {
	pulumi.Input

	ToPublishingPtrOutput() PublishingPtrOutput
	ToPublishingPtrOutputWithContext(context.Context) PublishingPtrOutput
}

PublishingPtrInput is an input type that accepts PublishingArgs, PublishingPtr and PublishingPtrOutput values. You can construct a concrete instance of `PublishingPtrInput` via:

        PublishingArgs{...}

or:

        nil

func PublishingPtr added in v0.28.0

func PublishingPtr(v *PublishingArgs) PublishingPtrInput

type PublishingPtrOutput added in v0.28.0

type PublishingPtrOutput struct{ *pulumi.OutputState }

func (PublishingPtrOutput) ApiShortName added in v0.28.0

func (o PublishingPtrOutput) ApiShortName() pulumi.StringPtrOutput

Used as a tracking tag when collecting data about the APIs developer relations artifacts like docs, packages delivered to package managers, etc. Example: "speech".

func (PublishingPtrOutput) CodeownerGithubTeams added in v0.28.0

func (o PublishingPtrOutput) CodeownerGithubTeams() pulumi.StringArrayOutput

GitHub teams to be added to CODEOWNERS in the directory in GitHub containing source code for the client libraries for this API.

func (PublishingPtrOutput) DocTagPrefix added in v0.28.0

func (o PublishingPtrOutput) DocTagPrefix() pulumi.StringPtrOutput

A prefix used in sample code when demarking regions to be included in documentation.

func (PublishingPtrOutput) DocumentationUri added in v0.28.0

func (o PublishingPtrOutput) DocumentationUri() pulumi.StringPtrOutput

Link to product home page. Example: https://cloud.google.com/asset-inventory/docs/overview

func (PublishingPtrOutput) Elem added in v0.28.0

func (PublishingPtrOutput) ElementType added in v0.28.0

func (PublishingPtrOutput) ElementType() reflect.Type

func (PublishingPtrOutput) GithubLabel added in v0.28.0

func (o PublishingPtrOutput) GithubLabel() pulumi.StringPtrOutput

GitHub label to apply to issues and pull requests opened for this API.

func (PublishingPtrOutput) LibrarySettings added in v0.28.0

Client library settings. If the same version string appears multiple times in this list, then the last one wins. Settings from earlier settings with the same version string are discarded.

func (PublishingPtrOutput) MethodSettings added in v0.28.0

A list of API method settings, e.g. the behavior for methods that use the long-running operation pattern.

func (PublishingPtrOutput) NewIssueUri added in v0.28.0

func (o PublishingPtrOutput) NewIssueUri() pulumi.StringPtrOutput

Link to a *public* URI where users can report issues. Example: https://issuetracker.google.com/issues/new?component=190865&template=1161103

func (PublishingPtrOutput) Organization added in v0.28.0

For whom the client library is being published.

func (PublishingPtrOutput) ProtoReferenceDocumentationUri added in v0.29.0

func (o PublishingPtrOutput) ProtoReferenceDocumentationUri() pulumi.StringPtrOutput

Optional link to proto reference documentation. Example: https://cloud.google.com/pubsub/lite/docs/reference/rpc

func (PublishingPtrOutput) ToPublishingPtrOutput added in v0.28.0

func (o PublishingPtrOutput) ToPublishingPtrOutput() PublishingPtrOutput

func (PublishingPtrOutput) ToPublishingPtrOutputWithContext added in v0.28.0

func (o PublishingPtrOutput) ToPublishingPtrOutputWithContext(ctx context.Context) PublishingPtrOutput

type PublishingResponse added in v0.28.0

type PublishingResponse struct {
	// Used as a tracking tag when collecting data about the APIs developer relations artifacts like docs, packages delivered to package managers, etc. Example: "speech".
	ApiShortName string `pulumi:"apiShortName"`
	// GitHub teams to be added to CODEOWNERS in the directory in GitHub containing source code for the client libraries for this API.
	CodeownerGithubTeams []string `pulumi:"codeownerGithubTeams"`
	// A prefix used in sample code when demarking regions to be included in documentation.
	DocTagPrefix string `pulumi:"docTagPrefix"`
	// Link to product home page. Example: https://cloud.google.com/asset-inventory/docs/overview
	DocumentationUri string `pulumi:"documentationUri"`
	// GitHub label to apply to issues and pull requests opened for this API.
	GithubLabel string `pulumi:"githubLabel"`
	// Client library settings. If the same version string appears multiple times in this list, then the last one wins. Settings from earlier settings with the same version string are discarded.
	LibrarySettings []ClientLibrarySettingsResponse `pulumi:"librarySettings"`
	// A list of API method settings, e.g. the behavior for methods that use the long-running operation pattern.
	MethodSettings []MethodSettingsResponse `pulumi:"methodSettings"`
	// Link to a *public* URI where users can report issues. Example: https://issuetracker.google.com/issues/new?component=190865&template=1161103
	NewIssueUri string `pulumi:"newIssueUri"`
	// For whom the client library is being published.
	Organization string `pulumi:"organization"`
	// Optional link to proto reference documentation. Example: https://cloud.google.com/pubsub/lite/docs/reference/rpc
	ProtoReferenceDocumentationUri string `pulumi:"protoReferenceDocumentationUri"`
}

This message configures the settings for publishing [Google Cloud Client libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) generated from the service config.

type PublishingResponseOutput added in v0.28.0

type PublishingResponseOutput struct{ *pulumi.OutputState }

This message configures the settings for publishing [Google Cloud Client libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) generated from the service config.

func (PublishingResponseOutput) ApiShortName added in v0.28.0

func (o PublishingResponseOutput) ApiShortName() pulumi.StringOutput

Used as a tracking tag when collecting data about the APIs developer relations artifacts like docs, packages delivered to package managers, etc. Example: "speech".

func (PublishingResponseOutput) CodeownerGithubTeams added in v0.28.0

func (o PublishingResponseOutput) CodeownerGithubTeams() pulumi.StringArrayOutput

GitHub teams to be added to CODEOWNERS in the directory in GitHub containing source code for the client libraries for this API.

func (PublishingResponseOutput) DocTagPrefix added in v0.28.0

func (o PublishingResponseOutput) DocTagPrefix() pulumi.StringOutput

A prefix used in sample code when demarking regions to be included in documentation.

func (PublishingResponseOutput) DocumentationUri added in v0.28.0

func (o PublishingResponseOutput) DocumentationUri() pulumi.StringOutput

Link to product home page. Example: https://cloud.google.com/asset-inventory/docs/overview

func (PublishingResponseOutput) ElementType added in v0.28.0

func (PublishingResponseOutput) ElementType() reflect.Type

func (PublishingResponseOutput) GithubLabel added in v0.28.0

GitHub label to apply to issues and pull requests opened for this API.

func (PublishingResponseOutput) LibrarySettings added in v0.28.0

Client library settings. If the same version string appears multiple times in this list, then the last one wins. Settings from earlier settings with the same version string are discarded.

func (PublishingResponseOutput) MethodSettings added in v0.28.0

A list of API method settings, e.g. the behavior for methods that use the long-running operation pattern.

func (PublishingResponseOutput) NewIssueUri added in v0.28.0

Link to a *public* URI where users can report issues. Example: https://issuetracker.google.com/issues/new?component=190865&template=1161103

func (PublishingResponseOutput) Organization added in v0.28.0

func (o PublishingResponseOutput) Organization() pulumi.StringOutput

For whom the client library is being published.

func (PublishingResponseOutput) ProtoReferenceDocumentationUri added in v0.29.0

func (o PublishingResponseOutput) ProtoReferenceDocumentationUri() pulumi.StringOutput

Optional link to proto reference documentation. Example: https://cloud.google.com/pubsub/lite/docs/reference/rpc

func (PublishingResponseOutput) ToPublishingResponseOutput added in v0.28.0

func (o PublishingResponseOutput) ToPublishingResponseOutput() PublishingResponseOutput

func (PublishingResponseOutput) ToPublishingResponseOutputWithContext added in v0.28.0

func (o PublishingResponseOutput) ToPublishingResponseOutputWithContext(ctx context.Context) PublishingResponseOutput

type PythonSettings added in v0.28.0

type PythonSettings struct {
	// Some settings.
	Common *CommonLanguageSettings `pulumi:"common"`
}

Settings for Python client libraries.

type PythonSettingsArgs added in v0.28.0

type PythonSettingsArgs struct {
	// Some settings.
	Common CommonLanguageSettingsPtrInput `pulumi:"common"`
}

Settings for Python client libraries.

func (PythonSettingsArgs) ElementType added in v0.28.0

func (PythonSettingsArgs) ElementType() reflect.Type

func (PythonSettingsArgs) ToPythonSettingsOutput added in v0.28.0

func (i PythonSettingsArgs) ToPythonSettingsOutput() PythonSettingsOutput

func (PythonSettingsArgs) ToPythonSettingsOutputWithContext added in v0.28.0

func (i PythonSettingsArgs) ToPythonSettingsOutputWithContext(ctx context.Context) PythonSettingsOutput

func (PythonSettingsArgs) ToPythonSettingsPtrOutput added in v0.28.0

func (i PythonSettingsArgs) ToPythonSettingsPtrOutput() PythonSettingsPtrOutput

func (PythonSettingsArgs) ToPythonSettingsPtrOutputWithContext added in v0.28.0

func (i PythonSettingsArgs) ToPythonSettingsPtrOutputWithContext(ctx context.Context) PythonSettingsPtrOutput

type PythonSettingsInput added in v0.28.0

type PythonSettingsInput interface {
	pulumi.Input

	ToPythonSettingsOutput() PythonSettingsOutput
	ToPythonSettingsOutputWithContext(context.Context) PythonSettingsOutput
}

PythonSettingsInput is an input type that accepts PythonSettingsArgs and PythonSettingsOutput values. You can construct a concrete instance of `PythonSettingsInput` via:

PythonSettingsArgs{...}

type PythonSettingsOutput added in v0.28.0

type PythonSettingsOutput struct{ *pulumi.OutputState }

Settings for Python client libraries.

func (PythonSettingsOutput) Common added in v0.28.0

Some settings.

func (PythonSettingsOutput) ElementType added in v0.28.0

func (PythonSettingsOutput) ElementType() reflect.Type

func (PythonSettingsOutput) ToPythonSettingsOutput added in v0.28.0

func (o PythonSettingsOutput) ToPythonSettingsOutput() PythonSettingsOutput

func (PythonSettingsOutput) ToPythonSettingsOutputWithContext added in v0.28.0

func (o PythonSettingsOutput) ToPythonSettingsOutputWithContext(ctx context.Context) PythonSettingsOutput

func (PythonSettingsOutput) ToPythonSettingsPtrOutput added in v0.28.0

func (o PythonSettingsOutput) ToPythonSettingsPtrOutput() PythonSettingsPtrOutput

func (PythonSettingsOutput) ToPythonSettingsPtrOutputWithContext added in v0.28.0

func (o PythonSettingsOutput) ToPythonSettingsPtrOutputWithContext(ctx context.Context) PythonSettingsPtrOutput

type PythonSettingsPtrInput added in v0.28.0

type PythonSettingsPtrInput interface {
	pulumi.Input

	ToPythonSettingsPtrOutput() PythonSettingsPtrOutput
	ToPythonSettingsPtrOutputWithContext(context.Context) PythonSettingsPtrOutput
}

PythonSettingsPtrInput is an input type that accepts PythonSettingsArgs, PythonSettingsPtr and PythonSettingsPtrOutput values. You can construct a concrete instance of `PythonSettingsPtrInput` via:

        PythonSettingsArgs{...}

or:

        nil

func PythonSettingsPtr added in v0.28.0

func PythonSettingsPtr(v *PythonSettingsArgs) PythonSettingsPtrInput

type PythonSettingsPtrOutput added in v0.28.0

type PythonSettingsPtrOutput struct{ *pulumi.OutputState }

func (PythonSettingsPtrOutput) Common added in v0.28.0

Some settings.

func (PythonSettingsPtrOutput) Elem added in v0.28.0

func (PythonSettingsPtrOutput) ElementType added in v0.28.0

func (PythonSettingsPtrOutput) ElementType() reflect.Type

func (PythonSettingsPtrOutput) ToPythonSettingsPtrOutput added in v0.28.0

func (o PythonSettingsPtrOutput) ToPythonSettingsPtrOutput() PythonSettingsPtrOutput

func (PythonSettingsPtrOutput) ToPythonSettingsPtrOutputWithContext added in v0.28.0

func (o PythonSettingsPtrOutput) ToPythonSettingsPtrOutputWithContext(ctx context.Context) PythonSettingsPtrOutput

type PythonSettingsResponse added in v0.28.0

type PythonSettingsResponse struct {
	// Some settings.
	Common CommonLanguageSettingsResponse `pulumi:"common"`
}

Settings for Python client libraries.

type PythonSettingsResponseOutput added in v0.28.0

type PythonSettingsResponseOutput struct{ *pulumi.OutputState }

Settings for Python client libraries.

func (PythonSettingsResponseOutput) Common added in v0.28.0

Some settings.

func (PythonSettingsResponseOutput) ElementType added in v0.28.0

func (PythonSettingsResponseOutput) ToPythonSettingsResponseOutput added in v0.28.0

func (o PythonSettingsResponseOutput) ToPythonSettingsResponseOutput() PythonSettingsResponseOutput

func (PythonSettingsResponseOutput) ToPythonSettingsResponseOutputWithContext added in v0.28.0

func (o PythonSettingsResponseOutput) ToPythonSettingsResponseOutputWithContext(ctx context.Context) PythonSettingsResponseOutput

type Quota

type Quota struct {
	// List of QuotaLimit definitions for the service.
	Limits []QuotaLimit `pulumi:"limits"`
	// List of MetricRule definitions, each one mapping a selected method to one or more metrics.
	MetricRules []MetricRule `pulumi:"metricRules"`
}

Quota configuration helps to achieve fairness and budgeting in service usage. The metric based quota configuration works this way: - The service configuration defines a set of metrics. - For API calls, the quota.metric_rules maps methods to metrics with corresponding costs. - The quota.limits defines limits on the metrics, which will be used for quota checks at runtime. An example quota configuration in yaml format: quota: limits: - name: apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit for consumer projects values: STANDARD: 10000 (The metric rules bind all methods to the read_calls metric, except for the UpdateBook and DeleteBook methods. These two methods are mapped to the write_calls metric, with the UpdateBook method consuming at twice rate as the DeleteBook method.) metric_rules: - selector: "*" metric_costs: library.googleapis.com/read_calls: 1 - selector: google.example.library.v1.LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: - name: library.googleapis.com/read_calls display_name: Read requests metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/write_calls display_name: Write requests metric_kind: DELTA value_type: INT64

type QuotaArgs

type QuotaArgs struct {
	// List of QuotaLimit definitions for the service.
	Limits QuotaLimitArrayInput `pulumi:"limits"`
	// List of MetricRule definitions, each one mapping a selected method to one or more metrics.
	MetricRules MetricRuleArrayInput `pulumi:"metricRules"`
}

Quota configuration helps to achieve fairness and budgeting in service usage. The metric based quota configuration works this way: - The service configuration defines a set of metrics. - For API calls, the quota.metric_rules maps methods to metrics with corresponding costs. - The quota.limits defines limits on the metrics, which will be used for quota checks at runtime. An example quota configuration in yaml format: quota: limits: - name: apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit for consumer projects values: STANDARD: 10000 (The metric rules bind all methods to the read_calls metric, except for the UpdateBook and DeleteBook methods. These two methods are mapped to the write_calls metric, with the UpdateBook method consuming at twice rate as the DeleteBook method.) metric_rules: - selector: "*" metric_costs: library.googleapis.com/read_calls: 1 - selector: google.example.library.v1.LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: - name: library.googleapis.com/read_calls display_name: Read requests metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/write_calls display_name: Write requests metric_kind: DELTA value_type: INT64

func (QuotaArgs) ElementType

func (QuotaArgs) ElementType() reflect.Type

func (QuotaArgs) ToQuotaOutput

func (i QuotaArgs) ToQuotaOutput() QuotaOutput

func (QuotaArgs) ToQuotaOutputWithContext

func (i QuotaArgs) ToQuotaOutputWithContext(ctx context.Context) QuotaOutput

func (QuotaArgs) ToQuotaPtrOutput

func (i QuotaArgs) ToQuotaPtrOutput() QuotaPtrOutput

func (QuotaArgs) ToQuotaPtrOutputWithContext

func (i QuotaArgs) ToQuotaPtrOutputWithContext(ctx context.Context) QuotaPtrOutput

type QuotaInput

type QuotaInput interface {
	pulumi.Input

	ToQuotaOutput() QuotaOutput
	ToQuotaOutputWithContext(context.Context) QuotaOutput
}

QuotaInput is an input type that accepts QuotaArgs and QuotaOutput values. You can construct a concrete instance of `QuotaInput` via:

QuotaArgs{...}

type QuotaLimit

type QuotaLimit struct {
	// Default number of tokens that can be consumed during the specified duration. This is the number of tokens assigned when a client application developer activates the service for his/her project. Specifying a value of 0 will block all requests. This can be used if you are provisioning quota to selected consumers and blocking others. Similarly, a value of -1 will indicate an unlimited quota. No other negative values are allowed. Used by group-based quotas only.
	DefaultLimit *string `pulumi:"defaultLimit"`
	// Optional. User-visible, extended description for this quota limit. Should be used only when more context is needed to understand this limit than provided by the limit's display name (see: `display_name`).
	Description *string `pulumi:"description"`
	// User-visible display name for this limit. Optional. If not set, the UI will provide a default display name based on the quota configuration. This field can be used to override the default display name generated from the configuration.
	DisplayName *string `pulumi:"displayName"`
	// Duration of this limit in textual notation. Must be "100s" or "1d". Used by group-based quotas only.
	Duration *string `pulumi:"duration"`
	// Free tier value displayed in the Developers Console for this limit. The free tier is the number of tokens that will be subtracted from the billed amount when billing is enabled. This field can only be set on a limit with duration "1d", in a billable group; it is invalid on any other limit. If this field is not set, it defaults to 0, indicating that there is no free tier for this service. Used by group-based quotas only.
	FreeTier *string `pulumi:"freeTier"`
	// Maximum number of tokens that can be consumed during the specified duration. Client application developers can override the default limit up to this maximum. If specified, this value cannot be set to a value less than the default limit. If not specified, it is set to the default limit. To allow clients to apply overrides with no upper bound, set this to -1, indicating unlimited maximum quota. Used by group-based quotas only.
	MaxLimit *string `pulumi:"maxLimit"`
	// The name of the metric this quota limit applies to. The quota limits with the same metric will be checked together during runtime. The metric must be defined within the service config.
	Metric *string `pulumi:"metric"`
	// Name of the quota limit. The name must be provided, and it must be unique within the service. The name can only include alphanumeric characters as well as '-'. The maximum length of the limit name is 64 characters.
	Name *string `pulumi:"name"`
	// Specify the unit of the quota limit. It uses the same syntax as Metric.unit. The supported unit kinds are determined by the quota backend system. Here are some examples: * "1/min/{project}" for quota per minute per project. Note: the order of unit components is insignificant. The "1" at the beginning is required to follow the metric unit syntax.
	Unit *string `pulumi:"unit"`
	// Tiered limit values. You must specify this as a key:value pair, with an integer value that is the maximum number of requests allowed for the specified unit. Currently only STANDARD is supported.
	Values map[string]string `pulumi:"values"`
}

`QuotaLimit` defines a specific limit that applies over a specified duration for a limit type. There can be at most one limit for a duration and limit type combination defined within a `QuotaGroup`.

type QuotaLimitArgs

type QuotaLimitArgs struct {
	// Default number of tokens that can be consumed during the specified duration. This is the number of tokens assigned when a client application developer activates the service for his/her project. Specifying a value of 0 will block all requests. This can be used if you are provisioning quota to selected consumers and blocking others. Similarly, a value of -1 will indicate an unlimited quota. No other negative values are allowed. Used by group-based quotas only.
	DefaultLimit pulumi.StringPtrInput `pulumi:"defaultLimit"`
	// Optional. User-visible, extended description for this quota limit. Should be used only when more context is needed to understand this limit than provided by the limit's display name (see: `display_name`).
	Description pulumi.StringPtrInput `pulumi:"description"`
	// User-visible display name for this limit. Optional. If not set, the UI will provide a default display name based on the quota configuration. This field can be used to override the default display name generated from the configuration.
	DisplayName pulumi.StringPtrInput `pulumi:"displayName"`
	// Duration of this limit in textual notation. Must be "100s" or "1d". Used by group-based quotas only.
	Duration pulumi.StringPtrInput `pulumi:"duration"`
	// Free tier value displayed in the Developers Console for this limit. The free tier is the number of tokens that will be subtracted from the billed amount when billing is enabled. This field can only be set on a limit with duration "1d", in a billable group; it is invalid on any other limit. If this field is not set, it defaults to 0, indicating that there is no free tier for this service. Used by group-based quotas only.
	FreeTier pulumi.StringPtrInput `pulumi:"freeTier"`
	// Maximum number of tokens that can be consumed during the specified duration. Client application developers can override the default limit up to this maximum. If specified, this value cannot be set to a value less than the default limit. If not specified, it is set to the default limit. To allow clients to apply overrides with no upper bound, set this to -1, indicating unlimited maximum quota. Used by group-based quotas only.
	MaxLimit pulumi.StringPtrInput `pulumi:"maxLimit"`
	// The name of the metric this quota limit applies to. The quota limits with the same metric will be checked together during runtime. The metric must be defined within the service config.
	Metric pulumi.StringPtrInput `pulumi:"metric"`
	// Name of the quota limit. The name must be provided, and it must be unique within the service. The name can only include alphanumeric characters as well as '-'. The maximum length of the limit name is 64 characters.
	Name pulumi.StringPtrInput `pulumi:"name"`
	// Specify the unit of the quota limit. It uses the same syntax as Metric.unit. The supported unit kinds are determined by the quota backend system. Here are some examples: * "1/min/{project}" for quota per minute per project. Note: the order of unit components is insignificant. The "1" at the beginning is required to follow the metric unit syntax.
	Unit pulumi.StringPtrInput `pulumi:"unit"`
	// Tiered limit values. You must specify this as a key:value pair, with an integer value that is the maximum number of requests allowed for the specified unit. Currently only STANDARD is supported.
	Values pulumi.StringMapInput `pulumi:"values"`
}

`QuotaLimit` defines a specific limit that applies over a specified duration for a limit type. There can be at most one limit for a duration and limit type combination defined within a `QuotaGroup`.

func (QuotaLimitArgs) ElementType

func (QuotaLimitArgs) ElementType() reflect.Type

func (QuotaLimitArgs) ToQuotaLimitOutput

func (i QuotaLimitArgs) ToQuotaLimitOutput() QuotaLimitOutput

func (QuotaLimitArgs) ToQuotaLimitOutputWithContext

func (i QuotaLimitArgs) ToQuotaLimitOutputWithContext(ctx context.Context) QuotaLimitOutput

type QuotaLimitArray

type QuotaLimitArray []QuotaLimitInput

func (QuotaLimitArray) ElementType

func (QuotaLimitArray) ElementType() reflect.Type

func (QuotaLimitArray) ToQuotaLimitArrayOutput

func (i QuotaLimitArray) ToQuotaLimitArrayOutput() QuotaLimitArrayOutput

func (QuotaLimitArray) ToQuotaLimitArrayOutputWithContext

func (i QuotaLimitArray) ToQuotaLimitArrayOutputWithContext(ctx context.Context) QuotaLimitArrayOutput

type QuotaLimitArrayInput

type QuotaLimitArrayInput interface {
	pulumi.Input

	ToQuotaLimitArrayOutput() QuotaLimitArrayOutput
	ToQuotaLimitArrayOutputWithContext(context.Context) QuotaLimitArrayOutput
}

QuotaLimitArrayInput is an input type that accepts QuotaLimitArray and QuotaLimitArrayOutput values. You can construct a concrete instance of `QuotaLimitArrayInput` via:

QuotaLimitArray{ QuotaLimitArgs{...} }

type QuotaLimitArrayOutput

type QuotaLimitArrayOutput struct{ *pulumi.OutputState }

func (QuotaLimitArrayOutput) ElementType

func (QuotaLimitArrayOutput) ElementType() reflect.Type

func (QuotaLimitArrayOutput) Index

func (QuotaLimitArrayOutput) ToQuotaLimitArrayOutput

func (o QuotaLimitArrayOutput) ToQuotaLimitArrayOutput() QuotaLimitArrayOutput

func (QuotaLimitArrayOutput) ToQuotaLimitArrayOutputWithContext

func (o QuotaLimitArrayOutput) ToQuotaLimitArrayOutputWithContext(ctx context.Context) QuotaLimitArrayOutput

type QuotaLimitInput

type QuotaLimitInput interface {
	pulumi.Input

	ToQuotaLimitOutput() QuotaLimitOutput
	ToQuotaLimitOutputWithContext(context.Context) QuotaLimitOutput
}

QuotaLimitInput is an input type that accepts QuotaLimitArgs and QuotaLimitOutput values. You can construct a concrete instance of `QuotaLimitInput` via:

QuotaLimitArgs{...}

type QuotaLimitOutput

type QuotaLimitOutput struct{ *pulumi.OutputState }

`QuotaLimit` defines a specific limit that applies over a specified duration for a limit type. There can be at most one limit for a duration and limit type combination defined within a `QuotaGroup`.

func (QuotaLimitOutput) DefaultLimit

func (o QuotaLimitOutput) DefaultLimit() pulumi.StringPtrOutput

Default number of tokens that can be consumed during the specified duration. This is the number of tokens assigned when a client application developer activates the service for his/her project. Specifying a value of 0 will block all requests. This can be used if you are provisioning quota to selected consumers and blocking others. Similarly, a value of -1 will indicate an unlimited quota. No other negative values are allowed. Used by group-based quotas only.

func (QuotaLimitOutput) Description

func (o QuotaLimitOutput) Description() pulumi.StringPtrOutput

Optional. User-visible, extended description for this quota limit. Should be used only when more context is needed to understand this limit than provided by the limit's display name (see: `display_name`).

func (QuotaLimitOutput) DisplayName

func (o QuotaLimitOutput) DisplayName() pulumi.StringPtrOutput

User-visible display name for this limit. Optional. If not set, the UI will provide a default display name based on the quota configuration. This field can be used to override the default display name generated from the configuration.

func (QuotaLimitOutput) Duration

Duration of this limit in textual notation. Must be "100s" or "1d". Used by group-based quotas only.

func (QuotaLimitOutput) ElementType

func (QuotaLimitOutput) ElementType() reflect.Type

func (QuotaLimitOutput) FreeTier

Free tier value displayed in the Developers Console for this limit. The free tier is the number of tokens that will be subtracted from the billed amount when billing is enabled. This field can only be set on a limit with duration "1d", in a billable group; it is invalid on any other limit. If this field is not set, it defaults to 0, indicating that there is no free tier for this service. Used by group-based quotas only.

func (QuotaLimitOutput) MaxLimit

Maximum number of tokens that can be consumed during the specified duration. Client application developers can override the default limit up to this maximum. If specified, this value cannot be set to a value less than the default limit. If not specified, it is set to the default limit. To allow clients to apply overrides with no upper bound, set this to -1, indicating unlimited maximum quota. Used by group-based quotas only.

func (QuotaLimitOutput) Metric

The name of the metric this quota limit applies to. The quota limits with the same metric will be checked together during runtime. The metric must be defined within the service config.

func (QuotaLimitOutput) Name

Name of the quota limit. The name must be provided, and it must be unique within the service. The name can only include alphanumeric characters as well as '-'. The maximum length of the limit name is 64 characters.

func (QuotaLimitOutput) ToQuotaLimitOutput

func (o QuotaLimitOutput) ToQuotaLimitOutput() QuotaLimitOutput

func (QuotaLimitOutput) ToQuotaLimitOutputWithContext

func (o QuotaLimitOutput) ToQuotaLimitOutputWithContext(ctx context.Context) QuotaLimitOutput

func (QuotaLimitOutput) Unit

Specify the unit of the quota limit. It uses the same syntax as Metric.unit. The supported unit kinds are determined by the quota backend system. Here are some examples: * "1/min/{project}" for quota per minute per project. Note: the order of unit components is insignificant. The "1" at the beginning is required to follow the metric unit syntax.

func (QuotaLimitOutput) Values

Tiered limit values. You must specify this as a key:value pair, with an integer value that is the maximum number of requests allowed for the specified unit. Currently only STANDARD is supported.

type QuotaLimitResponse

type QuotaLimitResponse struct {
	// Default number of tokens that can be consumed during the specified duration. This is the number of tokens assigned when a client application developer activates the service for his/her project. Specifying a value of 0 will block all requests. This can be used if you are provisioning quota to selected consumers and blocking others. Similarly, a value of -1 will indicate an unlimited quota. No other negative values are allowed. Used by group-based quotas only.
	DefaultLimit string `pulumi:"defaultLimit"`
	// Optional. User-visible, extended description for this quota limit. Should be used only when more context is needed to understand this limit than provided by the limit's display name (see: `display_name`).
	Description string `pulumi:"description"`
	// User-visible display name for this limit. Optional. If not set, the UI will provide a default display name based on the quota configuration. This field can be used to override the default display name generated from the configuration.
	DisplayName string `pulumi:"displayName"`
	// Duration of this limit in textual notation. Must be "100s" or "1d". Used by group-based quotas only.
	Duration string `pulumi:"duration"`
	// Free tier value displayed in the Developers Console for this limit. The free tier is the number of tokens that will be subtracted from the billed amount when billing is enabled. This field can only be set on a limit with duration "1d", in a billable group; it is invalid on any other limit. If this field is not set, it defaults to 0, indicating that there is no free tier for this service. Used by group-based quotas only.
	FreeTier string `pulumi:"freeTier"`
	// Maximum number of tokens that can be consumed during the specified duration. Client application developers can override the default limit up to this maximum. If specified, this value cannot be set to a value less than the default limit. If not specified, it is set to the default limit. To allow clients to apply overrides with no upper bound, set this to -1, indicating unlimited maximum quota. Used by group-based quotas only.
	MaxLimit string `pulumi:"maxLimit"`
	// The name of the metric this quota limit applies to. The quota limits with the same metric will be checked together during runtime. The metric must be defined within the service config.
	Metric string `pulumi:"metric"`
	// Name of the quota limit. The name must be provided, and it must be unique within the service. The name can only include alphanumeric characters as well as '-'. The maximum length of the limit name is 64 characters.
	Name string `pulumi:"name"`
	// Specify the unit of the quota limit. It uses the same syntax as Metric.unit. The supported unit kinds are determined by the quota backend system. Here are some examples: * "1/min/{project}" for quota per minute per project. Note: the order of unit components is insignificant. The "1" at the beginning is required to follow the metric unit syntax.
	Unit string `pulumi:"unit"`
	// Tiered limit values. You must specify this as a key:value pair, with an integer value that is the maximum number of requests allowed for the specified unit. Currently only STANDARD is supported.
	Values map[string]string `pulumi:"values"`
}

`QuotaLimit` defines a specific limit that applies over a specified duration for a limit type. There can be at most one limit for a duration and limit type combination defined within a `QuotaGroup`.

type QuotaLimitResponseArrayOutput

type QuotaLimitResponseArrayOutput struct{ *pulumi.OutputState }

func (QuotaLimitResponseArrayOutput) ElementType

func (QuotaLimitResponseArrayOutput) Index

func (QuotaLimitResponseArrayOutput) ToQuotaLimitResponseArrayOutput

func (o QuotaLimitResponseArrayOutput) ToQuotaLimitResponseArrayOutput() QuotaLimitResponseArrayOutput

func (QuotaLimitResponseArrayOutput) ToQuotaLimitResponseArrayOutputWithContext

func (o QuotaLimitResponseArrayOutput) ToQuotaLimitResponseArrayOutputWithContext(ctx context.Context) QuotaLimitResponseArrayOutput

type QuotaLimitResponseOutput

type QuotaLimitResponseOutput struct{ *pulumi.OutputState }

`QuotaLimit` defines a specific limit that applies over a specified duration for a limit type. There can be at most one limit for a duration and limit type combination defined within a `QuotaGroup`.

func (QuotaLimitResponseOutput) DefaultLimit

func (o QuotaLimitResponseOutput) DefaultLimit() pulumi.StringOutput

Default number of tokens that can be consumed during the specified duration. This is the number of tokens assigned when a client application developer activates the service for his/her project. Specifying a value of 0 will block all requests. This can be used if you are provisioning quota to selected consumers and blocking others. Similarly, a value of -1 will indicate an unlimited quota. No other negative values are allowed. Used by group-based quotas only.

func (QuotaLimitResponseOutput) Description

Optional. User-visible, extended description for this quota limit. Should be used only when more context is needed to understand this limit than provided by the limit's display name (see: `display_name`).

func (QuotaLimitResponseOutput) DisplayName

User-visible display name for this limit. Optional. If not set, the UI will provide a default display name based on the quota configuration. This field can be used to override the default display name generated from the configuration.

func (QuotaLimitResponseOutput) Duration

Duration of this limit in textual notation. Must be "100s" or "1d". Used by group-based quotas only.

func (QuotaLimitResponseOutput) ElementType

func (QuotaLimitResponseOutput) ElementType() reflect.Type

func (QuotaLimitResponseOutput) FreeTier

Free tier value displayed in the Developers Console for this limit. The free tier is the number of tokens that will be subtracted from the billed amount when billing is enabled. This field can only be set on a limit with duration "1d", in a billable group; it is invalid on any other limit. If this field is not set, it defaults to 0, indicating that there is no free tier for this service. Used by group-based quotas only.

func (QuotaLimitResponseOutput) MaxLimit

Maximum number of tokens that can be consumed during the specified duration. Client application developers can override the default limit up to this maximum. If specified, this value cannot be set to a value less than the default limit. If not specified, it is set to the default limit. To allow clients to apply overrides with no upper bound, set this to -1, indicating unlimited maximum quota. Used by group-based quotas only.

func (QuotaLimitResponseOutput) Metric

The name of the metric this quota limit applies to. The quota limits with the same metric will be checked together during runtime. The metric must be defined within the service config.

func (QuotaLimitResponseOutput) Name

Name of the quota limit. The name must be provided, and it must be unique within the service. The name can only include alphanumeric characters as well as '-'. The maximum length of the limit name is 64 characters.

func (QuotaLimitResponseOutput) ToQuotaLimitResponseOutput

func (o QuotaLimitResponseOutput) ToQuotaLimitResponseOutput() QuotaLimitResponseOutput

func (QuotaLimitResponseOutput) ToQuotaLimitResponseOutputWithContext

func (o QuotaLimitResponseOutput) ToQuotaLimitResponseOutputWithContext(ctx context.Context) QuotaLimitResponseOutput

func (QuotaLimitResponseOutput) Unit

Specify the unit of the quota limit. It uses the same syntax as Metric.unit. The supported unit kinds are determined by the quota backend system. Here are some examples: * "1/min/{project}" for quota per minute per project. Note: the order of unit components is insignificant. The "1" at the beginning is required to follow the metric unit syntax.

func (QuotaLimitResponseOutput) Values

Tiered limit values. You must specify this as a key:value pair, with an integer value that is the maximum number of requests allowed for the specified unit. Currently only STANDARD is supported.

type QuotaOutput

type QuotaOutput struct{ *pulumi.OutputState }

Quota configuration helps to achieve fairness and budgeting in service usage. The metric based quota configuration works this way: - The service configuration defines a set of metrics. - For API calls, the quota.metric_rules maps methods to metrics with corresponding costs. - The quota.limits defines limits on the metrics, which will be used for quota checks at runtime. An example quota configuration in yaml format: quota: limits: - name: apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit for consumer projects values: STANDARD: 10000 (The metric rules bind all methods to the read_calls metric, except for the UpdateBook and DeleteBook methods. These two methods are mapped to the write_calls metric, with the UpdateBook method consuming at twice rate as the DeleteBook method.) metric_rules: - selector: "*" metric_costs: library.googleapis.com/read_calls: 1 - selector: google.example.library.v1.LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: - name: library.googleapis.com/read_calls display_name: Read requests metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/write_calls display_name: Write requests metric_kind: DELTA value_type: INT64

func (QuotaOutput) ElementType

func (QuotaOutput) ElementType() reflect.Type

func (QuotaOutput) Limits

List of QuotaLimit definitions for the service.

func (QuotaOutput) MetricRules

func (o QuotaOutput) MetricRules() MetricRuleArrayOutput

List of MetricRule definitions, each one mapping a selected method to one or more metrics.

func (QuotaOutput) ToQuotaOutput

func (o QuotaOutput) ToQuotaOutput() QuotaOutput

func (QuotaOutput) ToQuotaOutputWithContext

func (o QuotaOutput) ToQuotaOutputWithContext(ctx context.Context) QuotaOutput

func (QuotaOutput) ToQuotaPtrOutput

func (o QuotaOutput) ToQuotaPtrOutput() QuotaPtrOutput

func (QuotaOutput) ToQuotaPtrOutputWithContext

func (o QuotaOutput) ToQuotaPtrOutputWithContext(ctx context.Context) QuotaPtrOutput

type QuotaPtrInput

type QuotaPtrInput interface {
	pulumi.Input

	ToQuotaPtrOutput() QuotaPtrOutput
	ToQuotaPtrOutputWithContext(context.Context) QuotaPtrOutput
}

QuotaPtrInput is an input type that accepts QuotaArgs, QuotaPtr and QuotaPtrOutput values. You can construct a concrete instance of `QuotaPtrInput` via:

        QuotaArgs{...}

or:

        nil

func QuotaPtr

func QuotaPtr(v *QuotaArgs) QuotaPtrInput

type QuotaPtrOutput

type QuotaPtrOutput struct{ *pulumi.OutputState }

func (QuotaPtrOutput) Elem

func (o QuotaPtrOutput) Elem() QuotaOutput

func (QuotaPtrOutput) ElementType

func (QuotaPtrOutput) ElementType() reflect.Type

func (QuotaPtrOutput) Limits

List of QuotaLimit definitions for the service.

func (QuotaPtrOutput) MetricRules

func (o QuotaPtrOutput) MetricRules() MetricRuleArrayOutput

List of MetricRule definitions, each one mapping a selected method to one or more metrics.

func (QuotaPtrOutput) ToQuotaPtrOutput

func (o QuotaPtrOutput) ToQuotaPtrOutput() QuotaPtrOutput

func (QuotaPtrOutput) ToQuotaPtrOutputWithContext

func (o QuotaPtrOutput) ToQuotaPtrOutputWithContext(ctx context.Context) QuotaPtrOutput

type QuotaResponse

type QuotaResponse struct {
	// List of QuotaLimit definitions for the service.
	Limits []QuotaLimitResponse `pulumi:"limits"`
	// List of MetricRule definitions, each one mapping a selected method to one or more metrics.
	MetricRules []MetricRuleResponse `pulumi:"metricRules"`
}

Quota configuration helps to achieve fairness and budgeting in service usage. The metric based quota configuration works this way: - The service configuration defines a set of metrics. - For API calls, the quota.metric_rules maps methods to metrics with corresponding costs. - The quota.limits defines limits on the metrics, which will be used for quota checks at runtime. An example quota configuration in yaml format: quota: limits: - name: apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit for consumer projects values: STANDARD: 10000 (The metric rules bind all methods to the read_calls metric, except for the UpdateBook and DeleteBook methods. These two methods are mapped to the write_calls metric, with the UpdateBook method consuming at twice rate as the DeleteBook method.) metric_rules: - selector: "*" metric_costs: library.googleapis.com/read_calls: 1 - selector: google.example.library.v1.LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: - name: library.googleapis.com/read_calls display_name: Read requests metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/write_calls display_name: Write requests metric_kind: DELTA value_type: INT64

type QuotaResponseOutput

type QuotaResponseOutput struct{ *pulumi.OutputState }

Quota configuration helps to achieve fairness and budgeting in service usage. The metric based quota configuration works this way: - The service configuration defines a set of metrics. - For API calls, the quota.metric_rules maps methods to metrics with corresponding costs. - The quota.limits defines limits on the metrics, which will be used for quota checks at runtime. An example quota configuration in yaml format: quota: limits: - name: apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit for consumer projects values: STANDARD: 10000 (The metric rules bind all methods to the read_calls metric, except for the UpdateBook and DeleteBook methods. These two methods are mapped to the write_calls metric, with the UpdateBook method consuming at twice rate as the DeleteBook method.) metric_rules: - selector: "*" metric_costs: library.googleapis.com/read_calls: 1 - selector: google.example.library.v1.LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: - name: library.googleapis.com/read_calls display_name: Read requests metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/write_calls display_name: Write requests metric_kind: DELTA value_type: INT64

func (QuotaResponseOutput) ElementType

func (QuotaResponseOutput) ElementType() reflect.Type

func (QuotaResponseOutput) Limits

List of QuotaLimit definitions for the service.

func (QuotaResponseOutput) MetricRules

List of MetricRule definitions, each one mapping a selected method to one or more metrics.

func (QuotaResponseOutput) ToQuotaResponseOutput

func (o QuotaResponseOutput) ToQuotaResponseOutput() QuotaResponseOutput

func (QuotaResponseOutput) ToQuotaResponseOutputWithContext

func (o QuotaResponseOutput) ToQuotaResponseOutputWithContext(ctx context.Context) QuotaResponseOutput

type Rollout added in v0.3.0

type Rollout struct {
	pulumi.CustomResourceState

	// Creation time of the rollout. Readonly.
	CreateTime pulumi.StringOutput `pulumi:"createTime"`
	// The user who created the Rollout. Readonly.
	CreatedBy pulumi.StringOutput `pulumi:"createdBy"`
	// The strategy associated with a rollout to delete a `ManagedService`. Readonly.
	DeleteServiceStrategy DeleteServiceStrategyResponseOutput `pulumi:"deleteServiceStrategy"`
	// Optional. Unique identifier of this Rollout. Must be no longer than 63 characters and only lower case letters, digits, '.', '_' and '-' are allowed. If not specified by client, the server will generate one. The generated id will have the form of , where "date" is the create date in ISO 8601 format. "revision number" is a monotonically increasing positive number that is reset every day for each service. An example of the generated rollout_id is '2016-02-16r1'
	RolloutId   pulumi.StringOutput `pulumi:"rolloutId"`
	ServiceName pulumi.StringOutput `pulumi:"serviceName"`
	// The status of this rollout. Readonly. In case of a failed rollout, the system will automatically rollback to the current Rollout version. Readonly.
	Status pulumi.StringOutput `pulumi:"status"`
	// Google Service Control selects service configurations based on traffic percentage.
	TrafficPercentStrategy TrafficPercentStrategyResponseOutput `pulumi:"trafficPercentStrategy"`
}

Creates a new service configuration rollout. Based on rollout, the Google Service Management will roll out the service configurations to different backend services. For example, the logging configuration will be pushed to Google Cloud Logging. Please note that any previous pending and running Rollouts and associated Operations will be automatically cancelled so that the latest Rollout will not be blocked by previous Rollouts. Only the 100 most recent (in any state) and the last 10 successful (if not already part of the set of 100 most recent) rollouts are kept for each service. The rest will be deleted eventually. Operation Auto-naming is currently not supported for this resource. Note - this resource's API doesn't support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.

func GetRollout added in v0.3.0

func GetRollout(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *RolloutState, opts ...pulumi.ResourceOption) (*Rollout, error)

GetRollout gets an existing Rollout resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewRollout added in v0.3.0

func NewRollout(ctx *pulumi.Context,
	name string, args *RolloutArgs, opts ...pulumi.ResourceOption) (*Rollout, error)

NewRollout registers a new resource with the given unique name, arguments, and options.

func (*Rollout) ElementType added in v0.3.0

func (*Rollout) ElementType() reflect.Type

func (*Rollout) ToRolloutOutput added in v0.3.0

func (i *Rollout) ToRolloutOutput() RolloutOutput

func (*Rollout) ToRolloutOutputWithContext added in v0.3.0

func (i *Rollout) ToRolloutOutputWithContext(ctx context.Context) RolloutOutput

type RolloutArgs added in v0.3.0

type RolloutArgs struct {
	// Creation time of the rollout. Readonly.
	CreateTime pulumi.StringPtrInput
	// The user who created the Rollout. Readonly.
	CreatedBy pulumi.StringPtrInput
	// The strategy associated with a rollout to delete a `ManagedService`. Readonly.
	DeleteServiceStrategy DeleteServiceStrategyPtrInput
	// Optional. Unique identifier of this Rollout. Must be no longer than 63 characters and only lower case letters, digits, '.', '_' and '-' are allowed. If not specified by client, the server will generate one. The generated id will have the form of , where "date" is the create date in ISO 8601 format. "revision number" is a monotonically increasing positive number that is reset every day for each service. An example of the generated rollout_id is '2016-02-16r1'
	RolloutId pulumi.StringPtrInput
	// The name of the service associated with this Rollout.
	ServiceName pulumi.StringInput
	// Google Service Control selects service configurations based on traffic percentage.
	TrafficPercentStrategy TrafficPercentStrategyPtrInput
}

The set of arguments for constructing a Rollout resource.

func (RolloutArgs) ElementType added in v0.3.0

func (RolloutArgs) ElementType() reflect.Type

type RolloutInput added in v0.3.0

type RolloutInput interface {
	pulumi.Input

	ToRolloutOutput() RolloutOutput
	ToRolloutOutputWithContext(ctx context.Context) RolloutOutput
}

type RolloutOutput added in v0.3.0

type RolloutOutput struct{ *pulumi.OutputState }

func (RolloutOutput) CreateTime added in v0.19.0

func (o RolloutOutput) CreateTime() pulumi.StringOutput

Creation time of the rollout. Readonly.

func (RolloutOutput) CreatedBy added in v0.19.0

func (o RolloutOutput) CreatedBy() pulumi.StringOutput

The user who created the Rollout. Readonly.

func (RolloutOutput) DeleteServiceStrategy added in v0.19.0

func (o RolloutOutput) DeleteServiceStrategy() DeleteServiceStrategyResponseOutput

The strategy associated with a rollout to delete a `ManagedService`. Readonly.

func (RolloutOutput) ElementType added in v0.3.0

func (RolloutOutput) ElementType() reflect.Type

func (RolloutOutput) RolloutId added in v0.19.0

func (o RolloutOutput) RolloutId() pulumi.StringOutput

Optional. Unique identifier of this Rollout. Must be no longer than 63 characters and only lower case letters, digits, '.', '_' and '-' are allowed. If not specified by client, the server will generate one. The generated id will have the form of , where "date" is the create date in ISO 8601 format. "revision number" is a monotonically increasing positive number that is reset every day for each service. An example of the generated rollout_id is '2016-02-16r1'

func (RolloutOutput) ServiceName added in v0.19.0

func (o RolloutOutput) ServiceName() pulumi.StringOutput

func (RolloutOutput) Status added in v0.19.0

func (o RolloutOutput) Status() pulumi.StringOutput

The status of this rollout. Readonly. In case of a failed rollout, the system will automatically rollback to the current Rollout version. Readonly.

func (RolloutOutput) ToRolloutOutput added in v0.3.0

func (o RolloutOutput) ToRolloutOutput() RolloutOutput

func (RolloutOutput) ToRolloutOutputWithContext added in v0.3.0

func (o RolloutOutput) ToRolloutOutputWithContext(ctx context.Context) RolloutOutput

func (RolloutOutput) TrafficPercentStrategy added in v0.19.0

func (o RolloutOutput) TrafficPercentStrategy() TrafficPercentStrategyResponseOutput

Google Service Control selects service configurations based on traffic percentage.

type RolloutState added in v0.3.0

type RolloutState struct {
}

func (RolloutState) ElementType added in v0.3.0

func (RolloutState) ElementType() reflect.Type

type RolloutStatus added in v0.4.0

type RolloutStatus string

The status of this rollout. Readonly. In case of a failed rollout, the system will automatically rollback to the current Rollout version. Readonly.

type RubySettings added in v0.28.0

type RubySettings struct {
	// Some settings.
	Common *CommonLanguageSettings `pulumi:"common"`
}

Settings for Ruby client libraries.

type RubySettingsArgs added in v0.28.0

type RubySettingsArgs struct {
	// Some settings.
	Common CommonLanguageSettingsPtrInput `pulumi:"common"`
}

Settings for Ruby client libraries.

func (RubySettingsArgs) ElementType added in v0.28.0

func (RubySettingsArgs) ElementType() reflect.Type

func (RubySettingsArgs) ToRubySettingsOutput added in v0.28.0

func (i RubySettingsArgs) ToRubySettingsOutput() RubySettingsOutput

func (RubySettingsArgs) ToRubySettingsOutputWithContext added in v0.28.0

func (i RubySettingsArgs) ToRubySettingsOutputWithContext(ctx context.Context) RubySettingsOutput

func (RubySettingsArgs) ToRubySettingsPtrOutput added in v0.28.0

func (i RubySettingsArgs) ToRubySettingsPtrOutput() RubySettingsPtrOutput

func (RubySettingsArgs) ToRubySettingsPtrOutputWithContext added in v0.28.0

func (i RubySettingsArgs) ToRubySettingsPtrOutputWithContext(ctx context.Context) RubySettingsPtrOutput

type RubySettingsInput added in v0.28.0

type RubySettingsInput interface {
	pulumi.Input

	ToRubySettingsOutput() RubySettingsOutput
	ToRubySettingsOutputWithContext(context.Context) RubySettingsOutput
}

RubySettingsInput is an input type that accepts RubySettingsArgs and RubySettingsOutput values. You can construct a concrete instance of `RubySettingsInput` via:

RubySettingsArgs{...}

type RubySettingsOutput added in v0.28.0

type RubySettingsOutput struct{ *pulumi.OutputState }

Settings for Ruby client libraries.

func (RubySettingsOutput) Common added in v0.28.0

Some settings.

func (RubySettingsOutput) ElementType added in v0.28.0

func (RubySettingsOutput) ElementType() reflect.Type

func (RubySettingsOutput) ToRubySettingsOutput added in v0.28.0

func (o RubySettingsOutput) ToRubySettingsOutput() RubySettingsOutput

func (RubySettingsOutput) ToRubySettingsOutputWithContext added in v0.28.0

func (o RubySettingsOutput) ToRubySettingsOutputWithContext(ctx context.Context) RubySettingsOutput

func (RubySettingsOutput) ToRubySettingsPtrOutput added in v0.28.0

func (o RubySettingsOutput) ToRubySettingsPtrOutput() RubySettingsPtrOutput

func (RubySettingsOutput) ToRubySettingsPtrOutputWithContext added in v0.28.0

func (o RubySettingsOutput) ToRubySettingsPtrOutputWithContext(ctx context.Context) RubySettingsPtrOutput

type RubySettingsPtrInput added in v0.28.0

type RubySettingsPtrInput interface {
	pulumi.Input

	ToRubySettingsPtrOutput() RubySettingsPtrOutput
	ToRubySettingsPtrOutputWithContext(context.Context) RubySettingsPtrOutput
}

RubySettingsPtrInput is an input type that accepts RubySettingsArgs, RubySettingsPtr and RubySettingsPtrOutput values. You can construct a concrete instance of `RubySettingsPtrInput` via:

        RubySettingsArgs{...}

or:

        nil

func RubySettingsPtr added in v0.28.0

func RubySettingsPtr(v *RubySettingsArgs) RubySettingsPtrInput

type RubySettingsPtrOutput added in v0.28.0

type RubySettingsPtrOutput struct{ *pulumi.OutputState }

func (RubySettingsPtrOutput) Common added in v0.28.0

Some settings.

func (RubySettingsPtrOutput) Elem added in v0.28.0

func (RubySettingsPtrOutput) ElementType added in v0.28.0

func (RubySettingsPtrOutput) ElementType() reflect.Type

func (RubySettingsPtrOutput) ToRubySettingsPtrOutput added in v0.28.0

func (o RubySettingsPtrOutput) ToRubySettingsPtrOutput() RubySettingsPtrOutput

func (RubySettingsPtrOutput) ToRubySettingsPtrOutputWithContext added in v0.28.0

func (o RubySettingsPtrOutput) ToRubySettingsPtrOutputWithContext(ctx context.Context) RubySettingsPtrOutput

type RubySettingsResponse added in v0.28.0

type RubySettingsResponse struct {
	// Some settings.
	Common CommonLanguageSettingsResponse `pulumi:"common"`
}

Settings for Ruby client libraries.

type RubySettingsResponseOutput added in v0.28.0

type RubySettingsResponseOutput struct{ *pulumi.OutputState }

Settings for Ruby client libraries.

func (RubySettingsResponseOutput) Common added in v0.28.0

Some settings.

func (RubySettingsResponseOutput) ElementType added in v0.28.0

func (RubySettingsResponseOutput) ElementType() reflect.Type

func (RubySettingsResponseOutput) ToRubySettingsResponseOutput added in v0.28.0

func (o RubySettingsResponseOutput) ToRubySettingsResponseOutput() RubySettingsResponseOutput

func (RubySettingsResponseOutput) ToRubySettingsResponseOutputWithContext added in v0.28.0

func (o RubySettingsResponseOutput) ToRubySettingsResponseOutputWithContext(ctx context.Context) RubySettingsResponseOutput

type Service

type Service struct {
	pulumi.CustomResourceState

	// ID of the project that produces and owns this service.
	ProducerProjectId pulumi.StringOutput `pulumi:"producerProjectId"`
	// The name of the service. See the [overview](https://cloud.google.com/service-infrastructure/docs/overview) for naming requirements.
	ServiceName pulumi.StringOutput `pulumi:"serviceName"`
}

Creates a new managed service. A managed service is immutable, and is subject to mandatory 30-day data retention. You cannot move a service or recreate it within 30 days after deletion. One producer project can own no more than 500 services. For security and reliability purposes, a production service should be hosted in a dedicated producer project. Operation Auto-naming is currently not supported for this resource.

func GetService

func GetService(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ServiceState, opts ...pulumi.ResourceOption) (*Service, error)

GetService gets an existing Service resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewService

func NewService(ctx *pulumi.Context,
	name string, args *ServiceArgs, opts ...pulumi.ResourceOption) (*Service, error)

NewService registers a new resource with the given unique name, arguments, and options.

func (*Service) ElementType

func (*Service) ElementType() reflect.Type

func (*Service) ToServiceOutput

func (i *Service) ToServiceOutput() ServiceOutput

func (*Service) ToServiceOutputWithContext

func (i *Service) ToServiceOutputWithContext(ctx context.Context) ServiceOutput

type ServiceArgs

type ServiceArgs struct {
	// ID of the project that produces and owns this service.
	ProducerProjectId pulumi.StringPtrInput
	// The name of the service. See the [overview](https://cloud.google.com/service-infrastructure/docs/overview) for naming requirements.
	ServiceName pulumi.StringPtrInput
}

The set of arguments for constructing a Service resource.

func (ServiceArgs) ElementType

func (ServiceArgs) ElementType() reflect.Type

type ServiceConsumerIamBinding added in v0.26.0

type ServiceConsumerIamBinding struct {
	pulumi.CustomResourceState

	// An IAM Condition for a given binding. See https://cloud.google.com/iam/docs/conditions-overview for additional details.
	Condition iam.ConditionPtrOutput `pulumi:"condition"`
	// The etag of the resource's IAM policy.
	Etag pulumi.StringOutput `pulumi:"etag"`
	// Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.
	Members pulumi.StringArrayOutput `pulumi:"members"`
	// The name of the resource to manage IAM policies for.
	Name pulumi.StringOutput `pulumi:"name"`
	// The project in which the resource belongs. If it is not provided, a default will be supplied.
	Project pulumi.StringOutput `pulumi:"project"`
	// Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
	Role pulumi.StringOutput `pulumi:"role"`
}

Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

func GetServiceConsumerIamBinding added in v0.26.0

func GetServiceConsumerIamBinding(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ServiceConsumerIamBindingState, opts ...pulumi.ResourceOption) (*ServiceConsumerIamBinding, error)

GetServiceConsumerIamBinding gets an existing ServiceConsumerIamBinding resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewServiceConsumerIamBinding added in v0.26.0

func NewServiceConsumerIamBinding(ctx *pulumi.Context,
	name string, args *ServiceConsumerIamBindingArgs, opts ...pulumi.ResourceOption) (*ServiceConsumerIamBinding, error)

NewServiceConsumerIamBinding registers a new resource with the given unique name, arguments, and options.

func (*ServiceConsumerIamBinding) ElementType added in v0.26.0

func (*ServiceConsumerIamBinding) ElementType() reflect.Type

func (*ServiceConsumerIamBinding) ToServiceConsumerIamBindingOutput added in v0.26.0

func (i *ServiceConsumerIamBinding) ToServiceConsumerIamBindingOutput() ServiceConsumerIamBindingOutput

func (*ServiceConsumerIamBinding) ToServiceConsumerIamBindingOutputWithContext added in v0.26.0

func (i *ServiceConsumerIamBinding) ToServiceConsumerIamBindingOutputWithContext(ctx context.Context) ServiceConsumerIamBindingOutput

type ServiceConsumerIamBindingArgs added in v0.26.0

type ServiceConsumerIamBindingArgs struct {
	// An IAM Condition for a given binding.
	Condition iam.ConditionPtrInput
	// Identities that will be granted the privilege in role. Each entry can have one of the following values:
	//
	//  * user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
	//  * serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
	//  * group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
	//  * domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
	Members pulumi.StringArrayInput
	// The name of the resource to manage IAM policies for.
	Name pulumi.StringInput
	// The role that should be applied. Only one `IamBinding` can be used per role.
	Role pulumi.StringInput
}

The set of arguments for constructing a ServiceConsumerIamBinding resource.

func (ServiceConsumerIamBindingArgs) ElementType added in v0.26.0

type ServiceConsumerIamBindingInput added in v0.26.0

type ServiceConsumerIamBindingInput interface {
	pulumi.Input

	ToServiceConsumerIamBindingOutput() ServiceConsumerIamBindingOutput
	ToServiceConsumerIamBindingOutputWithContext(ctx context.Context) ServiceConsumerIamBindingOutput
}

type ServiceConsumerIamBindingOutput added in v0.26.0

type ServiceConsumerIamBindingOutput struct{ *pulumi.OutputState }

func (ServiceConsumerIamBindingOutput) Condition added in v0.26.0

An IAM Condition for a given binding. See https://cloud.google.com/iam/docs/conditions-overview for additional details.

func (ServiceConsumerIamBindingOutput) ElementType added in v0.26.0

func (ServiceConsumerIamBindingOutput) Etag added in v0.26.0

The etag of the resource's IAM policy.

func (ServiceConsumerIamBindingOutput) Members added in v0.26.0

Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.

func (ServiceConsumerIamBindingOutput) Name added in v0.26.0

The name of the resource to manage IAM policies for.

func (ServiceConsumerIamBindingOutput) Project added in v0.26.0

The project in which the resource belongs. If it is not provided, a default will be supplied.

func (ServiceConsumerIamBindingOutput) Role added in v0.26.0

Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

func (ServiceConsumerIamBindingOutput) ToServiceConsumerIamBindingOutput added in v0.26.0

func (o ServiceConsumerIamBindingOutput) ToServiceConsumerIamBindingOutput() ServiceConsumerIamBindingOutput

func (ServiceConsumerIamBindingOutput) ToServiceConsumerIamBindingOutputWithContext added in v0.26.0

func (o ServiceConsumerIamBindingOutput) ToServiceConsumerIamBindingOutputWithContext(ctx context.Context) ServiceConsumerIamBindingOutput

type ServiceConsumerIamBindingState added in v0.26.0

type ServiceConsumerIamBindingState struct {
}

func (ServiceConsumerIamBindingState) ElementType added in v0.26.0

type ServiceConsumerIamMember added in v0.26.0

type ServiceConsumerIamMember struct {
	pulumi.CustomResourceState

	// An IAM Condition for a given binding. See https://cloud.google.com/iam/docs/conditions-overview for additional details.
	Condition iam.ConditionPtrOutput `pulumi:"condition"`
	// The etag of the resource's IAM policy.
	Etag pulumi.StringOutput `pulumi:"etag"`
	// Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.
	Member pulumi.StringOutput `pulumi:"member"`
	// The name of the resource to manage IAM policies for.
	Name pulumi.StringOutput `pulumi:"name"`
	// The project in which the resource belongs. If it is not provided, a default will be supplied.
	Project pulumi.StringOutput `pulumi:"project"`
	// Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
	Role pulumi.StringOutput `pulumi:"role"`
}

Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

func GetServiceConsumerIamMember added in v0.26.0

func GetServiceConsumerIamMember(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ServiceConsumerIamMemberState, opts ...pulumi.ResourceOption) (*ServiceConsumerIamMember, error)

GetServiceConsumerIamMember gets an existing ServiceConsumerIamMember resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewServiceConsumerIamMember added in v0.26.0

func NewServiceConsumerIamMember(ctx *pulumi.Context,
	name string, args *ServiceConsumerIamMemberArgs, opts ...pulumi.ResourceOption) (*ServiceConsumerIamMember, error)

NewServiceConsumerIamMember registers a new resource with the given unique name, arguments, and options.

func (*ServiceConsumerIamMember) ElementType added in v0.26.0

func (*ServiceConsumerIamMember) ElementType() reflect.Type

func (*ServiceConsumerIamMember) ToServiceConsumerIamMemberOutput added in v0.26.0

func (i *ServiceConsumerIamMember) ToServiceConsumerIamMemberOutput() ServiceConsumerIamMemberOutput

func (*ServiceConsumerIamMember) ToServiceConsumerIamMemberOutputWithContext added in v0.26.0

func (i *ServiceConsumerIamMember) ToServiceConsumerIamMemberOutputWithContext(ctx context.Context) ServiceConsumerIamMemberOutput

type ServiceConsumerIamMemberArgs added in v0.26.0

type ServiceConsumerIamMemberArgs struct {
	// An IAM Condition for a given binding.
	Condition iam.ConditionPtrInput
	// Identity that will be granted the privilege in role. The entry can have one of the following values:
	//
	//  * user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
	//  * serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
	//  * group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
	//  * domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
	Member pulumi.StringInput
	// The name of the resource to manage IAM policies for.
	Name pulumi.StringInput
	// The role that should be applied.
	Role pulumi.StringInput
}

The set of arguments for constructing a ServiceConsumerIamMember resource.

func (ServiceConsumerIamMemberArgs) ElementType added in v0.26.0

type ServiceConsumerIamMemberInput added in v0.26.0

type ServiceConsumerIamMemberInput interface {
	pulumi.Input

	ToServiceConsumerIamMemberOutput() ServiceConsumerIamMemberOutput
	ToServiceConsumerIamMemberOutputWithContext(ctx context.Context) ServiceConsumerIamMemberOutput
}

type ServiceConsumerIamMemberOutput added in v0.26.0

type ServiceConsumerIamMemberOutput struct{ *pulumi.OutputState }

func (ServiceConsumerIamMemberOutput) Condition added in v0.26.0

An IAM Condition for a given binding. See https://cloud.google.com/iam/docs/conditions-overview for additional details.

func (ServiceConsumerIamMemberOutput) ElementType added in v0.26.0

func (ServiceConsumerIamMemberOutput) Etag added in v0.26.0

The etag of the resource's IAM policy.

func (ServiceConsumerIamMemberOutput) Member added in v0.26.0

Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.

func (ServiceConsumerIamMemberOutput) Name added in v0.26.0

The name of the resource to manage IAM policies for.

func (ServiceConsumerIamMemberOutput) Project added in v0.26.0

The project in which the resource belongs. If it is not provided, a default will be supplied.

func (ServiceConsumerIamMemberOutput) Role added in v0.26.0

Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

func (ServiceConsumerIamMemberOutput) ToServiceConsumerIamMemberOutput added in v0.26.0

func (o ServiceConsumerIamMemberOutput) ToServiceConsumerIamMemberOutput() ServiceConsumerIamMemberOutput

func (ServiceConsumerIamMemberOutput) ToServiceConsumerIamMemberOutputWithContext added in v0.26.0

func (o ServiceConsumerIamMemberOutput) ToServiceConsumerIamMemberOutputWithContext(ctx context.Context) ServiceConsumerIamMemberOutput

type ServiceConsumerIamMemberState added in v0.26.0

type ServiceConsumerIamMemberState struct {
}

func (ServiceConsumerIamMemberState) ElementType added in v0.26.0

type ServiceConsumerIamPolicy

type ServiceConsumerIamPolicy struct {
	pulumi.CustomResourceState

	// Specifies cloud audit logging configuration for this policy.
	AuditConfigs AuditConfigResponseArrayOutput `pulumi:"auditConfigs"`
	// Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
	Bindings   BindingResponseArrayOutput `pulumi:"bindings"`
	ConsumerId pulumi.StringOutput        `pulumi:"consumerId"`
	// `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
	Etag      pulumi.StringOutput `pulumi:"etag"`
	ServiceId pulumi.StringOutput `pulumi:"serviceId"`
	// Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
	Version pulumi.IntOutput `pulumi:"version"`
}

Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. Note - this resource's API doesn't support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.

func GetServiceConsumerIamPolicy

func GetServiceConsumerIamPolicy(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ServiceConsumerIamPolicyState, opts ...pulumi.ResourceOption) (*ServiceConsumerIamPolicy, error)

GetServiceConsumerIamPolicy gets an existing ServiceConsumerIamPolicy resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewServiceConsumerIamPolicy

func NewServiceConsumerIamPolicy(ctx *pulumi.Context,
	name string, args *ServiceConsumerIamPolicyArgs, opts ...pulumi.ResourceOption) (*ServiceConsumerIamPolicy, error)

NewServiceConsumerIamPolicy registers a new resource with the given unique name, arguments, and options.

func (*ServiceConsumerIamPolicy) ElementType

func (*ServiceConsumerIamPolicy) ElementType() reflect.Type

func (*ServiceConsumerIamPolicy) ToServiceConsumerIamPolicyOutput

func (i *ServiceConsumerIamPolicy) ToServiceConsumerIamPolicyOutput() ServiceConsumerIamPolicyOutput

func (*ServiceConsumerIamPolicy) ToServiceConsumerIamPolicyOutputWithContext

func (i *ServiceConsumerIamPolicy) ToServiceConsumerIamPolicyOutputWithContext(ctx context.Context) ServiceConsumerIamPolicyOutput

type ServiceConsumerIamPolicyArgs

type ServiceConsumerIamPolicyArgs struct {
	// Specifies cloud audit logging configuration for this policy.
	AuditConfigs AuditConfigArrayInput
	// Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
	Bindings   BindingArrayInput
	ConsumerId pulumi.StringInput
	// `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
	Etag      pulumi.StringPtrInput
	ServiceId pulumi.StringInput
	// OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"`
	UpdateMask pulumi.StringPtrInput
	// Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
	Version pulumi.IntPtrInput
}

The set of arguments for constructing a ServiceConsumerIamPolicy resource.

func (ServiceConsumerIamPolicyArgs) ElementType

type ServiceConsumerIamPolicyInput

type ServiceConsumerIamPolicyInput interface {
	pulumi.Input

	ToServiceConsumerIamPolicyOutput() ServiceConsumerIamPolicyOutput
	ToServiceConsumerIamPolicyOutputWithContext(ctx context.Context) ServiceConsumerIamPolicyOutput
}

type ServiceConsumerIamPolicyOutput

type ServiceConsumerIamPolicyOutput struct{ *pulumi.OutputState }

func (ServiceConsumerIamPolicyOutput) AuditConfigs added in v0.19.0

Specifies cloud audit logging configuration for this policy.

func (ServiceConsumerIamPolicyOutput) Bindings added in v0.19.0

Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.

func (ServiceConsumerIamPolicyOutput) ConsumerId added in v0.21.0

func (ServiceConsumerIamPolicyOutput) ElementType

func (ServiceConsumerIamPolicyOutput) Etag added in v0.19.0

`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

func (ServiceConsumerIamPolicyOutput) ServiceId added in v0.21.0

func (ServiceConsumerIamPolicyOutput) ToServiceConsumerIamPolicyOutput

func (o ServiceConsumerIamPolicyOutput) ToServiceConsumerIamPolicyOutput() ServiceConsumerIamPolicyOutput

func (ServiceConsumerIamPolicyOutput) ToServiceConsumerIamPolicyOutputWithContext

func (o ServiceConsumerIamPolicyOutput) ToServiceConsumerIamPolicyOutputWithContext(ctx context.Context) ServiceConsumerIamPolicyOutput

func (ServiceConsumerIamPolicyOutput) Version added in v0.19.0

Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

type ServiceConsumerIamPolicyState

type ServiceConsumerIamPolicyState struct {
}

func (ServiceConsumerIamPolicyState) ElementType

type ServiceIamBinding added in v0.26.0

type ServiceIamBinding struct {
	pulumi.CustomResourceState

	// An IAM Condition for a given binding. See https://cloud.google.com/iam/docs/conditions-overview for additional details.
	Condition iam.ConditionPtrOutput `pulumi:"condition"`
	// The etag of the resource's IAM policy.
	Etag pulumi.StringOutput `pulumi:"etag"`
	// Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.
	Members pulumi.StringArrayOutput `pulumi:"members"`
	// The name of the resource to manage IAM policies for.
	Name pulumi.StringOutput `pulumi:"name"`
	// The project in which the resource belongs. If it is not provided, a default will be supplied.
	Project pulumi.StringOutput `pulumi:"project"`
	// Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
	Role pulumi.StringOutput `pulumi:"role"`
}

Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

func GetServiceIamBinding added in v0.26.0

func GetServiceIamBinding(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ServiceIamBindingState, opts ...pulumi.ResourceOption) (*ServiceIamBinding, error)

GetServiceIamBinding gets an existing ServiceIamBinding resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewServiceIamBinding added in v0.26.0

func NewServiceIamBinding(ctx *pulumi.Context,
	name string, args *ServiceIamBindingArgs, opts ...pulumi.ResourceOption) (*ServiceIamBinding, error)

NewServiceIamBinding registers a new resource with the given unique name, arguments, and options.

func (*ServiceIamBinding) ElementType added in v0.26.0

func (*ServiceIamBinding) ElementType() reflect.Type

func (*ServiceIamBinding) ToServiceIamBindingOutput added in v0.26.0

func (i *ServiceIamBinding) ToServiceIamBindingOutput() ServiceIamBindingOutput

func (*ServiceIamBinding) ToServiceIamBindingOutputWithContext added in v0.26.0

func (i *ServiceIamBinding) ToServiceIamBindingOutputWithContext(ctx context.Context) ServiceIamBindingOutput

type ServiceIamBindingArgs added in v0.26.0

type ServiceIamBindingArgs struct {
	// An IAM Condition for a given binding.
	Condition iam.ConditionPtrInput
	// Identities that will be granted the privilege in role. Each entry can have one of the following values:
	//
	//  * user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
	//  * serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
	//  * group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
	//  * domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
	Members pulumi.StringArrayInput
	// The name of the resource to manage IAM policies for.
	Name pulumi.StringInput
	// The role that should be applied. Only one `IamBinding` can be used per role.
	Role pulumi.StringInput
}

The set of arguments for constructing a ServiceIamBinding resource.

func (ServiceIamBindingArgs) ElementType added in v0.26.0

func (ServiceIamBindingArgs) ElementType() reflect.Type

type ServiceIamBindingInput added in v0.26.0

type ServiceIamBindingInput interface {
	pulumi.Input

	ToServiceIamBindingOutput() ServiceIamBindingOutput
	ToServiceIamBindingOutputWithContext(ctx context.Context) ServiceIamBindingOutput
}

type ServiceIamBindingOutput added in v0.26.0

type ServiceIamBindingOutput struct{ *pulumi.OutputState }

func (ServiceIamBindingOutput) Condition added in v0.26.0

An IAM Condition for a given binding. See https://cloud.google.com/iam/docs/conditions-overview for additional details.

func (ServiceIamBindingOutput) ElementType added in v0.26.0

func (ServiceIamBindingOutput) ElementType() reflect.Type

func (ServiceIamBindingOutput) Etag added in v0.26.0

The etag of the resource's IAM policy.

func (ServiceIamBindingOutput) Members added in v0.26.0

Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.

func (ServiceIamBindingOutput) Name added in v0.26.0

The name of the resource to manage IAM policies for.

func (ServiceIamBindingOutput) Project added in v0.26.0

The project in which the resource belongs. If it is not provided, a default will be supplied.

func (ServiceIamBindingOutput) Role added in v0.26.0

Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

func (ServiceIamBindingOutput) ToServiceIamBindingOutput added in v0.26.0

func (o ServiceIamBindingOutput) ToServiceIamBindingOutput() ServiceIamBindingOutput

func (ServiceIamBindingOutput) ToServiceIamBindingOutputWithContext added in v0.26.0

func (o ServiceIamBindingOutput) ToServiceIamBindingOutputWithContext(ctx context.Context) ServiceIamBindingOutput

type ServiceIamBindingState added in v0.26.0

type ServiceIamBindingState struct {
}

func (ServiceIamBindingState) ElementType added in v0.26.0

func (ServiceIamBindingState) ElementType() reflect.Type

type ServiceIamMember added in v0.26.0

type ServiceIamMember struct {
	pulumi.CustomResourceState

	// An IAM Condition for a given binding. See https://cloud.google.com/iam/docs/conditions-overview for additional details.
	Condition iam.ConditionPtrOutput `pulumi:"condition"`
	// The etag of the resource's IAM policy.
	Etag pulumi.StringOutput `pulumi:"etag"`
	// Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.
	Member pulumi.StringOutput `pulumi:"member"`
	// The name of the resource to manage IAM policies for.
	Name pulumi.StringOutput `pulumi:"name"`
	// The project in which the resource belongs. If it is not provided, a default will be supplied.
	Project pulumi.StringOutput `pulumi:"project"`
	// Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
	Role pulumi.StringOutput `pulumi:"role"`
}

Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

func GetServiceIamMember added in v0.26.0

func GetServiceIamMember(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ServiceIamMemberState, opts ...pulumi.ResourceOption) (*ServiceIamMember, error)

GetServiceIamMember gets an existing ServiceIamMember resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewServiceIamMember added in v0.26.0

func NewServiceIamMember(ctx *pulumi.Context,
	name string, args *ServiceIamMemberArgs, opts ...pulumi.ResourceOption) (*ServiceIamMember, error)

NewServiceIamMember registers a new resource with the given unique name, arguments, and options.

func (*ServiceIamMember) ElementType added in v0.26.0

func (*ServiceIamMember) ElementType() reflect.Type

func (*ServiceIamMember) ToServiceIamMemberOutput added in v0.26.0

func (i *ServiceIamMember) ToServiceIamMemberOutput() ServiceIamMemberOutput

func (*ServiceIamMember) ToServiceIamMemberOutputWithContext added in v0.26.0

func (i *ServiceIamMember) ToServiceIamMemberOutputWithContext(ctx context.Context) ServiceIamMemberOutput

type ServiceIamMemberArgs added in v0.26.0

type ServiceIamMemberArgs struct {
	// An IAM Condition for a given binding.
	Condition iam.ConditionPtrInput
	// Identity that will be granted the privilege in role. The entry can have one of the following values:
	//
	//  * user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
	//  * serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
	//  * group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
	//  * domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
	Member pulumi.StringInput
	// The name of the resource to manage IAM policies for.
	Name pulumi.StringInput
	// The role that should be applied.
	Role pulumi.StringInput
}

The set of arguments for constructing a ServiceIamMember resource.

func (ServiceIamMemberArgs) ElementType added in v0.26.0

func (ServiceIamMemberArgs) ElementType() reflect.Type

type ServiceIamMemberInput added in v0.26.0

type ServiceIamMemberInput interface {
	pulumi.Input

	ToServiceIamMemberOutput() ServiceIamMemberOutput
	ToServiceIamMemberOutputWithContext(ctx context.Context) ServiceIamMemberOutput
}

type ServiceIamMemberOutput added in v0.26.0

type ServiceIamMemberOutput struct{ *pulumi.OutputState }

func (ServiceIamMemberOutput) Condition added in v0.26.0

An IAM Condition for a given binding. See https://cloud.google.com/iam/docs/conditions-overview for additional details.

func (ServiceIamMemberOutput) ElementType added in v0.26.0

func (ServiceIamMemberOutput) ElementType() reflect.Type

func (ServiceIamMemberOutput) Etag added in v0.26.0

The etag of the resource's IAM policy.

func (ServiceIamMemberOutput) Member added in v0.26.0

Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.

func (ServiceIamMemberOutput) Name added in v0.26.0

The name of the resource to manage IAM policies for.

func (ServiceIamMemberOutput) Project added in v0.26.0

The project in which the resource belongs. If it is not provided, a default will be supplied.

func (ServiceIamMemberOutput) Role added in v0.26.0

Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

func (ServiceIamMemberOutput) ToServiceIamMemberOutput added in v0.26.0

func (o ServiceIamMemberOutput) ToServiceIamMemberOutput() ServiceIamMemberOutput

func (ServiceIamMemberOutput) ToServiceIamMemberOutputWithContext added in v0.26.0

func (o ServiceIamMemberOutput) ToServiceIamMemberOutputWithContext(ctx context.Context) ServiceIamMemberOutput

type ServiceIamMemberState added in v0.26.0

type ServiceIamMemberState struct {
}

func (ServiceIamMemberState) ElementType added in v0.26.0

func (ServiceIamMemberState) ElementType() reflect.Type

type ServiceIamPolicy

type ServiceIamPolicy struct {
	pulumi.CustomResourceState

	// Specifies cloud audit logging configuration for this policy.
	AuditConfigs AuditConfigResponseArrayOutput `pulumi:"auditConfigs"`
	// Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
	Bindings BindingResponseArrayOutput `pulumi:"bindings"`
	// `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
	Etag      pulumi.StringOutput `pulumi:"etag"`
	ServiceId pulumi.StringOutput `pulumi:"serviceId"`
	// Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
	Version pulumi.IntOutput `pulumi:"version"`
}

Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. Note - this resource's API doesn't support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.

func GetServiceIamPolicy

func GetServiceIamPolicy(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ServiceIamPolicyState, opts ...pulumi.ResourceOption) (*ServiceIamPolicy, error)

GetServiceIamPolicy gets an existing ServiceIamPolicy resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewServiceIamPolicy

func NewServiceIamPolicy(ctx *pulumi.Context,
	name string, args *ServiceIamPolicyArgs, opts ...pulumi.ResourceOption) (*ServiceIamPolicy, error)

NewServiceIamPolicy registers a new resource with the given unique name, arguments, and options.

func (*ServiceIamPolicy) ElementType

func (*ServiceIamPolicy) ElementType() reflect.Type

func (*ServiceIamPolicy) ToServiceIamPolicyOutput

func (i *ServiceIamPolicy) ToServiceIamPolicyOutput() ServiceIamPolicyOutput

func (*ServiceIamPolicy) ToServiceIamPolicyOutputWithContext

func (i *ServiceIamPolicy) ToServiceIamPolicyOutputWithContext(ctx context.Context) ServiceIamPolicyOutput

type ServiceIamPolicyArgs

type ServiceIamPolicyArgs struct {
	// Specifies cloud audit logging configuration for this policy.
	AuditConfigs AuditConfigArrayInput
	// Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
	Bindings BindingArrayInput
	// `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
	Etag      pulumi.StringPtrInput
	ServiceId pulumi.StringInput
	// OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"`
	UpdateMask pulumi.StringPtrInput
	// Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
	Version pulumi.IntPtrInput
}

The set of arguments for constructing a ServiceIamPolicy resource.

func (ServiceIamPolicyArgs) ElementType

func (ServiceIamPolicyArgs) ElementType() reflect.Type

type ServiceIamPolicyInput

type ServiceIamPolicyInput interface {
	pulumi.Input

	ToServiceIamPolicyOutput() ServiceIamPolicyOutput
	ToServiceIamPolicyOutputWithContext(ctx context.Context) ServiceIamPolicyOutput
}

type ServiceIamPolicyOutput

type ServiceIamPolicyOutput struct{ *pulumi.OutputState }

func (ServiceIamPolicyOutput) AuditConfigs added in v0.19.0

Specifies cloud audit logging configuration for this policy.

func (ServiceIamPolicyOutput) Bindings added in v0.19.0

Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.

func (ServiceIamPolicyOutput) ElementType

func (ServiceIamPolicyOutput) ElementType() reflect.Type

func (ServiceIamPolicyOutput) Etag added in v0.19.0

`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

func (ServiceIamPolicyOutput) ServiceId added in v0.21.0

func (ServiceIamPolicyOutput) ToServiceIamPolicyOutput

func (o ServiceIamPolicyOutput) ToServiceIamPolicyOutput() ServiceIamPolicyOutput

func (ServiceIamPolicyOutput) ToServiceIamPolicyOutputWithContext

func (o ServiceIamPolicyOutput) ToServiceIamPolicyOutputWithContext(ctx context.Context) ServiceIamPolicyOutput

func (ServiceIamPolicyOutput) Version added in v0.19.0

Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

type ServiceIamPolicyState

type ServiceIamPolicyState struct {
}

func (ServiceIamPolicyState) ElementType

func (ServiceIamPolicyState) ElementType() reflect.Type

type ServiceInput

type ServiceInput interface {
	pulumi.Input

	ToServiceOutput() ServiceOutput
	ToServiceOutputWithContext(ctx context.Context) ServiceOutput
}

type ServiceOutput

type ServiceOutput struct{ *pulumi.OutputState }

func (ServiceOutput) ElementType

func (ServiceOutput) ElementType() reflect.Type

func (ServiceOutput) ProducerProjectId added in v0.19.0

func (o ServiceOutput) ProducerProjectId() pulumi.StringOutput

ID of the project that produces and owns this service.

func (ServiceOutput) ServiceName added in v0.19.0

func (o ServiceOutput) ServiceName() pulumi.StringOutput

The name of the service. See the [overview](https://cloud.google.com/service-infrastructure/docs/overview) for naming requirements.

func (ServiceOutput) ToServiceOutput

func (o ServiceOutput) ToServiceOutput() ServiceOutput

func (ServiceOutput) ToServiceOutputWithContext

func (o ServiceOutput) ToServiceOutputWithContext(ctx context.Context) ServiceOutput

type ServiceState

type ServiceState struct {
}

func (ServiceState) ElementType

func (ServiceState) ElementType() reflect.Type

type SourceContext

type SourceContext struct {
	// The path-qualified name of the .proto file that contained the associated protobuf element. For example: `"google/protobuf/source_context.proto"`.
	FileName *string `pulumi:"fileName"`
}

`SourceContext` represents information about the source of a protobuf element, like the file in which it is defined.

type SourceContextArgs

type SourceContextArgs struct {
	// The path-qualified name of the .proto file that contained the associated protobuf element. For example: `"google/protobuf/source_context.proto"`.
	FileName pulumi.StringPtrInput `pulumi:"fileName"`
}

`SourceContext` represents information about the source of a protobuf element, like the file in which it is defined.

func (SourceContextArgs) ElementType

func (SourceContextArgs) ElementType() reflect.Type

func (SourceContextArgs) ToSourceContextOutput

func (i SourceContextArgs) ToSourceContextOutput() SourceContextOutput

func (SourceContextArgs) ToSourceContextOutputWithContext

func (i SourceContextArgs) ToSourceContextOutputWithContext(ctx context.Context) SourceContextOutput

func (SourceContextArgs) ToSourceContextPtrOutput

func (i SourceContextArgs) ToSourceContextPtrOutput() SourceContextPtrOutput

func (SourceContextArgs) ToSourceContextPtrOutputWithContext

func (i SourceContextArgs) ToSourceContextPtrOutputWithContext(ctx context.Context) SourceContextPtrOutput

type SourceContextInput

type SourceContextInput interface {
	pulumi.Input

	ToSourceContextOutput() SourceContextOutput
	ToSourceContextOutputWithContext(context.Context) SourceContextOutput
}

SourceContextInput is an input type that accepts SourceContextArgs and SourceContextOutput values. You can construct a concrete instance of `SourceContextInput` via:

SourceContextArgs{...}

type SourceContextOutput

type SourceContextOutput struct{ *pulumi.OutputState }

`SourceContext` represents information about the source of a protobuf element, like the file in which it is defined.

func (SourceContextOutput) ElementType

func (SourceContextOutput) ElementType() reflect.Type

func (SourceContextOutput) FileName

The path-qualified name of the .proto file that contained the associated protobuf element. For example: `"google/protobuf/source_context.proto"`.

func (SourceContextOutput) ToSourceContextOutput

func (o SourceContextOutput) ToSourceContextOutput() SourceContextOutput

func (SourceContextOutput) ToSourceContextOutputWithContext

func (o SourceContextOutput) ToSourceContextOutputWithContext(ctx context.Context) SourceContextOutput

func (SourceContextOutput) ToSourceContextPtrOutput

func (o SourceContextOutput) ToSourceContextPtrOutput() SourceContextPtrOutput

func (SourceContextOutput) ToSourceContextPtrOutputWithContext

func (o SourceContextOutput) ToSourceContextPtrOutputWithContext(ctx context.Context) SourceContextPtrOutput

type SourceContextPtrInput

type SourceContextPtrInput interface {
	pulumi.Input

	ToSourceContextPtrOutput() SourceContextPtrOutput
	ToSourceContextPtrOutputWithContext(context.Context) SourceContextPtrOutput
}

SourceContextPtrInput is an input type that accepts SourceContextArgs, SourceContextPtr and SourceContextPtrOutput values. You can construct a concrete instance of `SourceContextPtrInput` via:

        SourceContextArgs{...}

or:

        nil

type SourceContextPtrOutput

type SourceContextPtrOutput struct{ *pulumi.OutputState }

func (SourceContextPtrOutput) Elem

func (SourceContextPtrOutput) ElementType

func (SourceContextPtrOutput) ElementType() reflect.Type

func (SourceContextPtrOutput) FileName

The path-qualified name of the .proto file that contained the associated protobuf element. For example: `"google/protobuf/source_context.proto"`.

func (SourceContextPtrOutput) ToSourceContextPtrOutput

func (o SourceContextPtrOutput) ToSourceContextPtrOutput() SourceContextPtrOutput

func (SourceContextPtrOutput) ToSourceContextPtrOutputWithContext

func (o SourceContextPtrOutput) ToSourceContextPtrOutputWithContext(ctx context.Context) SourceContextPtrOutput

type SourceContextResponse

type SourceContextResponse struct {
	// The path-qualified name of the .proto file that contained the associated protobuf element. For example: `"google/protobuf/source_context.proto"`.
	FileName string `pulumi:"fileName"`
}

`SourceContext` represents information about the source of a protobuf element, like the file in which it is defined.

type SourceContextResponseOutput

type SourceContextResponseOutput struct{ *pulumi.OutputState }

`SourceContext` represents information about the source of a protobuf element, like the file in which it is defined.

func (SourceContextResponseOutput) ElementType

func (SourceContextResponseOutput) FileName

The path-qualified name of the .proto file that contained the associated protobuf element. For example: `"google/protobuf/source_context.proto"`.

func (SourceContextResponseOutput) ToSourceContextResponseOutput

func (o SourceContextResponseOutput) ToSourceContextResponseOutput() SourceContextResponseOutput

func (SourceContextResponseOutput) ToSourceContextResponseOutputWithContext

func (o SourceContextResponseOutput) ToSourceContextResponseOutputWithContext(ctx context.Context) SourceContextResponseOutput

type SourceInfoResponse

type SourceInfoResponse struct {
	// All files used during config generation.
	SourceFiles []map[string]string `pulumi:"sourceFiles"`
}

Source information used to create a Service Config

type SourceInfoResponseOutput

type SourceInfoResponseOutput struct{ *pulumi.OutputState }

Source information used to create a Service Config

func (SourceInfoResponseOutput) ElementType

func (SourceInfoResponseOutput) ElementType() reflect.Type

func (SourceInfoResponseOutput) SourceFiles

All files used during config generation.

func (SourceInfoResponseOutput) ToSourceInfoResponseOutput

func (o SourceInfoResponseOutput) ToSourceInfoResponseOutput() SourceInfoResponseOutput

func (SourceInfoResponseOutput) ToSourceInfoResponseOutputWithContext

func (o SourceInfoResponseOutput) ToSourceInfoResponseOutputWithContext(ctx context.Context) SourceInfoResponseOutput

type SystemParameter

type SystemParameter struct {
	// Define the HTTP header name to use for the parameter. It is case insensitive.
	HttpHeader *string `pulumi:"httpHeader"`
	// Define the name of the parameter, such as "api_key" . It is case sensitive.
	Name *string `pulumi:"name"`
	// Define the URL query parameter name to use for the parameter. It is case sensitive.
	UrlQueryParameter *string `pulumi:"urlQueryParameter"`
}

Define a parameter's name and location. The parameter may be passed as either an HTTP header or a URL query parameter, and if both are passed the behavior is implementation-dependent.

type SystemParameterArgs

type SystemParameterArgs struct {
	// Define the HTTP header name to use for the parameter. It is case insensitive.
	HttpHeader pulumi.StringPtrInput `pulumi:"httpHeader"`
	// Define the name of the parameter, such as "api_key" . It is case sensitive.
	Name pulumi.StringPtrInput `pulumi:"name"`
	// Define the URL query parameter name to use for the parameter. It is case sensitive.
	UrlQueryParameter pulumi.StringPtrInput `pulumi:"urlQueryParameter"`
}

Define a parameter's name and location. The parameter may be passed as either an HTTP header or a URL query parameter, and if both are passed the behavior is implementation-dependent.

func (SystemParameterArgs) ElementType

func (SystemParameterArgs) ElementType() reflect.Type

func (SystemParameterArgs) ToSystemParameterOutput

func (i SystemParameterArgs) ToSystemParameterOutput() SystemParameterOutput

func (SystemParameterArgs) ToSystemParameterOutputWithContext

func (i SystemParameterArgs) ToSystemParameterOutputWithContext(ctx context.Context) SystemParameterOutput

type SystemParameterArray

type SystemParameterArray []SystemParameterInput

func (SystemParameterArray) ElementType

func (SystemParameterArray) ElementType() reflect.Type

func (SystemParameterArray) ToSystemParameterArrayOutput

func (i SystemParameterArray) ToSystemParameterArrayOutput() SystemParameterArrayOutput

func (SystemParameterArray) ToSystemParameterArrayOutputWithContext

func (i SystemParameterArray) ToSystemParameterArrayOutputWithContext(ctx context.Context) SystemParameterArrayOutput

type SystemParameterArrayInput

type SystemParameterArrayInput interface {
	pulumi.Input

	ToSystemParameterArrayOutput() SystemParameterArrayOutput
	ToSystemParameterArrayOutputWithContext(context.Context) SystemParameterArrayOutput
}

SystemParameterArrayInput is an input type that accepts SystemParameterArray and SystemParameterArrayOutput values. You can construct a concrete instance of `SystemParameterArrayInput` via:

SystemParameterArray{ SystemParameterArgs{...} }

type SystemParameterArrayOutput

type SystemParameterArrayOutput struct{ *pulumi.OutputState }

func (SystemParameterArrayOutput) ElementType

func (SystemParameterArrayOutput) ElementType() reflect.Type

func (SystemParameterArrayOutput) Index

func (SystemParameterArrayOutput) ToSystemParameterArrayOutput

func (o SystemParameterArrayOutput) ToSystemParameterArrayOutput() SystemParameterArrayOutput

func (SystemParameterArrayOutput) ToSystemParameterArrayOutputWithContext

func (o SystemParameterArrayOutput) ToSystemParameterArrayOutputWithContext(ctx context.Context) SystemParameterArrayOutput

type SystemParameterInput

type SystemParameterInput interface {
	pulumi.Input

	ToSystemParameterOutput() SystemParameterOutput
	ToSystemParameterOutputWithContext(context.Context) SystemParameterOutput
}

SystemParameterInput is an input type that accepts SystemParameterArgs and SystemParameterOutput values. You can construct a concrete instance of `SystemParameterInput` via:

SystemParameterArgs{...}

type SystemParameterOutput

type SystemParameterOutput struct{ *pulumi.OutputState }

Define a parameter's name and location. The parameter may be passed as either an HTTP header or a URL query parameter, and if both are passed the behavior is implementation-dependent.

func (SystemParameterOutput) ElementType

func (SystemParameterOutput) ElementType() reflect.Type

func (SystemParameterOutput) HttpHeader

Define the HTTP header name to use for the parameter. It is case insensitive.

func (SystemParameterOutput) Name

Define the name of the parameter, such as "api_key" . It is case sensitive.

func (SystemParameterOutput) ToSystemParameterOutput

func (o SystemParameterOutput) ToSystemParameterOutput() SystemParameterOutput

func (SystemParameterOutput) ToSystemParameterOutputWithContext

func (o SystemParameterOutput) ToSystemParameterOutputWithContext(ctx context.Context) SystemParameterOutput

func (SystemParameterOutput) UrlQueryParameter

func (o SystemParameterOutput) UrlQueryParameter() pulumi.StringPtrOutput

Define the URL query parameter name to use for the parameter. It is case sensitive.

type SystemParameterResponse

type SystemParameterResponse struct {
	// Define the HTTP header name to use for the parameter. It is case insensitive.
	HttpHeader string `pulumi:"httpHeader"`
	// Define the name of the parameter, such as "api_key" . It is case sensitive.
	Name string `pulumi:"name"`
	// Define the URL query parameter name to use for the parameter. It is case sensitive.
	UrlQueryParameter string `pulumi:"urlQueryParameter"`
}

Define a parameter's name and location. The parameter may be passed as either an HTTP header or a URL query parameter, and if both are passed the behavior is implementation-dependent.

type SystemParameterResponseArrayOutput

type SystemParameterResponseArrayOutput struct{ *pulumi.OutputState }

func (SystemParameterResponseArrayOutput) ElementType

func (SystemParameterResponseArrayOutput) Index

func (SystemParameterResponseArrayOutput) ToSystemParameterResponseArrayOutput

func (o SystemParameterResponseArrayOutput) ToSystemParameterResponseArrayOutput() SystemParameterResponseArrayOutput

func (SystemParameterResponseArrayOutput) ToSystemParameterResponseArrayOutputWithContext

func (o SystemParameterResponseArrayOutput) ToSystemParameterResponseArrayOutputWithContext(ctx context.Context) SystemParameterResponseArrayOutput

type SystemParameterResponseOutput

type SystemParameterResponseOutput struct{ *pulumi.OutputState }

Define a parameter's name and location. The parameter may be passed as either an HTTP header or a URL query parameter, and if both are passed the behavior is implementation-dependent.

func (SystemParameterResponseOutput) ElementType

func (SystemParameterResponseOutput) HttpHeader

Define the HTTP header name to use for the parameter. It is case insensitive.

func (SystemParameterResponseOutput) Name

Define the name of the parameter, such as "api_key" . It is case sensitive.

func (SystemParameterResponseOutput) ToSystemParameterResponseOutput

func (o SystemParameterResponseOutput) ToSystemParameterResponseOutput() SystemParameterResponseOutput

func (SystemParameterResponseOutput) ToSystemParameterResponseOutputWithContext

func (o SystemParameterResponseOutput) ToSystemParameterResponseOutputWithContext(ctx context.Context) SystemParameterResponseOutput

func (SystemParameterResponseOutput) UrlQueryParameter

func (o SystemParameterResponseOutput) UrlQueryParameter() pulumi.StringOutput

Define the URL query parameter name to use for the parameter. It is case sensitive.

type SystemParameterRule

type SystemParameterRule struct {
	// Define parameters. Multiple names may be defined for a parameter. For a given method call, only one of them should be used. If multiple names are used the behavior is implementation-dependent. If none of the specified names are present the behavior is parameter-dependent.
	Parameters []SystemParameter `pulumi:"parameters"`
	// Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details.
	Selector *string `pulumi:"selector"`
}

Define a system parameter rule mapping system parameter definitions to methods.

type SystemParameterRuleArgs

type SystemParameterRuleArgs struct {
	// Define parameters. Multiple names may be defined for a parameter. For a given method call, only one of them should be used. If multiple names are used the behavior is implementation-dependent. If none of the specified names are present the behavior is parameter-dependent.
	Parameters SystemParameterArrayInput `pulumi:"parameters"`
	// Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details.
	Selector pulumi.StringPtrInput `pulumi:"selector"`
}

Define a system parameter rule mapping system parameter definitions to methods.

func (SystemParameterRuleArgs) ElementType

func (SystemParameterRuleArgs) ElementType() reflect.Type

func (SystemParameterRuleArgs) ToSystemParameterRuleOutput

func (i SystemParameterRuleArgs) ToSystemParameterRuleOutput() SystemParameterRuleOutput

func (SystemParameterRuleArgs) ToSystemParameterRuleOutputWithContext

func (i SystemParameterRuleArgs) ToSystemParameterRuleOutputWithContext(ctx context.Context) SystemParameterRuleOutput

type SystemParameterRuleArray

type SystemParameterRuleArray []SystemParameterRuleInput

func (SystemParameterRuleArray) ElementType

func (SystemParameterRuleArray) ElementType() reflect.Type

func (SystemParameterRuleArray) ToSystemParameterRuleArrayOutput

func (i SystemParameterRuleArray) ToSystemParameterRuleArrayOutput() SystemParameterRuleArrayOutput

func (SystemParameterRuleArray) ToSystemParameterRuleArrayOutputWithContext

func (i SystemParameterRuleArray) ToSystemParameterRuleArrayOutputWithContext(ctx context.Context) SystemParameterRuleArrayOutput

type SystemParameterRuleArrayInput

type SystemParameterRuleArrayInput interface {
	pulumi.Input

	ToSystemParameterRuleArrayOutput() SystemParameterRuleArrayOutput
	ToSystemParameterRuleArrayOutputWithContext(context.Context) SystemParameterRuleArrayOutput
}

SystemParameterRuleArrayInput is an input type that accepts SystemParameterRuleArray and SystemParameterRuleArrayOutput values. You can construct a concrete instance of `SystemParameterRuleArrayInput` via:

SystemParameterRuleArray{ SystemParameterRuleArgs{...} }

type SystemParameterRuleArrayOutput

type SystemParameterRuleArrayOutput struct{ *pulumi.OutputState }

func (SystemParameterRuleArrayOutput) ElementType

func (SystemParameterRuleArrayOutput) Index

func (SystemParameterRuleArrayOutput) ToSystemParameterRuleArrayOutput

func (o SystemParameterRuleArrayOutput) ToSystemParameterRuleArrayOutput() SystemParameterRuleArrayOutput

func (SystemParameterRuleArrayOutput) ToSystemParameterRuleArrayOutputWithContext

func (o SystemParameterRuleArrayOutput) ToSystemParameterRuleArrayOutputWithContext(ctx context.Context) SystemParameterRuleArrayOutput

type SystemParameterRuleInput

type SystemParameterRuleInput interface {
	pulumi.Input

	ToSystemParameterRuleOutput() SystemParameterRuleOutput
	ToSystemParameterRuleOutputWithContext(context.Context) SystemParameterRuleOutput
}

SystemParameterRuleInput is an input type that accepts SystemParameterRuleArgs and SystemParameterRuleOutput values. You can construct a concrete instance of `SystemParameterRuleInput` via:

SystemParameterRuleArgs{...}

type SystemParameterRuleOutput

type SystemParameterRuleOutput struct{ *pulumi.OutputState }

Define a system parameter rule mapping system parameter definitions to methods.

func (SystemParameterRuleOutput) ElementType

func (SystemParameterRuleOutput) ElementType() reflect.Type

func (SystemParameterRuleOutput) Parameters

Define parameters. Multiple names may be defined for a parameter. For a given method call, only one of them should be used. If multiple names are used the behavior is implementation-dependent. If none of the specified names are present the behavior is parameter-dependent.

func (SystemParameterRuleOutput) Selector

Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details.

func (SystemParameterRuleOutput) ToSystemParameterRuleOutput

func (o SystemParameterRuleOutput) ToSystemParameterRuleOutput() SystemParameterRuleOutput

func (SystemParameterRuleOutput) ToSystemParameterRuleOutputWithContext

func (o SystemParameterRuleOutput) ToSystemParameterRuleOutputWithContext(ctx context.Context) SystemParameterRuleOutput

type SystemParameterRuleResponse

type SystemParameterRuleResponse struct {
	// Define parameters. Multiple names may be defined for a parameter. For a given method call, only one of them should be used. If multiple names are used the behavior is implementation-dependent. If none of the specified names are present the behavior is parameter-dependent.
	Parameters []SystemParameterResponse `pulumi:"parameters"`
	// Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details.
	Selector string `pulumi:"selector"`
}

Define a system parameter rule mapping system parameter definitions to methods.

type SystemParameterRuleResponseArrayOutput

type SystemParameterRuleResponseArrayOutput struct{ *pulumi.OutputState }

func (SystemParameterRuleResponseArrayOutput) ElementType

func (SystemParameterRuleResponseArrayOutput) Index

func (SystemParameterRuleResponseArrayOutput) ToSystemParameterRuleResponseArrayOutput

func (o SystemParameterRuleResponseArrayOutput) ToSystemParameterRuleResponseArrayOutput() SystemParameterRuleResponseArrayOutput

func (SystemParameterRuleResponseArrayOutput) ToSystemParameterRuleResponseArrayOutputWithContext

func (o SystemParameterRuleResponseArrayOutput) ToSystemParameterRuleResponseArrayOutputWithContext(ctx context.Context) SystemParameterRuleResponseArrayOutput

type SystemParameterRuleResponseOutput

type SystemParameterRuleResponseOutput struct{ *pulumi.OutputState }

Define a system parameter rule mapping system parameter definitions to methods.

func (SystemParameterRuleResponseOutput) ElementType

func (SystemParameterRuleResponseOutput) Parameters

Define parameters. Multiple names may be defined for a parameter. For a given method call, only one of them should be used. If multiple names are used the behavior is implementation-dependent. If none of the specified names are present the behavior is parameter-dependent.

func (SystemParameterRuleResponseOutput) Selector

Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details.

func (SystemParameterRuleResponseOutput) ToSystemParameterRuleResponseOutput

func (o SystemParameterRuleResponseOutput) ToSystemParameterRuleResponseOutput() SystemParameterRuleResponseOutput

func (SystemParameterRuleResponseOutput) ToSystemParameterRuleResponseOutputWithContext

func (o SystemParameterRuleResponseOutput) ToSystemParameterRuleResponseOutputWithContext(ctx context.Context) SystemParameterRuleResponseOutput

type SystemParameters

type SystemParameters struct {
	// Define system parameters. The parameters defined here will override the default parameters implemented by the system. If this field is missing from the service config, default system parameters will be used. Default system parameters and names is implementation-dependent. Example: define api key for all methods system_parameters rules: - selector: "*" parameters: - name: api_key url_query_parameter: api_key Example: define 2 api key names for a specific method. system_parameters rules: - selector: "/ListShelves" parameters: - name: api_key http_header: Api-Key1 - name: api_key http_header: Api-Key2 **NOTE:** All service configuration rules follow "last one wins" order.
	Rules []SystemParameterRule `pulumi:"rules"`
}

### System parameter configuration A system parameter is a special kind of parameter defined by the API system, not by an individual API. It is typically mapped to an HTTP header and/or a URL query parameter. This configuration specifies which methods change the names of the system parameters.

type SystemParametersArgs

type SystemParametersArgs struct {
	// Define system parameters. The parameters defined here will override the default parameters implemented by the system. If this field is missing from the service config, default system parameters will be used. Default system parameters and names is implementation-dependent. Example: define api key for all methods system_parameters rules: - selector: "*" parameters: - name: api_key url_query_parameter: api_key Example: define 2 api key names for a specific method. system_parameters rules: - selector: "/ListShelves" parameters: - name: api_key http_header: Api-Key1 - name: api_key http_header: Api-Key2 **NOTE:** All service configuration rules follow "last one wins" order.
	Rules SystemParameterRuleArrayInput `pulumi:"rules"`
}

### System parameter configuration A system parameter is a special kind of parameter defined by the API system, not by an individual API. It is typically mapped to an HTTP header and/or a URL query parameter. This configuration specifies which methods change the names of the system parameters.

func (SystemParametersArgs) ElementType

func (SystemParametersArgs) ElementType() reflect.Type

func (SystemParametersArgs) ToSystemParametersOutput

func (i SystemParametersArgs) ToSystemParametersOutput() SystemParametersOutput

func (SystemParametersArgs) ToSystemParametersOutputWithContext

func (i SystemParametersArgs) ToSystemParametersOutputWithContext(ctx context.Context) SystemParametersOutput

func (SystemParametersArgs) ToSystemParametersPtrOutput

func (i SystemParametersArgs) ToSystemParametersPtrOutput() SystemParametersPtrOutput

func (SystemParametersArgs) ToSystemParametersPtrOutputWithContext

func (i SystemParametersArgs) ToSystemParametersPtrOutputWithContext(ctx context.Context) SystemParametersPtrOutput

type SystemParametersInput

type SystemParametersInput interface {
	pulumi.Input

	ToSystemParametersOutput() SystemParametersOutput
	ToSystemParametersOutputWithContext(context.Context) SystemParametersOutput
}

SystemParametersInput is an input type that accepts SystemParametersArgs and SystemParametersOutput values. You can construct a concrete instance of `SystemParametersInput` via:

SystemParametersArgs{...}

type SystemParametersOutput

type SystemParametersOutput struct{ *pulumi.OutputState }

### System parameter configuration A system parameter is a special kind of parameter defined by the API system, not by an individual API. It is typically mapped to an HTTP header and/or a URL query parameter. This configuration specifies which methods change the names of the system parameters.

func (SystemParametersOutput) ElementType

func (SystemParametersOutput) ElementType() reflect.Type

func (SystemParametersOutput) Rules

Define system parameters. The parameters defined here will override the default parameters implemented by the system. If this field is missing from the service config, default system parameters will be used. Default system parameters and names is implementation-dependent. Example: define api key for all methods system_parameters rules: - selector: "*" parameters: - name: api_key url_query_parameter: api_key Example: define 2 api key names for a specific method. system_parameters rules: - selector: "/ListShelves" parameters: - name: api_key http_header: Api-Key1 - name: api_key http_header: Api-Key2 **NOTE:** All service configuration rules follow "last one wins" order.

func (SystemParametersOutput) ToSystemParametersOutput

func (o SystemParametersOutput) ToSystemParametersOutput() SystemParametersOutput

func (SystemParametersOutput) ToSystemParametersOutputWithContext

func (o SystemParametersOutput) ToSystemParametersOutputWithContext(ctx context.Context) SystemParametersOutput

func (SystemParametersOutput) ToSystemParametersPtrOutput

func (o SystemParametersOutput) ToSystemParametersPtrOutput() SystemParametersPtrOutput

func (SystemParametersOutput) ToSystemParametersPtrOutputWithContext

func (o SystemParametersOutput) ToSystemParametersPtrOutputWithContext(ctx context.Context) SystemParametersPtrOutput

type SystemParametersPtrInput

type SystemParametersPtrInput interface {
	pulumi.Input

	ToSystemParametersPtrOutput() SystemParametersPtrOutput
	ToSystemParametersPtrOutputWithContext(context.Context) SystemParametersPtrOutput
}

SystemParametersPtrInput is an input type that accepts SystemParametersArgs, SystemParametersPtr and SystemParametersPtrOutput values. You can construct a concrete instance of `SystemParametersPtrInput` via:

        SystemParametersArgs{...}

or:

        nil

type SystemParametersPtrOutput

type SystemParametersPtrOutput struct{ *pulumi.OutputState }

func (SystemParametersPtrOutput) Elem

func (SystemParametersPtrOutput) ElementType

func (SystemParametersPtrOutput) ElementType() reflect.Type

func (SystemParametersPtrOutput) Rules

Define system parameters. The parameters defined here will override the default parameters implemented by the system. If this field is missing from the service config, default system parameters will be used. Default system parameters and names is implementation-dependent. Example: define api key for all methods system_parameters rules: - selector: "*" parameters: - name: api_key url_query_parameter: api_key Example: define 2 api key names for a specific method. system_parameters rules: - selector: "/ListShelves" parameters: - name: api_key http_header: Api-Key1 - name: api_key http_header: Api-Key2 **NOTE:** All service configuration rules follow "last one wins" order.

func (SystemParametersPtrOutput) ToSystemParametersPtrOutput

func (o SystemParametersPtrOutput) ToSystemParametersPtrOutput() SystemParametersPtrOutput

func (SystemParametersPtrOutput) ToSystemParametersPtrOutputWithContext

func (o SystemParametersPtrOutput) ToSystemParametersPtrOutputWithContext(ctx context.Context) SystemParametersPtrOutput

type SystemParametersResponse

type SystemParametersResponse struct {
	// Define system parameters. The parameters defined here will override the default parameters implemented by the system. If this field is missing from the service config, default system parameters will be used. Default system parameters and names is implementation-dependent. Example: define api key for all methods system_parameters rules: - selector: "*" parameters: - name: api_key url_query_parameter: api_key Example: define 2 api key names for a specific method. system_parameters rules: - selector: "/ListShelves" parameters: - name: api_key http_header: Api-Key1 - name: api_key http_header: Api-Key2 **NOTE:** All service configuration rules follow "last one wins" order.
	Rules []SystemParameterRuleResponse `pulumi:"rules"`
}

### System parameter configuration A system parameter is a special kind of parameter defined by the API system, not by an individual API. It is typically mapped to an HTTP header and/or a URL query parameter. This configuration specifies which methods change the names of the system parameters.

type SystemParametersResponseOutput

type SystemParametersResponseOutput struct{ *pulumi.OutputState }

### System parameter configuration A system parameter is a special kind of parameter defined by the API system, not by an individual API. It is typically mapped to an HTTP header and/or a URL query parameter. This configuration specifies which methods change the names of the system parameters.

func (SystemParametersResponseOutput) ElementType

func (SystemParametersResponseOutput) Rules

Define system parameters. The parameters defined here will override the default parameters implemented by the system. If this field is missing from the service config, default system parameters will be used. Default system parameters and names is implementation-dependent. Example: define api key for all methods system_parameters rules: - selector: "*" parameters: - name: api_key url_query_parameter: api_key Example: define 2 api key names for a specific method. system_parameters rules: - selector: "/ListShelves" parameters: - name: api_key http_header: Api-Key1 - name: api_key http_header: Api-Key2 **NOTE:** All service configuration rules follow "last one wins" order.

func (SystemParametersResponseOutput) ToSystemParametersResponseOutput

func (o SystemParametersResponseOutput) ToSystemParametersResponseOutput() SystemParametersResponseOutput

func (SystemParametersResponseOutput) ToSystemParametersResponseOutputWithContext

func (o SystemParametersResponseOutput) ToSystemParametersResponseOutputWithContext(ctx context.Context) SystemParametersResponseOutput

type TrafficPercentStrategy

type TrafficPercentStrategy struct {
	// Maps service configuration IDs to their corresponding traffic percentage. Key is the service configuration ID, Value is the traffic percentage which must be greater than 0.0 and the sum must equal to 100.0.
	Percentages map[string]string `pulumi:"percentages"`
}

Strategy that specifies how clients of Google Service Controller want to send traffic to use different config versions. This is generally used by API proxy to split traffic based on your configured percentage for each config version. One example of how to gradually rollout a new service configuration using this strategy: Day 1 Rollout { id: "example.googleapis.com/rollout_20160206" traffic_percent_strategy { percentages: { "example.googleapis.com/20160201": 70.00 "example.googleapis.com/20160206": 30.00 } } } Day 2 Rollout { id: "example.googleapis.com/rollout_20160207" traffic_percent_strategy: { percentages: { "example.googleapis.com/20160206": 100.00 } } }

type TrafficPercentStrategyArgs

type TrafficPercentStrategyArgs struct {
	// Maps service configuration IDs to their corresponding traffic percentage. Key is the service configuration ID, Value is the traffic percentage which must be greater than 0.0 and the sum must equal to 100.0.
	Percentages pulumi.StringMapInput `pulumi:"percentages"`
}

Strategy that specifies how clients of Google Service Controller want to send traffic to use different config versions. This is generally used by API proxy to split traffic based on your configured percentage for each config version. One example of how to gradually rollout a new service configuration using this strategy: Day 1 Rollout { id: "example.googleapis.com/rollout_20160206" traffic_percent_strategy { percentages: { "example.googleapis.com/20160201": 70.00 "example.googleapis.com/20160206": 30.00 } } } Day 2 Rollout { id: "example.googleapis.com/rollout_20160207" traffic_percent_strategy: { percentages: { "example.googleapis.com/20160206": 100.00 } } }

func (TrafficPercentStrategyArgs) ElementType

func (TrafficPercentStrategyArgs) ElementType() reflect.Type

func (TrafficPercentStrategyArgs) ToTrafficPercentStrategyOutput

func (i TrafficPercentStrategyArgs) ToTrafficPercentStrategyOutput() TrafficPercentStrategyOutput

func (TrafficPercentStrategyArgs) ToTrafficPercentStrategyOutputWithContext

func (i TrafficPercentStrategyArgs) ToTrafficPercentStrategyOutputWithContext(ctx context.Context) TrafficPercentStrategyOutput

func (TrafficPercentStrategyArgs) ToTrafficPercentStrategyPtrOutput

func (i TrafficPercentStrategyArgs) ToTrafficPercentStrategyPtrOutput() TrafficPercentStrategyPtrOutput

func (TrafficPercentStrategyArgs) ToTrafficPercentStrategyPtrOutputWithContext

func (i TrafficPercentStrategyArgs) ToTrafficPercentStrategyPtrOutputWithContext(ctx context.Context) TrafficPercentStrategyPtrOutput

type TrafficPercentStrategyInput

type TrafficPercentStrategyInput interface {
	pulumi.Input

	ToTrafficPercentStrategyOutput() TrafficPercentStrategyOutput
	ToTrafficPercentStrategyOutputWithContext(context.Context) TrafficPercentStrategyOutput
}

TrafficPercentStrategyInput is an input type that accepts TrafficPercentStrategyArgs and TrafficPercentStrategyOutput values. You can construct a concrete instance of `TrafficPercentStrategyInput` via:

TrafficPercentStrategyArgs{...}

type TrafficPercentStrategyOutput

type TrafficPercentStrategyOutput struct{ *pulumi.OutputState }

Strategy that specifies how clients of Google Service Controller want to send traffic to use different config versions. This is generally used by API proxy to split traffic based on your configured percentage for each config version. One example of how to gradually rollout a new service configuration using this strategy: Day 1 Rollout { id: "example.googleapis.com/rollout_20160206" traffic_percent_strategy { percentages: { "example.googleapis.com/20160201": 70.00 "example.googleapis.com/20160206": 30.00 } } } Day 2 Rollout { id: "example.googleapis.com/rollout_20160207" traffic_percent_strategy: { percentages: { "example.googleapis.com/20160206": 100.00 } } }

func (TrafficPercentStrategyOutput) ElementType

func (TrafficPercentStrategyOutput) Percentages

Maps service configuration IDs to their corresponding traffic percentage. Key is the service configuration ID, Value is the traffic percentage which must be greater than 0.0 and the sum must equal to 100.0.

func (TrafficPercentStrategyOutput) ToTrafficPercentStrategyOutput

func (o TrafficPercentStrategyOutput) ToTrafficPercentStrategyOutput() TrafficPercentStrategyOutput

func (TrafficPercentStrategyOutput) ToTrafficPercentStrategyOutputWithContext

func (o TrafficPercentStrategyOutput) ToTrafficPercentStrategyOutputWithContext(ctx context.Context) TrafficPercentStrategyOutput

func (TrafficPercentStrategyOutput) ToTrafficPercentStrategyPtrOutput

func (o TrafficPercentStrategyOutput) ToTrafficPercentStrategyPtrOutput() TrafficPercentStrategyPtrOutput

func (TrafficPercentStrategyOutput) ToTrafficPercentStrategyPtrOutputWithContext

func (o TrafficPercentStrategyOutput) ToTrafficPercentStrategyPtrOutputWithContext(ctx context.Context) TrafficPercentStrategyPtrOutput

type TrafficPercentStrategyPtrInput

type TrafficPercentStrategyPtrInput interface {
	pulumi.Input

	ToTrafficPercentStrategyPtrOutput() TrafficPercentStrategyPtrOutput
	ToTrafficPercentStrategyPtrOutputWithContext(context.Context) TrafficPercentStrategyPtrOutput
}

TrafficPercentStrategyPtrInput is an input type that accepts TrafficPercentStrategyArgs, TrafficPercentStrategyPtr and TrafficPercentStrategyPtrOutput values. You can construct a concrete instance of `TrafficPercentStrategyPtrInput` via:

        TrafficPercentStrategyArgs{...}

or:

        nil

type TrafficPercentStrategyPtrOutput

type TrafficPercentStrategyPtrOutput struct{ *pulumi.OutputState }

func (TrafficPercentStrategyPtrOutput) Elem

func (TrafficPercentStrategyPtrOutput) ElementType

func (TrafficPercentStrategyPtrOutput) Percentages

Maps service configuration IDs to their corresponding traffic percentage. Key is the service configuration ID, Value is the traffic percentage which must be greater than 0.0 and the sum must equal to 100.0.

func (TrafficPercentStrategyPtrOutput) ToTrafficPercentStrategyPtrOutput

func (o TrafficPercentStrategyPtrOutput) ToTrafficPercentStrategyPtrOutput() TrafficPercentStrategyPtrOutput

func (TrafficPercentStrategyPtrOutput) ToTrafficPercentStrategyPtrOutputWithContext

func (o TrafficPercentStrategyPtrOutput) ToTrafficPercentStrategyPtrOutputWithContext(ctx context.Context) TrafficPercentStrategyPtrOutput

type TrafficPercentStrategyResponse

type TrafficPercentStrategyResponse struct {
	// Maps service configuration IDs to their corresponding traffic percentage. Key is the service configuration ID, Value is the traffic percentage which must be greater than 0.0 and the sum must equal to 100.0.
	Percentages map[string]string `pulumi:"percentages"`
}

Strategy that specifies how clients of Google Service Controller want to send traffic to use different config versions. This is generally used by API proxy to split traffic based on your configured percentage for each config version. One example of how to gradually rollout a new service configuration using this strategy: Day 1 Rollout { id: "example.googleapis.com/rollout_20160206" traffic_percent_strategy { percentages: { "example.googleapis.com/20160201": 70.00 "example.googleapis.com/20160206": 30.00 } } } Day 2 Rollout { id: "example.googleapis.com/rollout_20160207" traffic_percent_strategy: { percentages: { "example.googleapis.com/20160206": 100.00 } } }

type TrafficPercentStrategyResponseOutput

type TrafficPercentStrategyResponseOutput struct{ *pulumi.OutputState }

Strategy that specifies how clients of Google Service Controller want to send traffic to use different config versions. This is generally used by API proxy to split traffic based on your configured percentage for each config version. One example of how to gradually rollout a new service configuration using this strategy: Day 1 Rollout { id: "example.googleapis.com/rollout_20160206" traffic_percent_strategy { percentages: { "example.googleapis.com/20160201": 70.00 "example.googleapis.com/20160206": 30.00 } } } Day 2 Rollout { id: "example.googleapis.com/rollout_20160207" traffic_percent_strategy: { percentages: { "example.googleapis.com/20160206": 100.00 } } }

func (TrafficPercentStrategyResponseOutput) ElementType

func (TrafficPercentStrategyResponseOutput) Percentages

Maps service configuration IDs to their corresponding traffic percentage. Key is the service configuration ID, Value is the traffic percentage which must be greater than 0.0 and the sum must equal to 100.0.

func (TrafficPercentStrategyResponseOutput) ToTrafficPercentStrategyResponseOutput

func (o TrafficPercentStrategyResponseOutput) ToTrafficPercentStrategyResponseOutput() TrafficPercentStrategyResponseOutput

func (TrafficPercentStrategyResponseOutput) ToTrafficPercentStrategyResponseOutputWithContext

func (o TrafficPercentStrategyResponseOutput) ToTrafficPercentStrategyResponseOutputWithContext(ctx context.Context) TrafficPercentStrategyResponseOutput

type Type

type Type struct {
	// The source edition string, only valid when syntax is SYNTAX_EDITIONS.
	Edition *string `pulumi:"edition"`
	// The list of fields.
	Fields []Field `pulumi:"fields"`
	// The fully qualified message name.
	Name *string `pulumi:"name"`
	// The list of types appearing in `oneof` definitions in this type.
	Oneofs []string `pulumi:"oneofs"`
	// The protocol buffer options.
	Options []Option `pulumi:"options"`
	// The source context.
	SourceContext *SourceContext `pulumi:"sourceContext"`
	// The source syntax.
	Syntax *TypeSyntax `pulumi:"syntax"`
}

A protocol buffer message type.

type TypeArgs

type TypeArgs struct {
	// The source edition string, only valid when syntax is SYNTAX_EDITIONS.
	Edition pulumi.StringPtrInput `pulumi:"edition"`
	// The list of fields.
	Fields FieldArrayInput `pulumi:"fields"`
	// The fully qualified message name.
	Name pulumi.StringPtrInput `pulumi:"name"`
	// The list of types appearing in `oneof` definitions in this type.
	Oneofs pulumi.StringArrayInput `pulumi:"oneofs"`
	// The protocol buffer options.
	Options OptionArrayInput `pulumi:"options"`
	// The source context.
	SourceContext SourceContextPtrInput `pulumi:"sourceContext"`
	// The source syntax.
	Syntax TypeSyntaxPtrInput `pulumi:"syntax"`
}

A protocol buffer message type.

func (TypeArgs) ElementType

func (TypeArgs) ElementType() reflect.Type

func (TypeArgs) ToTypeOutput

func (i TypeArgs) ToTypeOutput() TypeOutput

func (TypeArgs) ToTypeOutputWithContext

func (i TypeArgs) ToTypeOutputWithContext(ctx context.Context) TypeOutput

type TypeArray

type TypeArray []TypeInput

func (TypeArray) ElementType

func (TypeArray) ElementType() reflect.Type

func (TypeArray) ToTypeArrayOutput

func (i TypeArray) ToTypeArrayOutput() TypeArrayOutput

func (TypeArray) ToTypeArrayOutputWithContext

func (i TypeArray) ToTypeArrayOutputWithContext(ctx context.Context) TypeArrayOutput

type TypeArrayInput

type TypeArrayInput interface {
	pulumi.Input

	ToTypeArrayOutput() TypeArrayOutput
	ToTypeArrayOutputWithContext(context.Context) TypeArrayOutput
}

TypeArrayInput is an input type that accepts TypeArray and TypeArrayOutput values. You can construct a concrete instance of `TypeArrayInput` via:

TypeArray{ TypeArgs{...} }

type TypeArrayOutput

type TypeArrayOutput struct{ *pulumi.OutputState }

func (TypeArrayOutput) ElementType

func (TypeArrayOutput) ElementType() reflect.Type

func (TypeArrayOutput) Index

func (TypeArrayOutput) ToTypeArrayOutput

func (o TypeArrayOutput) ToTypeArrayOutput() TypeArrayOutput

func (TypeArrayOutput) ToTypeArrayOutputWithContext

func (o TypeArrayOutput) ToTypeArrayOutputWithContext(ctx context.Context) TypeArrayOutput

type TypeInput

type TypeInput interface {
	pulumi.Input

	ToTypeOutput() TypeOutput
	ToTypeOutputWithContext(context.Context) TypeOutput
}

TypeInput is an input type that accepts TypeArgs and TypeOutput values. You can construct a concrete instance of `TypeInput` via:

TypeArgs{...}

type TypeOutput

type TypeOutput struct{ *pulumi.OutputState }

A protocol buffer message type.

func (TypeOutput) Edition added in v0.29.0

func (o TypeOutput) Edition() pulumi.StringPtrOutput

The source edition string, only valid when syntax is SYNTAX_EDITIONS.

func (TypeOutput) ElementType

func (TypeOutput) ElementType() reflect.Type

func (TypeOutput) Fields

func (o TypeOutput) Fields() FieldArrayOutput

The list of fields.

func (TypeOutput) Name

The fully qualified message name.

func (TypeOutput) Oneofs

func (o TypeOutput) Oneofs() pulumi.StringArrayOutput

The list of types appearing in `oneof` definitions in this type.

func (TypeOutput) Options

func (o TypeOutput) Options() OptionArrayOutput

The protocol buffer options.

func (TypeOutput) SourceContext

func (o TypeOutput) SourceContext() SourceContextPtrOutput

The source context.

func (TypeOutput) Syntax

func (o TypeOutput) Syntax() TypeSyntaxPtrOutput

The source syntax.

func (TypeOutput) ToTypeOutput

func (o TypeOutput) ToTypeOutput() TypeOutput

func (TypeOutput) ToTypeOutputWithContext

func (o TypeOutput) ToTypeOutputWithContext(ctx context.Context) TypeOutput

type TypeResponse

type TypeResponse struct {
	// The source edition string, only valid when syntax is SYNTAX_EDITIONS.
	Edition string `pulumi:"edition"`
	// The list of fields.
	Fields []FieldResponse `pulumi:"fields"`
	// The fully qualified message name.
	Name string `pulumi:"name"`
	// The list of types appearing in `oneof` definitions in this type.
	Oneofs []string `pulumi:"oneofs"`
	// The protocol buffer options.
	Options []OptionResponse `pulumi:"options"`
	// The source context.
	SourceContext SourceContextResponse `pulumi:"sourceContext"`
	// The source syntax.
	Syntax string `pulumi:"syntax"`
}

A protocol buffer message type.

type TypeResponseArrayOutput

type TypeResponseArrayOutput struct{ *pulumi.OutputState }

func (TypeResponseArrayOutput) ElementType

func (TypeResponseArrayOutput) ElementType() reflect.Type

func (TypeResponseArrayOutput) Index

func (TypeResponseArrayOutput) ToTypeResponseArrayOutput

func (o TypeResponseArrayOutput) ToTypeResponseArrayOutput() TypeResponseArrayOutput

func (TypeResponseArrayOutput) ToTypeResponseArrayOutputWithContext

func (o TypeResponseArrayOutput) ToTypeResponseArrayOutputWithContext(ctx context.Context) TypeResponseArrayOutput

type TypeResponseOutput

type TypeResponseOutput struct{ *pulumi.OutputState }

A protocol buffer message type.

func (TypeResponseOutput) Edition added in v0.29.0

The source edition string, only valid when syntax is SYNTAX_EDITIONS.

func (TypeResponseOutput) ElementType

func (TypeResponseOutput) ElementType() reflect.Type

func (TypeResponseOutput) Fields

The list of fields.

func (TypeResponseOutput) Name

The fully qualified message name.

func (TypeResponseOutput) Oneofs

The list of types appearing in `oneof` definitions in this type.

func (TypeResponseOutput) Options

The protocol buffer options.

func (TypeResponseOutput) SourceContext

The source context.

func (TypeResponseOutput) Syntax

The source syntax.

func (TypeResponseOutput) ToTypeResponseOutput

func (o TypeResponseOutput) ToTypeResponseOutput() TypeResponseOutput

func (TypeResponseOutput) ToTypeResponseOutputWithContext

func (o TypeResponseOutput) ToTypeResponseOutputWithContext(ctx context.Context) TypeResponseOutput

type TypeSyntax added in v0.4.0

type TypeSyntax string

The source syntax.

func (TypeSyntax) ElementType added in v0.4.0

func (TypeSyntax) ElementType() reflect.Type

func (TypeSyntax) ToStringOutput added in v0.4.0

func (e TypeSyntax) ToStringOutput() pulumi.StringOutput

func (TypeSyntax) ToStringOutputWithContext added in v0.4.0

func (e TypeSyntax) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (TypeSyntax) ToStringPtrOutput added in v0.4.0

func (e TypeSyntax) ToStringPtrOutput() pulumi.StringPtrOutput

func (TypeSyntax) ToStringPtrOutputWithContext added in v0.4.0

func (e TypeSyntax) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

func (TypeSyntax) ToTypeSyntaxOutput added in v0.6.0

func (e TypeSyntax) ToTypeSyntaxOutput() TypeSyntaxOutput

func (TypeSyntax) ToTypeSyntaxOutputWithContext added in v0.6.0

func (e TypeSyntax) ToTypeSyntaxOutputWithContext(ctx context.Context) TypeSyntaxOutput

func (TypeSyntax) ToTypeSyntaxPtrOutput added in v0.6.0

func (e TypeSyntax) ToTypeSyntaxPtrOutput() TypeSyntaxPtrOutput

func (TypeSyntax) ToTypeSyntaxPtrOutputWithContext added in v0.6.0

func (e TypeSyntax) ToTypeSyntaxPtrOutputWithContext(ctx context.Context) TypeSyntaxPtrOutput

type TypeSyntaxInput added in v0.6.0

type TypeSyntaxInput interface {
	pulumi.Input

	ToTypeSyntaxOutput() TypeSyntaxOutput
	ToTypeSyntaxOutputWithContext(context.Context) TypeSyntaxOutput
}

TypeSyntaxInput is an input type that accepts TypeSyntaxArgs and TypeSyntaxOutput values. You can construct a concrete instance of `TypeSyntaxInput` via:

TypeSyntaxArgs{...}

type TypeSyntaxOutput added in v0.6.0

type TypeSyntaxOutput struct{ *pulumi.OutputState }

func (TypeSyntaxOutput) ElementType added in v0.6.0

func (TypeSyntaxOutput) ElementType() reflect.Type

func (TypeSyntaxOutput) ToStringOutput added in v0.6.0

func (o TypeSyntaxOutput) ToStringOutput() pulumi.StringOutput

func (TypeSyntaxOutput) ToStringOutputWithContext added in v0.6.0

func (o TypeSyntaxOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (TypeSyntaxOutput) ToStringPtrOutput added in v0.6.0

func (o TypeSyntaxOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (TypeSyntaxOutput) ToStringPtrOutputWithContext added in v0.6.0

func (o TypeSyntaxOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

func (TypeSyntaxOutput) ToTypeSyntaxOutput added in v0.6.0

func (o TypeSyntaxOutput) ToTypeSyntaxOutput() TypeSyntaxOutput

func (TypeSyntaxOutput) ToTypeSyntaxOutputWithContext added in v0.6.0

func (o TypeSyntaxOutput) ToTypeSyntaxOutputWithContext(ctx context.Context) TypeSyntaxOutput

func (TypeSyntaxOutput) ToTypeSyntaxPtrOutput added in v0.6.0

func (o TypeSyntaxOutput) ToTypeSyntaxPtrOutput() TypeSyntaxPtrOutput

func (TypeSyntaxOutput) ToTypeSyntaxPtrOutputWithContext added in v0.6.0

func (o TypeSyntaxOutput) ToTypeSyntaxPtrOutputWithContext(ctx context.Context) TypeSyntaxPtrOutput

type TypeSyntaxPtrInput added in v0.6.0

type TypeSyntaxPtrInput interface {
	pulumi.Input

	ToTypeSyntaxPtrOutput() TypeSyntaxPtrOutput
	ToTypeSyntaxPtrOutputWithContext(context.Context) TypeSyntaxPtrOutput
}

func TypeSyntaxPtr added in v0.6.0

func TypeSyntaxPtr(v string) TypeSyntaxPtrInput

type TypeSyntaxPtrOutput added in v0.6.0

type TypeSyntaxPtrOutput struct{ *pulumi.OutputState }

func (TypeSyntaxPtrOutput) Elem added in v0.6.0

func (TypeSyntaxPtrOutput) ElementType added in v0.6.0

func (TypeSyntaxPtrOutput) ElementType() reflect.Type

func (TypeSyntaxPtrOutput) ToStringPtrOutput added in v0.6.0

func (o TypeSyntaxPtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (TypeSyntaxPtrOutput) ToStringPtrOutputWithContext added in v0.6.0

func (o TypeSyntaxPtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

func (TypeSyntaxPtrOutput) ToTypeSyntaxPtrOutput added in v0.6.0

func (o TypeSyntaxPtrOutput) ToTypeSyntaxPtrOutput() TypeSyntaxPtrOutput

func (TypeSyntaxPtrOutput) ToTypeSyntaxPtrOutputWithContext added in v0.6.0

func (o TypeSyntaxPtrOutput) ToTypeSyntaxPtrOutputWithContext(ctx context.Context) TypeSyntaxPtrOutput

type Usage

type Usage struct {
	// The full resource name of a channel used for sending notifications to the service producer. Google Service Management currently only supports [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification channel. To use Google Cloud Pub/Sub as the channel, this must be the name of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format documented in https://cloud.google.com/pubsub/docs/overview.
	ProducerNotificationChannel *string `pulumi:"producerNotificationChannel"`
	// Requirements that must be satisfied before a consumer project can use the service. Each requirement is of the form /; for example 'serviceusage.googleapis.com/billing-enabled'. For Google APIs, a Terms of Service requirement must be included here. Google Cloud APIs must include "serviceusage.googleapis.com/tos/cloud". Other Google APIs should include "serviceusage.googleapis.com/tos/universal". Additional ToS can be included based on the business needs.
	Requirements []string `pulumi:"requirements"`
	// A list of usage rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order.
	Rules []UsageRule `pulumi:"rules"`
}

Configuration controlling usage of a service.

type UsageArgs

type UsageArgs struct {
	// The full resource name of a channel used for sending notifications to the service producer. Google Service Management currently only supports [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification channel. To use Google Cloud Pub/Sub as the channel, this must be the name of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format documented in https://cloud.google.com/pubsub/docs/overview.
	ProducerNotificationChannel pulumi.StringPtrInput `pulumi:"producerNotificationChannel"`
	// Requirements that must be satisfied before a consumer project can use the service. Each requirement is of the form /; for example 'serviceusage.googleapis.com/billing-enabled'. For Google APIs, a Terms of Service requirement must be included here. Google Cloud APIs must include "serviceusage.googleapis.com/tos/cloud". Other Google APIs should include "serviceusage.googleapis.com/tos/universal". Additional ToS can be included based on the business needs.
	Requirements pulumi.StringArrayInput `pulumi:"requirements"`
	// A list of usage rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order.
	Rules UsageRuleArrayInput `pulumi:"rules"`
}

Configuration controlling usage of a service.

func (UsageArgs) ElementType

func (UsageArgs) ElementType() reflect.Type

func (UsageArgs) ToUsageOutput

func (i UsageArgs) ToUsageOutput() UsageOutput

func (UsageArgs) ToUsageOutputWithContext

func (i UsageArgs) ToUsageOutputWithContext(ctx context.Context) UsageOutput

func (UsageArgs) ToUsagePtrOutput

func (i UsageArgs) ToUsagePtrOutput() UsagePtrOutput

func (UsageArgs) ToUsagePtrOutputWithContext

func (i UsageArgs) ToUsagePtrOutputWithContext(ctx context.Context) UsagePtrOutput

type UsageInput

type UsageInput interface {
	pulumi.Input

	ToUsageOutput() UsageOutput
	ToUsageOutputWithContext(context.Context) UsageOutput
}

UsageInput is an input type that accepts UsageArgs and UsageOutput values. You can construct a concrete instance of `UsageInput` via:

UsageArgs{...}

type UsageOutput

type UsageOutput struct{ *pulumi.OutputState }

Configuration controlling usage of a service.

func (UsageOutput) ElementType

func (UsageOutput) ElementType() reflect.Type

func (UsageOutput) ProducerNotificationChannel

func (o UsageOutput) ProducerNotificationChannel() pulumi.StringPtrOutput

The full resource name of a channel used for sending notifications to the service producer. Google Service Management currently only supports [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification channel. To use Google Cloud Pub/Sub as the channel, this must be the name of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format documented in https://cloud.google.com/pubsub/docs/overview.

func (UsageOutput) Requirements

func (o UsageOutput) Requirements() pulumi.StringArrayOutput

Requirements that must be satisfied before a consumer project can use the service. Each requirement is of the form /; for example 'serviceusage.googleapis.com/billing-enabled'. For Google APIs, a Terms of Service requirement must be included here. Google Cloud APIs must include "serviceusage.googleapis.com/tos/cloud". Other Google APIs should include "serviceusage.googleapis.com/tos/universal". Additional ToS can be included based on the business needs.

func (UsageOutput) Rules

A list of usage rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order.

func (UsageOutput) ToUsageOutput

func (o UsageOutput) ToUsageOutput() UsageOutput

func (UsageOutput) ToUsageOutputWithContext

func (o UsageOutput) ToUsageOutputWithContext(ctx context.Context) UsageOutput

func (UsageOutput) ToUsagePtrOutput

func (o UsageOutput) ToUsagePtrOutput() UsagePtrOutput

func (UsageOutput) ToUsagePtrOutputWithContext

func (o UsageOutput) ToUsagePtrOutputWithContext(ctx context.Context) UsagePtrOutput

type UsagePtrInput

type UsagePtrInput interface {
	pulumi.Input

	ToUsagePtrOutput() UsagePtrOutput
	ToUsagePtrOutputWithContext(context.Context) UsagePtrOutput
}

UsagePtrInput is an input type that accepts UsageArgs, UsagePtr and UsagePtrOutput values. You can construct a concrete instance of `UsagePtrInput` via:

        UsageArgs{...}

or:

        nil

func UsagePtr

func UsagePtr(v *UsageArgs) UsagePtrInput

type UsagePtrOutput

type UsagePtrOutput struct{ *pulumi.OutputState }

func (UsagePtrOutput) Elem

func (o UsagePtrOutput) Elem() UsageOutput

func (UsagePtrOutput) ElementType

func (UsagePtrOutput) ElementType() reflect.Type

func (UsagePtrOutput) ProducerNotificationChannel

func (o UsagePtrOutput) ProducerNotificationChannel() pulumi.StringPtrOutput

The full resource name of a channel used for sending notifications to the service producer. Google Service Management currently only supports [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification channel. To use Google Cloud Pub/Sub as the channel, this must be the name of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format documented in https://cloud.google.com/pubsub/docs/overview.

func (UsagePtrOutput) Requirements

func (o UsagePtrOutput) Requirements() pulumi.StringArrayOutput

Requirements that must be satisfied before a consumer project can use the service. Each requirement is of the form /; for example 'serviceusage.googleapis.com/billing-enabled'. For Google APIs, a Terms of Service requirement must be included here. Google Cloud APIs must include "serviceusage.googleapis.com/tos/cloud". Other Google APIs should include "serviceusage.googleapis.com/tos/universal". Additional ToS can be included based on the business needs.

func (UsagePtrOutput) Rules

A list of usage rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order.

func (UsagePtrOutput) ToUsagePtrOutput

func (o UsagePtrOutput) ToUsagePtrOutput() UsagePtrOutput

func (UsagePtrOutput) ToUsagePtrOutputWithContext

func (o UsagePtrOutput) ToUsagePtrOutputWithContext(ctx context.Context) UsagePtrOutput

type UsageResponse

type UsageResponse struct {
	// The full resource name of a channel used for sending notifications to the service producer. Google Service Management currently only supports [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification channel. To use Google Cloud Pub/Sub as the channel, this must be the name of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format documented in https://cloud.google.com/pubsub/docs/overview.
	ProducerNotificationChannel string `pulumi:"producerNotificationChannel"`
	// Requirements that must be satisfied before a consumer project can use the service. Each requirement is of the form /; for example 'serviceusage.googleapis.com/billing-enabled'. For Google APIs, a Terms of Service requirement must be included here. Google Cloud APIs must include "serviceusage.googleapis.com/tos/cloud". Other Google APIs should include "serviceusage.googleapis.com/tos/universal". Additional ToS can be included based on the business needs.
	Requirements []string `pulumi:"requirements"`
	// A list of usage rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order.
	Rules []UsageRuleResponse `pulumi:"rules"`
}

Configuration controlling usage of a service.

type UsageResponseOutput

type UsageResponseOutput struct{ *pulumi.OutputState }

Configuration controlling usage of a service.

func (UsageResponseOutput) ElementType

func (UsageResponseOutput) ElementType() reflect.Type

func (UsageResponseOutput) ProducerNotificationChannel

func (o UsageResponseOutput) ProducerNotificationChannel() pulumi.StringOutput

The full resource name of a channel used for sending notifications to the service producer. Google Service Management currently only supports [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification channel. To use Google Cloud Pub/Sub as the channel, this must be the name of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format documented in https://cloud.google.com/pubsub/docs/overview.

func (UsageResponseOutput) Requirements

func (o UsageResponseOutput) Requirements() pulumi.StringArrayOutput

Requirements that must be satisfied before a consumer project can use the service. Each requirement is of the form /; for example 'serviceusage.googleapis.com/billing-enabled'. For Google APIs, a Terms of Service requirement must be included here. Google Cloud APIs must include "serviceusage.googleapis.com/tos/cloud". Other Google APIs should include "serviceusage.googleapis.com/tos/universal". Additional ToS can be included based on the business needs.

func (UsageResponseOutput) Rules

A list of usage rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order.

func (UsageResponseOutput) ToUsageResponseOutput

func (o UsageResponseOutput) ToUsageResponseOutput() UsageResponseOutput

func (UsageResponseOutput) ToUsageResponseOutputWithContext

func (o UsageResponseOutput) ToUsageResponseOutputWithContext(ctx context.Context) UsageResponseOutput

type UsageRule

type UsageRule struct {
	// If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application.
	AllowUnregisteredCalls *bool `pulumi:"allowUnregisteredCalls"`
	// Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details.
	Selector *string `pulumi:"selector"`
	// If true, the selected method should skip service control and the control plane features, such as quota and billing, will not be available. This flag is used by Google Cloud Endpoints to bypass checks for internal methods, such as service health check methods.
	SkipServiceControl *bool `pulumi:"skipServiceControl"`
}

Usage configuration rules for the service. NOTE: Under development. Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. Use this rule to allow/disallow unregistered calls. Example of an API that wants to allow unregistered calls for entire service. usage: rules: - selector: "*" allow_unregistered_calls: true Example of a method that wants to allow unregistered calls. usage: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allow_unregistered_calls: true

type UsageRuleArgs

type UsageRuleArgs struct {
	// If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application.
	AllowUnregisteredCalls pulumi.BoolPtrInput `pulumi:"allowUnregisteredCalls"`
	// Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details.
	Selector pulumi.StringPtrInput `pulumi:"selector"`
	// If true, the selected method should skip service control and the control plane features, such as quota and billing, will not be available. This flag is used by Google Cloud Endpoints to bypass checks for internal methods, such as service health check methods.
	SkipServiceControl pulumi.BoolPtrInput `pulumi:"skipServiceControl"`
}

Usage configuration rules for the service. NOTE: Under development. Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. Use this rule to allow/disallow unregistered calls. Example of an API that wants to allow unregistered calls for entire service. usage: rules: - selector: "*" allow_unregistered_calls: true Example of a method that wants to allow unregistered calls. usage: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allow_unregistered_calls: true

func (UsageRuleArgs) ElementType

func (UsageRuleArgs) ElementType() reflect.Type

func (UsageRuleArgs) ToUsageRuleOutput

func (i UsageRuleArgs) ToUsageRuleOutput() UsageRuleOutput

func (UsageRuleArgs) ToUsageRuleOutputWithContext

func (i UsageRuleArgs) ToUsageRuleOutputWithContext(ctx context.Context) UsageRuleOutput

type UsageRuleArray

type UsageRuleArray []UsageRuleInput

func (UsageRuleArray) ElementType

func (UsageRuleArray) ElementType() reflect.Type

func (UsageRuleArray) ToUsageRuleArrayOutput

func (i UsageRuleArray) ToUsageRuleArrayOutput() UsageRuleArrayOutput

func (UsageRuleArray) ToUsageRuleArrayOutputWithContext

func (i UsageRuleArray) ToUsageRuleArrayOutputWithContext(ctx context.Context) UsageRuleArrayOutput

type UsageRuleArrayInput

type UsageRuleArrayInput interface {
	pulumi.Input

	ToUsageRuleArrayOutput() UsageRuleArrayOutput
	ToUsageRuleArrayOutputWithContext(context.Context) UsageRuleArrayOutput
}

UsageRuleArrayInput is an input type that accepts UsageRuleArray and UsageRuleArrayOutput values. You can construct a concrete instance of `UsageRuleArrayInput` via:

UsageRuleArray{ UsageRuleArgs{...} }

type UsageRuleArrayOutput

type UsageRuleArrayOutput struct{ *pulumi.OutputState }

func (UsageRuleArrayOutput) ElementType

func (UsageRuleArrayOutput) ElementType() reflect.Type

func (UsageRuleArrayOutput) Index

func (UsageRuleArrayOutput) ToUsageRuleArrayOutput

func (o UsageRuleArrayOutput) ToUsageRuleArrayOutput() UsageRuleArrayOutput

func (UsageRuleArrayOutput) ToUsageRuleArrayOutputWithContext

func (o UsageRuleArrayOutput) ToUsageRuleArrayOutputWithContext(ctx context.Context) UsageRuleArrayOutput

type UsageRuleInput

type UsageRuleInput interface {
	pulumi.Input

	ToUsageRuleOutput() UsageRuleOutput
	ToUsageRuleOutputWithContext(context.Context) UsageRuleOutput
}

UsageRuleInput is an input type that accepts UsageRuleArgs and UsageRuleOutput values. You can construct a concrete instance of `UsageRuleInput` via:

UsageRuleArgs{...}

type UsageRuleOutput

type UsageRuleOutput struct{ *pulumi.OutputState }

Usage configuration rules for the service. NOTE: Under development. Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. Use this rule to allow/disallow unregistered calls. Example of an API that wants to allow unregistered calls for entire service. usage: rules: - selector: "*" allow_unregistered_calls: true Example of a method that wants to allow unregistered calls. usage: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allow_unregistered_calls: true

func (UsageRuleOutput) AllowUnregisteredCalls

func (o UsageRuleOutput) AllowUnregisteredCalls() pulumi.BoolPtrOutput

If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application.

func (UsageRuleOutput) ElementType

func (UsageRuleOutput) ElementType() reflect.Type

func (UsageRuleOutput) Selector

func (o UsageRuleOutput) Selector() pulumi.StringPtrOutput

Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details.

func (UsageRuleOutput) SkipServiceControl

func (o UsageRuleOutput) SkipServiceControl() pulumi.BoolPtrOutput

If true, the selected method should skip service control and the control plane features, such as quota and billing, will not be available. This flag is used by Google Cloud Endpoints to bypass checks for internal methods, such as service health check methods.

func (UsageRuleOutput) ToUsageRuleOutput

func (o UsageRuleOutput) ToUsageRuleOutput() UsageRuleOutput

func (UsageRuleOutput) ToUsageRuleOutputWithContext

func (o UsageRuleOutput) ToUsageRuleOutputWithContext(ctx context.Context) UsageRuleOutput

type UsageRuleResponse

type UsageRuleResponse struct {
	// If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application.
	AllowUnregisteredCalls bool `pulumi:"allowUnregisteredCalls"`
	// Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details.
	Selector string `pulumi:"selector"`
	// If true, the selected method should skip service control and the control plane features, such as quota and billing, will not be available. This flag is used by Google Cloud Endpoints to bypass checks for internal methods, such as service health check methods.
	SkipServiceControl bool `pulumi:"skipServiceControl"`
}

Usage configuration rules for the service. NOTE: Under development. Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. Use this rule to allow/disallow unregistered calls. Example of an API that wants to allow unregistered calls for entire service. usage: rules: - selector: "*" allow_unregistered_calls: true Example of a method that wants to allow unregistered calls. usage: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allow_unregistered_calls: true

type UsageRuleResponseArrayOutput

type UsageRuleResponseArrayOutput struct{ *pulumi.OutputState }

func (UsageRuleResponseArrayOutput) ElementType

func (UsageRuleResponseArrayOutput) Index

func (UsageRuleResponseArrayOutput) ToUsageRuleResponseArrayOutput

func (o UsageRuleResponseArrayOutput) ToUsageRuleResponseArrayOutput() UsageRuleResponseArrayOutput

func (UsageRuleResponseArrayOutput) ToUsageRuleResponseArrayOutputWithContext

func (o UsageRuleResponseArrayOutput) ToUsageRuleResponseArrayOutputWithContext(ctx context.Context) UsageRuleResponseArrayOutput

type UsageRuleResponseOutput

type UsageRuleResponseOutput struct{ *pulumi.OutputState }

Usage configuration rules for the service. NOTE: Under development. Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. Use this rule to allow/disallow unregistered calls. Example of an API that wants to allow unregistered calls for entire service. usage: rules: - selector: "*" allow_unregistered_calls: true Example of a method that wants to allow unregistered calls. usage: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allow_unregistered_calls: true

func (UsageRuleResponseOutput) AllowUnregisteredCalls

func (o UsageRuleResponseOutput) AllowUnregisteredCalls() pulumi.BoolOutput

If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application.

func (UsageRuleResponseOutput) ElementType

func (UsageRuleResponseOutput) ElementType() reflect.Type

func (UsageRuleResponseOutput) Selector

Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details.

func (UsageRuleResponseOutput) SkipServiceControl

func (o UsageRuleResponseOutput) SkipServiceControl() pulumi.BoolOutput

If true, the selected method should skip service control and the control plane features, such as quota and billing, will not be available. This flag is used by Google Cloud Endpoints to bypass checks for internal methods, such as service health check methods.

func (UsageRuleResponseOutput) ToUsageRuleResponseOutput

func (o UsageRuleResponseOutput) ToUsageRuleResponseOutput() UsageRuleResponseOutput

func (UsageRuleResponseOutput) ToUsageRuleResponseOutputWithContext

func (o UsageRuleResponseOutput) ToUsageRuleResponseOutputWithContext(ctx context.Context) UsageRuleResponseOutput

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL