Creates a new Rollout in a given project and location.

Scopes

You will need authorization for the https://www.googleapis.com/auth/cloud-platform scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform. You can set the scope for this method like this: clouddeploy1 --scope <scope> projects locations-delivery-pipelines-releases-rollouts-create ...

Required Scalar Argument

• <parent> (string)
  • Required. The parent collection in which the Rollout should be created. Format should be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}.

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

Rollout:
  annotations: { string: string }
  approval-state: string
  approve-time: string
  controller-rollout: string
  create-time: string
  deploy-end-time: string
  deploy-failure-cause: string
  deploy-start-time: string
  deploying-build: string
  description: string
  enqueue-time: string
  etag: string
  failure-reason: string
  labels: { string: string }
  metadata:
    automation:
      advance-automation-runs: [string]
      current-repair-automation-run: string
      promote-automation-run: string
      repair-automation-runs: [string]
    cloud-run:
      job: string
      revision: string
      service: string
      service-urls: [string]
    custom:
      values: { string: string }
  name: string
  rollback-of-rollout: string
  rolled-back-by-rollouts: [string]
  state: string
  target-id: string
  uid: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

• -r . annotations=key=et
  • User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
  • the value will be associated with the given key
• approval-state=sea
  • Output only. Approval state of the Rollout.
• approve-time=consetetur
  • Output only. Time at which the Rollout was approved.
• controller-rollout=consetetur
  • Output only. Name of the ControllerRollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/a-z{0,62}.
• create-time=stet
  • Output only. Time at which the Rollout was created.
• deploy-end-time=est
  • Output only. Time at which the Rollout finished deploying.
• deploy-failure-cause=aliquyam
  • Output only. The reason this rollout failed. This will always be unspecified while the rollout is in progress.
• deploy-start-time=elitr
  • Output only. Time at which the Rollout started deploying.
• deploying-build=duo
  • Output only. The resource name of the Cloud Build Build object that is used to deploy the Rollout. Format is projects/{project}/locations/{location}/builds/{build}.
• description=diam
  • Description of the Rollout for user purposes. Max length is 255 characters.
• enqueue-time=est
  • Output only. Time at which the Rollout was enqueued.
• etag=sit
  • This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
• failure-reason=sed
  • Output only. Additional information about the rollout failure, if available.
• labels=key=eos
  • Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.
  • the value will be associated with the given key
• metadata.automation advance-automation-runs=lorem
  • Output only. The IDs of the AutomationRuns initiated by an advance rollout rule.
  • Each invocation of this argument appends the given value to the array.
• current-repair-automation-run=ea
  • Output only. The current AutomationRun repairing the rollout.
• promote-automation-run=stet
  • Output only. The ID of the AutomationRun initiated by a promote release rule.

• repair-automation-runs=dolores

  • Output only. The IDs of the AutomationRuns initiated by a repair rollout rule.
  • Each invocation of this argument appends the given value to the array.

• ..cloud-run job=eos

  • Output only. The name of the Cloud Run job that is associated with a Rollout. Format is projects/{project}/locations/{location}/jobs/{job_name}.
• revision=et
  • Output only. The Cloud Run Revision id associated with a Rollout.
• service=sea
  • Output only. The name of the Cloud Run Service that is associated with a Rollout. Format is projects/{project}/locations/{location}/services/{service}.

• service-urls=et

  • Output only. The Cloud Run Service urls that are associated with a Rollout.
  • Each invocation of this argument appends the given value to the array.

• ..custom values=key=at

  • Output only. Key-value pairs provided by the user-defined operation.
  • the value will be associated with the given key

• ... name=dolore

  • Optional. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/a-z{0,62}.
• rollback-of-rollout=eirmod
  • Output only. Name of the Rollout that is rolled back by this Rollout. Empty if this Rollout wasn't created as a rollback.
• rolled-back-by-rollouts=lorem
  • Output only. Names of Rollouts that rolled back this Rollout.
  • Each invocation of this argument appends the given value to the array.
• state=accusam
  • Output only. Current state of the Rollout.
• target-id=amet
  • Required. The ID of Target to which this Rollout is deploying.
• uid=erat
  • Output only. Unique identifier of the Rollout.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

• The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
• The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
• You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
• You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

• -o out
  • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional Method Properties

You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness.

• -p request-id=string

  • Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

• -p rollout-id=string

  • Required. ID of the Rollout.

• -p starting-phase-id=string

  • Optional. The starting phase ID for the Rollout. If empty the Rollout will start at the first phase.

• -p validate-only=boolean

  • Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

• -p $-xgafv=string

  • V1 error format.

• -p access-token=string

  • OAuth access token.

• -p alt=string

  • Data format for response.

• -p callback=string

  • JSONP

• -p fields=string

  • Selector specifying which fields to include in a partial response.

• -p key=string

  • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

• -p oauth-token=string

  • OAuth 2.0 token for the current user.

• -p pretty-print=boolean

  • Returns response with indentations and line breaks.

• -p quota-user=string

  • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• -p upload-type=string

  • Legacy upload protocol for media (e.g. "media", "multipart").

• -p upload-protocol=string

  • Upload protocol for media (e.g. "raw", "multipart").