Module model

Source

Expand description

The messages and enums that are part of this client library.

Modules§

automation_rule: Defines additional types related to AutomationRule.
automation_rule_condition: Defines additional types related to AutomationRuleCondition.
automation_run: Defines additional types related to AutomationRun.
canary: Defines additional types related to Canary.
custom_canary_deployment: Defines additional types related to CustomCanaryDeployment.
custom_target_type: Defines additional types related to CustomTargetType.
delivery_pipeline: Defines additional types related to DeliveryPipeline.
deploy_job_run: Defines additional types related to DeployJobRun.
deploy_policy: Defines additional types related to DeployPolicy.
deploy_policy_evaluation_event: Defines additional types related to DeployPolicyEvaluationEvent.
execution_config: Defines additional types related to ExecutionConfig.
job: Defines additional types related to Job.
job_run: Defines additional types related to JobRun.
kubernetes_config: Defines additional types related to KubernetesConfig.
phase: Defines additional types related to Phase.
policy_rule: Defines additional types related to PolicyRule.
postdeploy_job_run: Defines additional types related to PostdeployJobRun.
predeploy_job_run: Defines additional types related to PredeployJobRun.
release: Defines additional types related to Release.
repair_phase: Defines additional types related to RepairPhase.
repair_phase_config: Defines additional types related to RepairPhaseConfig.
rollout: Defines additional types related to Rollout.
rollout_restriction: Defines additional types related to RolloutRestriction.
rollout_update_event: Defines additional types related to RolloutUpdateEvent.
runtime_config: Defines additional types related to RuntimeConfig.
skaffold_modules: Defines additional types related to SkaffoldModules.
strategy: Defines additional types related to Strategy.
target: Defines additional types related to Target.
target_artifact: Defines additional types related to TargetArtifact.
timed_promote_release_condition: Defines additional types related to TimedPromoteReleaseCondition.
verify_job_run: Defines additional types related to VerifyJobRun.

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.
AssociatedEntities: Information about entities associated with a Target.
Automation: An Automation resource in the Cloud Deploy API.
AutomationEvent: Payload proto for “clouddeploy.googleapis.com/automation” Platform Log event that describes the Automation related events.
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.
AutomationRunEvent: Payload proto for “clouddeploy.googleapis.com/automation_run” Platform Log event that describes the AutomationRun related events.
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.
CancelRolloutRequest: The request object used by CancelRollout.
CancelRolloutResponse: The response object from CancelRollout.
ChildRolloutJobs: ChildRollouts job composition
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.
CreateAutomationRequest: The request object for CreateAutomation.
CreateChildRolloutJob: A createChildRollout Job.
CreateChildRolloutJobRun: CreateChildRolloutJobRun contains information specific to a createChildRollout JobRun.
CreateCustomTargetTypeRequest: The request object for CreateCustomTargetType.
CreateDeliveryPipelineRequest: The request object for CreateDeliveryPipeline.
CreateDeployPolicyRequest: The request object for CreateDeployPolicy.
CreateReleaseRequest: The request object for CreateRelease,
CreateRolloutRequest: CreateRolloutRequest is the request object used by CreateRollout.
CreateTargetRequest: The request object for CreateTarget.
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.
CustomTargetTypeNotificationEvent: Payload proto for “clouddeploy.googleapis.com/customtargettype_notification” Platform Log event that describes the failure to send a custom target type status change Pub/Sub notification.
DefaultPool: Execution using the default Cloud Build pool.
DeleteAutomationRequest: The request object for DeleteAutomation.
DeleteCustomTargetTypeRequest: The request object for DeleteCustomTargetType.
DeleteDeliveryPipelineRequest: The request object for DeleteDeliveryPipeline.
DeleteDeployPolicyRequest: The request object for DeleteDeployPolicy.
DeleteTargetRequest: The request object for DeleteTarget.
DeliveryPipeline: A DeliveryPipeline resource in the Cloud Deploy API.
DeliveryPipelineAttribute: Contains criteria for selecting DeliveryPipelines.
DeliveryPipelineNotificationEvent: Payload proto for “clouddeploy.googleapis.com/deliverypipeline_notification” Platform Log event that describes the failure to send delivery pipeline status change Pub/Sub notification.
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.
DeployPolicy: A DeployPolicy resource in the Cloud Deploy API.
DeployPolicyEvaluationEvent: Payload proto for “clouddeploy.googleapis.com/deploypolicy_evaluation” Platform Log event that describes the deploy policy evaluation event.
DeployPolicyNotificationEvent: Payload proto for “clouddeploy.googleapis.com/deploypolicy_notification”. Platform Log event that describes the failure to send a pub/sub notification when there is a DeployPolicy status change.
DeployPolicyResourceSelector: Contains information on the resources to select for a deploy policy. Attributes provided must all match the resource in order for policy restrictions to apply. For example, if delivery pipelines attributes given are an id “prod” and labels “foo: bar”, a delivery pipeline resource must match both that id and have that label in order to be subject to the policy.
DeploymentJobs: Deployment job composition.
ExecutionConfig: Configuration of the environment to use when calling Skaffold.
GetAutomationRequest: The request object for GetAutomation
GetAutomationRunRequest: The request object for GetAutomationRun
GetConfigRequest: Request to get a configuration.
GetCustomTargetTypeRequest: The request object for GetCustomTargetType.
GetDeliveryPipelineRequest: The request object for GetDeliveryPipeline
GetDeployPolicyRequest: The request object for GetDeployPolicy
GetJobRunRequest: GetJobRunRequest is the request object used by GetJobRun.
GetReleaseRequest: The request object for GetRelease.
GetRolloutRequest: GetRolloutRequest is the request object used by GetRollout.
GetTargetRequest: The request object for GetTarget.
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.
JobRunNotificationEvent: Payload proto for “clouddeploy.googleapis.com/jobrun_notification” Platform Log event that describes the failure to send JobRun resource update Pub/Sub notification.
KubernetesConfig: KubernetesConfig contains the Kubernetes runtime configuration.
ListAutomationRunsRequest: The request object for ListAutomationRuns.
ListAutomationRunsResponse: The response object from ListAutomationRuns.
ListAutomationsRequest: The request object for ListAutomations.
ListAutomationsResponse: The response object from ListAutomations.
ListCustomTargetTypesRequest: The request object for ListCustomTargetTypes.
ListCustomTargetTypesResponse: The response object from ListCustomTargetTypes.
ListDeliveryPipelinesRequest: The request object for ListDeliveryPipelines.
ListDeliveryPipelinesResponse: The response object from ListDeliveryPipelines.
ListDeployPoliciesRequest: The request object for ListDeployPolicies.
ListDeployPoliciesResponse: The response object from ListDeployPolicies.
ListJobRunsRequest: ListJobRunsRequest is the request object used by ListJobRuns.
ListJobRunsResponse: ListJobRunsResponse is the response object returned by ListJobRuns.
ListReleasesRequest: The request object for ListReleases.
ListReleasesResponse: The response object from ListReleases.
ListRolloutsRequest: ListRolloutsRequest is the request object used by ListRollouts.
ListRolloutsResponse: ListRolloutsResponse is the response object returned by ListRollouts.
ListTargetsRequest: The request object for ListTargets.
ListTargetsResponse: The response object from ListTargets.
Metadata: Metadata includes information associated with a Rollout.
MultiTarget: Information specifying a multiTarget.
OneTimeWindow: One-time window within which actions are restricted. For example, blocking actions over New Year’s Eve from December 31st at 5pm to January 1st at 9am.
OperationMetadata: Represents the metadata of the long-running operation.
Phase: Phase represents a collection of jobs that are logically grouped together for a Rollout.
PipelineCondition: PipelineCondition contains all conditions relevant to a Delivery Pipeline.
PipelineReadyCondition: PipelineReadyCondition contains information around the status of the Pipeline.
PolicyRule: Deploy Policy rule.
PolicyViolation: Returned from an action if one or more policies were violated, and therefore the action was prevented. Contains information about what policies were violated and why.
PolicyViolationDetails: Policy violation details.
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.
PromoteReleaseOperation: Contains the information of an automated promote-release operation.
PromoteReleaseRule: The PromoteRelease rule will automatically promote a release from the current target to a specified target.
Release: A Release resource in the Cloud Deploy API.
ReleaseNotificationEvent: Payload proto for “clouddeploy.googleapis.com/release_notification” Platform Log event that describes the failure to send release status change Pub/Sub notification.
ReleaseRenderEvent: Payload proto for “clouddeploy.googleapis.com/release_render” Platform Log event that describes the render status change.
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.
RepairPhaseConfig: Configuration of the repair phase.
RepairRolloutOperation: Contains the information for an automated repair rollout operation.
RepairRolloutRule: The RepairRolloutRule automation rule will automatically repair a failed Rollout.
Retry: Retries the failed job.
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.
Rollback: Rolls back a Rollout.
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.
RolloutNotificationEvent: Payload proto for “clouddeploy.googleapis.com/rollout_notification” Platform Log event that describes the failure to send rollout status change Pub/Sub notification.
RolloutRestriction: Rollout restrictions.
RolloutUpdateEvent: Payload proto for “clouddeploy.googleapis.com/rollout_update” Platform Log event that describes the rollout update event.
RuntimeConfig: RuntimeConfig contains the runtime specific configurations for a deployment strategy.
SerialPipeline: SerialPipeline defines a sequential set of stages for a DeliveryPipeline.
SkaffoldModules: Skaffold Config modules and their remote source.
SkaffoldVersion: Details of a supported Skaffold version.
Stage: Stage specifies a location to which to deploy.
Standard: Standard represents the standard deployment strategy.
Strategy: Strategy contains deployment strategy information.
Target: A Target resource in the Cloud Deploy API.
TargetArtifact: The artifacts produced by a target render operation.
TargetAttribute: Contains criteria for selecting Targets. This could be used to select targets for a Deploy Policy or for an Automation.
TargetNotificationEvent: Payload proto for “clouddeploy.googleapis.com/target_notification” Platform Log event that describes the failure to send target status change Pub/Sub notification.
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.
TimeWindows: Time windows within which actions are restricted. See the documentation for more information on how to configure dates/times.
TimedPromoteReleaseCondition: TimedPromoteReleaseCondition contains conditions specific to an Automation with a Timed Promote Release rule defined.
TimedPromoteReleaseOperation: Contains the information of an automated timed promote-release operation.
TimedPromoteReleaseRule: The TimedPromoteReleaseRule will automatically promote a release from the current target(s) to the specified target(s) on a configured schedule.
UpdateAutomationRequest: The request object for UpdateAutomation.
UpdateCustomTargetTypeRequest: The request object for UpdateCustomTargetType.
UpdateDeliveryPipelineRequest: The request object for UpdateDeliveryPipeline.
UpdateDeployPolicyRequest: The request object for UpdateDeployPolicy.
UpdateTargetRequest: The request object for UpdateTarget.
VerifyJob: A verify Job.
VerifyJobRun: VerifyJobRun contains information specific to a verify JobRun.
WeeklyWindow: Weekly windows. For example, blocking actions every Saturday and Sunday. Another example would be blocking actions every weekday from 5pm to midnight.

Enums§

BackoffMode: The pattern of how wait time is increased.
RepairState: Valid state of a repair attempt.
SkaffoldSupportState: The support state of a specific Skaffold version.
Type: Type indicates the type of the log entry and can be used as a filter.

Module model

Module model Copy item path

Modules§

Structs§

Enums§

Module model