Module api

Source

Structs§

AbandonReleaseRequest
The request object used by AbandonRelease.
AbandonReleaseResponse
The response object for AbandonRelease.
AdvanceChildRolloutJob
An advanceChildRollout Job.
AdvanceChildRolloutJobRun
AdvanceChildRolloutJobRun contains information specific to a advanceChildRollout JobRun.
AdvanceRolloutOperation
Contains the information of an automated advance-rollout operation.
AdvanceRolloutRequest
The request object used by AdvanceRollout.
AdvanceRolloutResponse
The response object from AdvanceRollout.
AdvanceRolloutRule
The AdvanceRollout automation rule will automatically advance a successful Rollout to the next phase.
AnthosCluster
Information specifying an Anthos Cluster.
ApproveRolloutRequest
The request object used by ApproveRollout.
ApproveRolloutResponse
The response object from ApproveRollout.
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.
Automation
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.
AutomationResourceSelector
AutomationResourceSelector contains the information to select the resources to which an Automation is going to be applied.
AutomationRolloutMetadata
AutomationRolloutMetadata contains Automation-related actions that were performed on a rollout.
AutomationRule
AutomationRule defines the automation activities.
AutomationRuleCondition
AutomationRuleCondition contains conditions relevant to an Automation rule.
AutomationRun
An AutomationRun resource in the Cloud Deploy API. An AutomationRun represents an execution instance of an automation rule.
Binding
Associates members, or principals, with a role.
BuildArtifact
Description of an a image to use during Skaffold rendering.
Canary
Canary represents the canary deployment strategy.
CanaryDeployment
CanaryDeployment represents the canary deployment configuration
CancelAutomationRunRequest
The request object used by CancelAutomationRun.
CancelAutomationRunResponse
The response object from CancelAutomationRun.
CancelOperationRequest
The request message for Operations.CancelOperation.
CancelRolloutRequest
The request object used by CancelRollout.
CancelRolloutResponse
The response object from CancelRollout.
ChildRolloutJobs
ChildRollouts job composition
CloudDeploy
Central instance to access all CloudDeploy related resource activities
CloudRunConfig
CloudRunConfig contains the Cloud Run runtime configuration.
CloudRunLocation
Information specifying where to deploy a Cloud Run Service.
CloudRunMetadata
CloudRunMetadata contains information from a Cloud Run deployment.
CloudRunRenderMetadata
CloudRunRenderMetadata contains Cloud Run information associated with a Release render.
Config
Service-wide configuration.
CreateChildRolloutJob
A createChildRollout Job.
CreateChildRolloutJobRun
CreateChildRolloutJobRun contains information specific to a createChildRollout JobRun.
CustomCanaryDeployment
CustomCanaryDeployment represents the custom canary deployment configuration.
CustomMetadata
CustomMetadata contains information from a user-defined operation.
CustomTarget
Information specifying a Custom Target.
CustomTargetDeployMetadata
CustomTargetDeployMetadata contains information from a Custom Target deploy operation.
CustomTargetSkaffoldActions
CustomTargetSkaffoldActions represents the CustomTargetType configuration using Skaffold custom actions.
CustomTargetType
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.
Date
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
DefaultPool
Execution using the default Cloud Build pool.
DeliveryPipeline
A DeliveryPipeline resource in the Cloud Deploy API. A DeliveryPipeline defines a pipeline through which a Skaffold configuration can progress.
DeployArtifact
The artifacts produced by a deploy operation.
DeployJob
A deploy Job.
DeployJobRun
DeployJobRun contains information specific to a deploy JobRun.
DeployJobRunMetadata
DeployJobRunMetadata surfaces information associated with a DeployJobRun to the user.
DeployParameters
DeployParameters contains deploy parameters information.
DeploymentJobs
Deployment job composition.
Empty
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); }
ExecutionConfig
Configuration of the environment to use when calling Skaffold.
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.
GatewayServiceMesh
Information about the Kubernetes Gateway API service mesh configuration.
GkeCluster
Information specifying a GKE Cluster.
IgnoreJobRequest
The request object used by IgnoreJob.
IgnoreJobResponse
The response object from IgnoreJob.
Job
Job represents an operation for a Rollout.
JobRun
A JobRun resource in the Cloud Deploy API. A JobRun contains information of a single Rollout job evaluation.
KubernetesConfig
KubernetesConfig contains the Kubernetes runtime configuration.
ListAutomationRunsResponse
The response object from ListAutomationRuns.
ListAutomationsResponse
The response object from ListAutomations.
ListCustomTargetTypesResponse
The response object from ListCustomTargetTypes.
ListDeliveryPipelinesResponse
The response object from ListDeliveryPipelines.
ListJobRunsResponse
ListJobRunsResponse is the response object returned by ListJobRuns.
ListLocationsResponse
The response message for Locations.ListLocations.
ListOperationsResponse
The response message for Operations.ListOperations.
ListReleasesResponse
The response object from ListReleases.
ListRolloutsResponse
ListRolloutsResponse is the response object reutrned by ListRollouts.
ListTargetsResponse
The response object from ListTargets.
Location
A resource that represents a Google Cloud location.
Metadata
Metadata includes information associated with a Rollout.
MultiTarget
Information specifying a multiTarget.
Operation
This resource represents a long-running operation that is the result of a network API call.
Phase
Phase represents a collection of jobs that are logically grouped together for a Rollout.
PhaseArtifact
Contains the paths to the artifacts, relative to the URI, for a phase.
PhaseConfig
PhaseConfig represents the configuration for a phase in the custom canary deployment.
PipelineCondition
PipelineCondition contains all conditions relevant to a Delivery Pipeline.
PipelineReadyCondition
PipelineReadyCondition contains information around the status of the Pipeline.
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.
Postdeploy
Postdeploy contains the postdeploy job configuration information.
PostdeployJob
A postdeploy Job.
PostdeployJobRun
PostdeployJobRun contains information specific to a postdeploy JobRun.
Predeploy
Predeploy contains the predeploy job configuration information.
PredeployJob
A predeploy Job.
PredeployJobRun
PredeployJobRun contains information specific to a predeploy JobRun.
PrivatePool
Execution using a private Cloud Build pool.
ProjectLocationCustomTargetTypeCreateCall
Creates a new CustomTargetType in a given project and location.
ProjectLocationCustomTargetTypeDeleteCall
Deletes a single CustomTargetType.
ProjectLocationCustomTargetTypeGetCall
Gets details of a single CustomTargetType.
ProjectLocationCustomTargetTypeGetIamPolicyCall
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
ProjectLocationCustomTargetTypeListCall
Lists CustomTargetTypes in a given project and location.
ProjectLocationCustomTargetTypePatchCall
Updates a single CustomTargetType.
ProjectLocationCustomTargetTypeSetIamPolicyCall
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
ProjectLocationDeliveryPipelineAutomationCreateCall
Creates a new Automation in a given project and location.
ProjectLocationDeliveryPipelineAutomationDeleteCall
Deletes a single Automation resource.
ProjectLocationDeliveryPipelineAutomationGetCall
Gets details of a single Automation.
ProjectLocationDeliveryPipelineAutomationListCall
Lists Automations in a given project and location.
ProjectLocationDeliveryPipelineAutomationPatchCall
Updates the parameters of a single Automation resource.
ProjectLocationDeliveryPipelineAutomationRunCancelCall
Cancels an AutomationRun. The state of the AutomationRun after cancelling is CANCELLED. CancelAutomationRun can be called on AutomationRun in the state IN_PROGRESS and PENDING; AutomationRun in a different state returns an FAILED_PRECONDITION error.
ProjectLocationDeliveryPipelineAutomationRunGetCall
Gets details of a single AutomationRun.
ProjectLocationDeliveryPipelineAutomationRunListCall
Lists AutomationRuns in a given project and location.
ProjectLocationDeliveryPipelineCreateCall
Creates a new DeliveryPipeline in a given project and location.
ProjectLocationDeliveryPipelineDeleteCall
Deletes a single DeliveryPipeline.
ProjectLocationDeliveryPipelineGetCall
Gets details of a single DeliveryPipeline.
ProjectLocationDeliveryPipelineGetIamPolicyCall
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
ProjectLocationDeliveryPipelineListCall
Lists DeliveryPipelines in a given project and location.
ProjectLocationDeliveryPipelinePatchCall
Updates the parameters of a single DeliveryPipeline.
ProjectLocationDeliveryPipelineReleaseAbandonCall
Abandons a Release in the Delivery Pipeline.
ProjectLocationDeliveryPipelineReleaseCreateCall
Creates a new Release in a given project and location.
ProjectLocationDeliveryPipelineReleaseGetCall
Gets details of a single Release.
ProjectLocationDeliveryPipelineReleaseListCall
Lists Releases in a given project and location.
ProjectLocationDeliveryPipelineReleaseRolloutAdvanceCall
Advances a Rollout in a given project and location.
ProjectLocationDeliveryPipelineReleaseRolloutApproveCall
Approves a Rollout.
ProjectLocationDeliveryPipelineReleaseRolloutCancelCall
Cancels a Rollout in a given project and location.
ProjectLocationDeliveryPipelineReleaseRolloutCreateCall
Creates a new Rollout in a given project and location.
ProjectLocationDeliveryPipelineReleaseRolloutGetCall
Gets details of a single Rollout.
ProjectLocationDeliveryPipelineReleaseRolloutIgnoreJobCall
Ignores the specified Job in a Rollout.
ProjectLocationDeliveryPipelineReleaseRolloutJobRunGetCall
Gets details of a single JobRun.
ProjectLocationDeliveryPipelineReleaseRolloutJobRunListCall
Lists JobRuns in a given project and location.
ProjectLocationDeliveryPipelineReleaseRolloutJobRunTerminateCall
Terminates a Job Run in a given project and location.
ProjectLocationDeliveryPipelineReleaseRolloutListCall
Lists Rollouts in a given project and location.
ProjectLocationDeliveryPipelineReleaseRolloutRetryJobCall
Retries the specified Job in a Rollout.
ProjectLocationDeliveryPipelineRollbackTargetCall
Creates a Rollout to roll back the specified target.
ProjectLocationDeliveryPipelineSetIamPolicyCall
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
ProjectLocationDeliveryPipelineTestIamPermissionCall
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may “fail open” without warning.
ProjectLocationGetCall
Gets information about a location.
ProjectLocationGetConfigCall
Gets the configuration for a location.
ProjectLocationListCall
Lists information about the supported locations for this service.
ProjectLocationOperationCancelCall
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn’t support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.
ProjectLocationOperationDeleteCall
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn’t support this method, it returns google.rpc.Code.UNIMPLEMENTED.
ProjectLocationOperationGetCall
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
ProjectLocationOperationListCall
Lists operations that match the specified filter in the request. If the server doesn’t support this method, it returns UNIMPLEMENTED.
ProjectLocationTargetCreateCall
Creates a new Target in a given project and location.
ProjectLocationTargetDeleteCall
Deletes a single Target.
ProjectLocationTargetGetCall
Gets details of a single Target.
ProjectLocationTargetGetIamPolicyCall
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
ProjectLocationTargetListCall
Lists Targets in a given project and location.
ProjectLocationTargetPatchCall
Updates the parameters of a single Target.
ProjectLocationTargetSetIamPolicyCall
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
ProjectLocationTargetTestIamPermissionCall
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may “fail open” without warning.
ProjectMethods
A builder providing access to all methods supported on project resources. It is not used directly, but through the CloudDeploy hub.
PromoteReleaseOperation
Contains the information of an automated promote-release operation.
PromoteReleaseRule
PromoteRelease rule will automatically promote a release from the current target to a specified target.
Release
A Release resource in the Cloud Deploy API. A Release defines a specific Skaffold configuration instance that can be deployed.
ReleaseCondition
ReleaseCondition contains all conditions relevant to a Release.
ReleaseReadyCondition
ReleaseReadyCondition contains information around the status of the Release. If a release is not ready, you cannot create a rollout with the release.
RenderMetadata
RenderMetadata includes information associated with a Release render.
RepairPhase
RepairPhase tracks the repair attempts that have been made for each RepairPhaseConfig specified in the Automation resource.
RepairRolloutOperation
Contains the information for an automated repair rollout operation.
RepairRolloutRule
The RepairRolloutRule automation rule will automatically repair a failed Rollout.
RetryAttempt
RetryAttempt represents an action of retrying the failed Cloud Deploy job.
RetryJobRequest
RetryJobRequest is the request object used by RetryJob.
RetryJobResponse
The response object from ‘RetryJob’.
RetryPhase
RetryPhase contains the retry attempts and the metadata for initiating a new attempt.
RollbackAttempt
RollbackAttempt represents an action of rolling back a Cloud Deploy ‘Target’.
RollbackTargetConfig
Configs for the Rollback rollout.
RollbackTargetRequest
The request object for RollbackTarget.
RollbackTargetResponse
The response object from RollbackTarget.
Rollout
A Rollout resource in the Cloud Deploy API. A Rollout contains information around a specific deployment to a Target.
RuntimeConfig
RuntimeConfig contains the runtime specific configurations for a deployment strategy.
SerialPipeline
SerialPipeline defines a sequential set of stages for a DeliveryPipeline.
ServiceNetworking
Information about the Kubernetes Service networking configuration.
SetIamPolicyRequest
Request message for SetIamPolicy method.
SkaffoldGCBRepoSource
Cloud Build V2 Repository containing Skaffold Configs.
SkaffoldGCSSource
Cloud Storage bucket containing Skaffold Config modules.
SkaffoldGitSource
Git repository containing Skaffold Config modules.
SkaffoldModules
Skaffold Config modules and their remote source.
SkaffoldSupportedCondition
SkaffoldSupportedCondition contains information about when support for the release’s version of Skaffold ends.
SkaffoldVersion
Details of a supported Skaffold version.
Stage
Stage specifies a location to which to deploy.
Standard
Standard represents the standard deployment strategy.
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.
Strategy
Strategy contains deployment strategy information.
Target
A Target resource in the Cloud Deploy API. A Target defines a location to which a Skaffold configuration can be deployed.
TargetArtifact
The artifacts produced by a target render operation.
TargetAttribute
Contains criteria for selecting Targets.
TargetRender
Details of rendering for a single target.
TargetsPresentCondition
TargetsPresentCondition contains information on any Targets referenced in the Delivery Pipeline that do not actually exist.
TargetsTypeCondition
TargetsTypeCondition contains information on whether the Targets defined in the Delivery Pipeline are of the same type.
TerminateJobRunRequest
The request object used by TerminateJobRun.
TerminateJobRunResponse
The response object from TerminateJobRun.
TestIamPermissionsRequest
Request message for TestIamPermissions method.
TestIamPermissionsResponse
Response message for TestIamPermissions method.
VerifyJob
A verify Job.
VerifyJobRun
VerifyJobRun contains information specific to a verify JobRun.

Enums§

Scope
Identifies the an OAuth2 authorization scope. A scope is needed when requesting an authorization token.