View Source API Reference google_api_cloud_deploy v0.6.0

Modules

API client metadata for GoogleApi.CloudDeploy.V1.

API calls for all endpoints tagged Projects.

Handle Tesla connections for GoogleApi.CloudDeploy.V1.

The request object used by AbandonRelease.

The response object for AbandonRelease.

AdvanceChildRolloutJobRun contains information specific to a advanceChildRollout JobRun.

Contains the information of an automated advance-rollout operation.

The request object used by AdvanceRollout.

The response object from AdvanceRollout.

The AdvanceRollout automation rule will automatically advance a successful Rollout to the next phase.

Information specifying an Anthos Cluster.

The request object used by ApproveRollout.

The response object from ApproveRollout.

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.

An Automation resource in the Cloud Deploy API. An Automation enables the automation of manually driven actions for a Delivery Pipeline, which includes Release promotion among Targets, Rollout repair and Rollout deployment strategy advancement. The intention of Automation is to reduce manual intervention in the continuous delivery process.

Payload proto for "clouddeploy.googleapis.com/automation" Platform Log event that describes the Automation related events.

AutomationResourceSelector contains the information to select the resources to which an Automation is going to be applied.

AutomationRolloutMetadata contains Automation-related actions that were performed on a rollout.

AutomationRule defines the automation activities.

AutomationRuleCondition contains conditions relevant to an Automation rule.

An AutomationRun resource in the Cloud Deploy API. An AutomationRun represents an execution instance of an automation rule.

Payload proto for "clouddeploy.googleapis.com/automation_run" Platform Log event that describes the AutomationRun related events.

Associates members, or principals, with a role.

Description of an a image to use during Skaffold rendering.

Canary represents the canary deployment strategy.

CanaryDeployment represents the canary deployment configuration

The request object used by CancelAutomationRun.

The response object from CancelAutomationRun.

The request message for Operations.CancelOperation.

The request object used by CancelRollout.

The response object from CancelRollout.

ChildRollouts job composition

CloudRunConfig contains the Cloud Run runtime configuration.

Information specifying where to deploy a Cloud Run Service.

CloudRunMetadata contains information from a Cloud Run deployment.

CloudRunRenderMetadata contains Cloud Run information associated with a Release render.

Service-wide configuration.

CreateChildRolloutJobRun contains information specific to a createChildRollout JobRun.

CustomCanaryDeployment represents the custom canary deployment configuration.

CustomMetadata contains information from a user-defined operation.

Information specifying a Custom Target.

CustomTargetDeployMetadata contains information from a Custom Target deploy operation.

CustomTargetSkaffoldActions represents the CustomTargetType configuration using Skaffold custom actions.

A CustomTargetType resource in the Cloud Deploy API. A CustomTargetType defines a type of custom target that can be referenced in a Target in order to facilitate deploying to other systems besides the supported runtimes.

Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: A full date, with non-zero year, month, and day values. A month and day, with a zero year (for example, an anniversary). A year on its own, with a zero month and a zero day. A year and month, with a zero day (for example, a credit card expiration date). Related types: google.type.TimeOfDay google.type.DateTime * google.protobuf.Timestamp

Execution using the default Cloud Build pool.

A DeliveryPipeline resource in the Cloud Deploy API. A DeliveryPipeline defines a pipeline through which a Skaffold configuration can progress.

Payload proto for "clouddeploy.googleapis.com/deliverypipeline_notification" Platform Log event that describes the failure to send delivery pipeline status change Pub/Sub notification.

The artifacts produced by a deploy operation.

DeployJobRun contains information specific to a deploy JobRun.

DeployJobRunMetadata surfaces information associated with a DeployJobRun to the user.

DeployParameters contains deploy parameters information.

Deployment job composition.

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

Configuration of the environment to use when calling Skaffold.

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.

Information about the Kubernetes Gateway API service mesh configuration.

Information specifying a GKE Cluster.

The request object used by IgnoreJob.

The response object from IgnoreJob.

Job represents an operation for a Rollout.

A JobRun resource in the Cloud Deploy API. A JobRun contains information of a single Rollout job evaluation.

Payload proto for "clouddeploy.googleapis.com/jobrun_notification" Platform Log event that describes the failure to send JobRun resource update Pub/Sub notification.

KubernetesConfig contains the Kubernetes runtime configuration.

The response object from ListAutomationRuns.

The response object from ListAutomations.

The response object from ListCustomTargetTypes.

The response object from ListDeliveryPipelines.

ListJobRunsResponse is the response object returned by ListJobRuns.

The response message for Locations.ListLocations.

The response message for Operations.ListOperations.

The response object from ListReleases.

ListRolloutsResponse is the response object reutrned by ListRollouts.

The response object from ListTargets.

A resource that represents a Google Cloud location.

Metadata includes information associated with a Rollout.

Information specifying a multiTarget.

This resource represents a long-running operation that is the result of a network API call.

Represents the metadata of the long-running operation.

Phase represents a collection of jobs that are logically grouped together for a Rollout.

Contains the paths to the artifacts, relative to the URI, for a phase.

PhaseConfig represents the configuration for a phase in the custom canary deployment.

PipelineCondition contains all conditions relevant to a Delivery Pipeline.

PipelineReadyCondition contains information around the status of the Pipeline.

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.

Postdeploy contains the postdeploy job configuration information.

PostdeployJobRun contains information specific to a postdeploy JobRun.

Predeploy contains the predeploy job configuration information.

PredeployJobRun contains information specific to a predeploy JobRun.

Execution using a private Cloud Build pool.

Contains the information of an automated promote-release operation.

PromoteRelease rule will automatically promote a release from the current target to a specified target.

A Release resource in the Cloud Deploy API. A Release defines a specific Skaffold configuration instance that can be deployed.

ReleaseCondition contains all conditions relevant to a Release.

Payload proto for "clouddeploy.googleapis.com/release_notification" Platform Log event that describes the failure to send release status change Pub/Sub notification.

ReleaseReadyCondition contains information around the status of the Release. If a release is not ready, you cannot create a rollout with the release.

Payload proto for "clouddeploy.googleapis.com/release_render" Platform Log event that describes the render status change.

RenderMetadata includes information associated with a Release render.

Configuration of the repair action.

RepairPhase tracks the repair attempts that have been made for each RepairMode specified in the Automation resource.

Contains the information for an automated repair rollout operation.

The RepairRolloutRule automation rule will automatically repair a failed Rollout.

Retries the failed job.

RetryAttempt represents an action of retrying the failed Cloud Deploy job.

RetryJobRequest is the request object used by RetryJob.

The response object from 'RetryJob'.

RetryPhase contains the retry attempts and the metadata for initiating a new attempt.

RollbackAttempt represents an action of rolling back a Cloud Deploy 'Target'.

Configs for the Rollback rollout.

The request object for RollbackTarget.

The response object from RollbackTarget.

A Rollout resource in the Cloud Deploy API. A Rollout contains information around a specific deployment to a Target.

Payload proto for "clouddeploy.googleapis.com/rollout_notification" Platform Log event that describes the failure to send rollout status change Pub/Sub notification.

Payload proto for "clouddeploy.googleapis.com/rollout_update" Platform Log event that describes the rollout update event.

RuntimeConfig contains the runtime specific configurations for a deployment strategy.

SerialPipeline defines a sequential set of stages for a DeliveryPipeline.

Information about the Kubernetes Service networking configuration.

Request message for SetIamPolicy method.

Cloud Storage bucket containing Skaffold Config modules.

Git repository containing Skaffold Config modules.

Skaffold Config modules and their remote source.

SkaffoldSupportedCondition contains information about when support for the release's version of Skaffold ends.

Details of a supported Skaffold version.

Stage specifies a location to which to deploy.

Standard represents the standard deployment strategy.

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.

Strategy contains deployment strategy information.

A Target resource in the Cloud Deploy API. A Target defines a location to which a Skaffold configuration can be deployed.

The artifacts produced by a target render operation.

Contains criteria for selecting Targets.

Payload proto for "clouddeploy.googleapis.com/target_notification" Platform Log event that describes the failure to send target status change Pub/Sub notification.

Details of rendering for a single target.

TargetsPresentCondition contains information on any Targets referenced in the Delivery Pipeline that do not actually exist.

TargetsTypeCondition contains information on whether the Targets defined in the Delivery Pipeline are of the same type.

The request object used by TerminateJobRun.

The response object from TerminateJobRun.

Request message for TestIamPermissions method.

Response message for TestIamPermissions method.

VerifyJobRun contains information specific to a verify JobRun.