API Reference google_api_deployment_manager v0.18.2

API client metadata for GoogleApi.DeploymentManager.V2.

API calls for all endpoints tagged Deployments.

API calls for all endpoints tagged Manifests.

API calls for all endpoints tagged Operations.

API calls for all endpoints tagged Resources.

API calls for all endpoints tagged Types.

Handle Tesla connections for GoogleApi.DeploymentManager.V2.

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.

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.

Associates members, or principals, with a role.

Attributes

• content (type: String.t, default: nil) - The contents of the file.

Attributes

• description (type: String.t, default: nil) - An optional user-provided description of the deployment.
• fingerprint (type: String.t, default: nil) - Provides a fingerprint to use in requests to modify a deployment, such as update(), stop(), and cancelPreview() requests. A fingerprint is a randomly generated value that must be provided with update(), stop(), and cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that only one request happens at a time. The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a get() request to a deployment.
• id (type: String.t, default: nil) -
• insertTime (type: String.t, default: nil) - Output only. Creation timestamp in RFC3339 text format.
• labels (type: list(GoogleApi.DeploymentManager.V2.Model.DeploymentLabelEntry.t), default: nil) - Map of One Platform labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?.
• manifest (type: String.t, default: nil) - Output only. URL of the manifest representing the last manifest that was successfully deployed. If no manifest has been successfully deployed, this field will be absent.
• name (type: String.t, default: nil) - Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
• operation (type: GoogleApi.DeploymentManager.V2.Model.Operation.t, default: nil) - Output only. The Operation that most recently ran, or is currently running, on this deployment.
• selfLink (type: String.t, default: nil) - Output only. Server defined URL for the resource.
• target (type: GoogleApi.DeploymentManager.V2.Model.TargetConfiguration.t, default: nil) - [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.
• update (type: GoogleApi.DeploymentManager.V2.Model.DeploymentUpdate.t, default: nil) - Output only. If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here.
• updateTime (type: String.t, default: nil) - Output only. Update timestamp in RFC3339 text format.

Label object for Deployments

Attributes

• description (type: String.t, default: nil) - Output only. An optional user-provided description of the deployment after the current update has been applied.
• labels (type: list(GoogleApi.DeploymentManager.V2.Model.DeploymentUpdateLabelEntry.t), default: nil) - Map of One Platform labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?.
• manifest (type: String.t, default: nil) - Output only. URL of the manifest representing the update configuration of this deployment.

Label object for DeploymentUpdate

Attributes

• fingerprint (type: String.t, default: nil) - Specifies a fingerprint for cancelPreview() requests. A fingerprint is a randomly generated value that must be provided in cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that the deployment does not have conflicting requests (e.g. if someone attempts to make a new update request while another user attempts to cancel a preview, this would prevent one of the requests). The fingerprint is initially generated by Deployment Manager and changes after every request to modify a deployment. To get the latest fingerprint value, perform a get() request on the deployment.

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

Attributes

• fingerprint (type: String.t, default: nil) - Specifies a fingerprint for stop() requests. A fingerprint is a randomly generated value that must be provided in stop() requests to perform optimistic locking. This ensures optimistic concurrency so that the deployment does not have conflicting requests (e.g. if someone attempts to make a new update request while another user attempts to stop an ongoing update request, this would prevent a collision). The fingerprint is initially generated by Deployment Manager and changes after every request to modify a deployment. To get the latest fingerprint value, perform a get() request on the deployment.

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.

Attributes

• bindings (type: list(GoogleApi.DeploymentManager.V2.Model.Binding.t), default: nil) - Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings.
• etag (type: String.t, default: nil) - Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.
• policy (type: GoogleApi.DeploymentManager.V2.Model.Policy.t, default: nil) - REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them.

Attributes

• content (type: String.t, default: nil) - The contents of the file.
• name (type: String.t, default: nil) - The name of the file.

Attributes

• config (type: GoogleApi.DeploymentManager.V2.Model.ConfigFile.t, default: nil) - Output only. The YAML configuration for this manifest.
• expandedConfig (type: String.t, default: nil) - Output only. The fully-expanded configuration file, including any templates and references.
• id (type: String.t, default: nil) -
• imports (type: list(GoogleApi.DeploymentManager.V2.Model.ImportFile.t), default: nil) - Output only. The imported files for this manifest.
• insertTime (type: String.t, default: nil) - Output only. Creation timestamp in RFC3339 text format.
• layout (type: String.t, default: nil) - Output only. The YAML layout for this manifest.
• manifestSizeBytes (type: String.t, default: nil) - Output only. The computed size of the fully expanded manifest.
• manifestSizeLimitBytes (type: String.t, default: nil) - Output only. The size limit for expanded manifests in the project.
• name (type: String.t, default: nil) - Output only. The name of the manifest.
• selfLink (type: String.t, default: nil) - Output only. Self link for the manifest.

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

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 zonalOperations resource. For more information, read Global, Regional, and Zonal Resources.

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

Attributes

• code (type: String.t, default: nil) - [Output Only] The error type identifier for this error.
• location (type: String.t, default: nil) - [Output Only] Indicates the field in the request that caused the error. This property is optional.
• message (type: String.t, default: nil) - [Output Only] An optional, human-readable error message.

Attributes

• code (type: String.t, default: nil) - [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
• data (type: list(GoogleApi.DeploymentManager.V2.Model.OperationWarningsData.t), default: nil) - [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
• message (type: String.t, default: nil) - [Output Only] A human-readable description of the warning code.

Attributes

• key (type: String.t, default: nil) - [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
• value (type: String.t, default: nil) - [Output Only] A warning data value corresponding to the key.

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

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.

Attributes

• accessControl (type: GoogleApi.DeploymentManager.V2.Model.ResourceAccessControl.t, default: nil) - The Access Control Policy set on this resource.
• finalProperties (type: String.t, default: nil) - Output only. The evaluated properties of the resource with references expanded. Returned as serialized YAML.
• id (type: String.t, default: nil) -
• insertTime (type: String.t, default: nil) - Output only. Creation timestamp in RFC3339 text format.
• manifest (type: String.t, default: nil) - Output only. URL of the manifest representing the current configuration of this resource.
• name (type: String.t, default: nil) - Output only. The name of the resource as it appears in the YAML config.
• properties (type: String.t, default: nil) - Output only. The current properties of the resource before any references have been filled in. Returned as serialized YAML.
• type (type: String.t, default: nil) - Output only. The type of the resource, for example compute.v1.instance, or cloudfunctions.v1beta1.function.
• update (type: GoogleApi.DeploymentManager.V2.Model.ResourceUpdate.t, default: nil) - Output only. If Deployment Manager is currently updating or previewing an update to this resource, the updated configuration appears here.
• updateTime (type: String.t, default: nil) - Output only. Update timestamp in RFC3339 text format.
• url (type: String.t, default: nil) - Output only. The URL of the actual resource.
• warnings (type: list(GoogleApi.DeploymentManager.V2.Model.ResourceWarnings.t), default: nil) - Output only. If warning messages are generated during processing of this resource, this field will be populated.

The access controls set on the resource.

Attributes

• accessControl (type: GoogleApi.DeploymentManager.V2.Model.ResourceAccessControl.t, default: nil) - The Access Control Policy to set on this resource after updating the resource itself.
• error (type: GoogleApi.DeploymentManager.V2.Model.ResourceUpdateError.t, default: nil) - Output only. If errors are generated during update of the resource, this field will be populated.
• finalProperties (type: String.t, default: nil) - Output only. The expanded properties of the resource with reference values expanded. Returned as serialized YAML.
• intent (type: String.t, default: nil) - Output only. The intent of the resource: PREVIEW, UPDATE, or CANCEL.
• manifest (type: String.t, default: nil) - Output only. URL of the manifest representing the update configuration of this resource.
• properties (type: String.t, default: nil) - Output only. The set of updated properties for this resource, before references are expanded. Returned as serialized YAML.
• state (type: String.t, default: nil) - Output only. The state of the resource.
• warnings (type: list(GoogleApi.DeploymentManager.V2.Model.ResourceUpdateWarnings.t), default: nil) - Output only. If warning messages are generated during processing of this resource, this field will be populated.

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

Attributes

• code (type: String.t, default: nil) - [Output Only] The error type identifier for this error.
• location (type: String.t, default: nil) - [Output Only] Indicates the field in the request that caused the error. This property is optional.
• message (type: String.t, default: nil) - [Output Only] An optional, human-readable error message.

Attributes

• code (type: String.t, default: nil) - [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
• data (type: list(GoogleApi.DeploymentManager.V2.Model.ResourceUpdateWarningsData.t), default: nil) - [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
• message (type: String.t, default: nil) - [Output Only] A human-readable description of the warning code.

Attributes

• key (type: String.t, default: nil) - [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
• value (type: String.t, default: nil) - [Output Only] A warning data value corresponding to the key.

Attributes

• code (type: String.t, default: nil) - [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
• data (type: list(GoogleApi.DeploymentManager.V2.Model.ResourceWarningsData.t), default: nil) - [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
• message (type: String.t, default: nil) - [Output Only] A human-readable description of the warning code.

Attributes

• key (type: String.t, default: nil) - [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
• value (type: String.t, default: nil) - [Output Only] A warning data value corresponding to the key.

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

Attributes

• config (type: GoogleApi.DeploymentManager.V2.Model.ConfigFile.t, default: nil) - The configuration to use for this deployment.
• imports (type: list(GoogleApi.DeploymentManager.V2.Model.ImportFile.t), default: nil) - Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template.

Attributes

• permissions (type: list(String.t), default: nil) - The set of permissions to check for the 'resource'. Permissions with wildcards (such as '' or 'storage.') are not allowed.

Attributes

• permissions (type: list(String.t), default: nil) - A subset of TestPermissionsRequest.permissions that the caller is allowed.

A resource type supported by Deployment Manager.

A response that returns all Types supported by Deployment Manager