Show / Hide Table of Contents

Namespace Google.Apis.DeploymentManager.alpha.Data

Classes

AsyncOptions

Async options that determine when a resource should finish.

AuditConfig

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.

AuditLogConfig

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.

BaseType

BaseType that describes a service-backed Type.

BasicAuth

Basic Auth used as a credential.

Binding

Associates members, or principals, with a role.

BulkInsertOperationStatus

CollectionOverride

CollectionOverride allows resource handling overrides for specific resources within a BaseType

CompositeType

Holds the composite type.

CompositeTypeLabelEntry

Label object for CompositeTypes

CompositeTypesListResponse

A response that returns all Composite Types supported by Deployment Manager

ConfigFile

Credential

The credential used by Deployment Manager and TypeProvider. Only one of the options is permitted.

DebugInfo

Describes additional debugging info.

Deployment

DeploymentLabelEntry

Label object for Deployments

DeploymentOutputEntry

Output object for Deployments

DeploymentUpdate

DeploymentUpdateLabelEntry

Label object for DeploymentUpdate

DeploymentsCancelPreviewRequest

DeploymentsListResponse

A response containing a partial list of deployments and a page token used to build the next request if the request has been truncated.

DeploymentsStopRequest

Diagnostic

ErrorInfo

Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }

Expr

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.

GlobalSetPolicyRequest

Help

Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.

HelpLink

Describes a URL link.

ImportFile

InputMapping

InputMapping creates a 'virtual' property that will be injected into the properties before sending the request to the underlying API.

InstancesBulkInsertOperationMetadata

LocalizedMessage

Provides a localized error message that is safe to return to the user which can be attached to an RPC error.

Manifest

ManifestsListResponse

A response containing a partial list of manifests and a page token used to build the next request if the request has been truncated.

MethodMap

Deployment Manager will call these methods during the events of creation/deletion/update/get/setIamPolicy

Operation

Represents an Operation resource. Google Compute Engine has three Operation resources: * Global * Regional * Zonal You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the globalOperations resource. - For regional operations, use the regionOperations resource. - For zonal operations, use the zoneOperations resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period.

Operation.ErrorData

[Output Only] If errors are generated during processing of the operation, this field will be populated.

Operation.ErrorData.ErrorsData

[Output Only] The array of errors encountered while processing this operation.

Operation.ErrorData.ErrorsData.ErrorDetailsData

[Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.

Operation.WarningsData

[Output Only] If warning messages are generated during processing of the operation, this field will be populated.

Operation.WarningsData.DataData

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

OperationsListResponse

A response containing a partial list of operations and a page token used to build the next request if the request has been truncated.

Options

Options allows customized resource handling by Deployment Manager.

Policy

An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation. JSON example:

{
"bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com",
"group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] },
{ "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": {
"title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time
< timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }

YAML example:

bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com -
serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin -
members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable
access description: Does not grant access after Sep 2020 expression: request.time <
timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3

For a description of IAM and its features, see the IAM documentation.

PollingOptions

QuotaExceededInfo

Additional details for quota exceeded error for resource quota.

Resource

Resource.WarningsData

Output only. If warning messages are generated during processing of this resource, this field will be populated.

Resource.WarningsData.DataData

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

ResourceAccessControl

The access controls set on the resource.

ResourceUpdate

ResourceUpdate.ErrorData

Output only. If errors are generated during update of the resource, this field will be populated.

ResourceUpdate.ErrorData.ErrorsData

[Output Only] The array of errors encountered while processing this operation.

ResourceUpdate.ErrorData.ErrorsData.ErrorDetailsData

[Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.

ResourceUpdate.WarningsData

Output only. If warning messages are generated during processing of this resource, this field will be populated.

ResourceUpdate.WarningsData.DataData

[Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

ResourcesListResponse

A response containing a partial list of resources and a page token used to build the next request if the request has been truncated.

ServiceAccount

Service Account used as a credential.

SetAutoscalerLinkOperationMetadata

SetCommonInstanceMetadataOperationMetadata

SetCommonInstanceMetadataOperationMetadataPerLocationOperationInfo

Status

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

TargetConfiguration

TemplateContents

Files that make up the template contents of a template type.

TestPermissionsRequest

TestPermissionsResponse

Type

A resource type supported by Deployment Manager.

TypeInfo

Type Information. Contains detailed information about a composite type, base type, or base type with specific collection.

TypeInfoSchemaInfo

TypeLabelEntry

Label object for Types

TypeProvider

A type provider that describes a service-backed Type.

TypeProviderLabelEntry

Label object for TypeProviders

TypeProvidersListResponse

A response that returns all Type Providers supported by Deployment Manager

TypeProvidersListTypesResponse

TypesListResponse

A response that returns all Types supported by Deployment Manager

ValidationOptions

Options for how to validate and process properties on a resource.

In this article
Back to top Generated by DocFX