Cloud Deploy API (clouddeploy:v1)

2023-11-02

8 removed methods

Deletions

    Methods

  • ▼ ▲ clouddeploy.projects.locations.deliveryPipelines.automations.create

      Path: v1/{+parent}/automations

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/automations

      HTTP Method: POST

      Parameters:

        parent

          Description: Required. The parent collection in which the `Automation` should be created. Format should be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}.

          Pattern: ^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+$

          Location: path

          Required: Yes

          Type: string

        automationId

          Description: Required. ID of the `Automation`.

          Location: query

          Type: string

        requestId

          Description: Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since 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).

          Location: query

          Type: string

        validateOnly

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

          Location: query

          Type: boolean

      Parameter Order: parent

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Creates a new Automation in a given project and location.

  • ▼ ▲ clouddeploy.projects.locations.deliveryPipelines.automations.patch

      Path: v1/{+name}

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/automations/{automationsId}

      HTTP Method: PATCH

      Parameters:

        name

          Description: Output only. Name of the `Automation`. Format is projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automations/{automation}.

          Pattern: ^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+/automations/[^/]+$

          Location: path

          Required: Yes

          Type: string

        updateMask

          Description: Required. Field mask is used to specify the fields to be overwritten in the `Automation` resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

          Location: query

          Type: string

          Format: google-fieldmask

        requestId

          Description: Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since 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).

          Location: query

          Type: string

        allowMissing

          Description: Optional. If set to true, updating a `Automation` that does not exist will result in the creation of a new `Automation`.

          Location: query

          Type: boolean

        validateOnly

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

          Location: query

          Type: boolean

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Updates the parameters of a single Automation resource.

  • ▼ ▲ clouddeploy.projects.locations.deliveryPipelines.automations.delete

      Path: v1/{+name}

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/automations/{automationsId}

      HTTP Method: DELETE

      Parameters:

        name

          Description: Required. The name of the `Automation` to delete. Format should be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/automations/{automation_name}.

          Pattern: ^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+/automations/[^/]+$

          Location: path

          Required: Yes

          Type: string

        requestId

          Description: Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee 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).

          Location: query

          Type: string

        allowMissing

          Description: Optional. If set to true, then deleting an already deleted or non-existing `Automation` will succeed.

          Location: query

          Type: boolean

        validateOnly

          Description: Optional. If set, validate the request and verify whether the resource exists, but do not actually post it.

          Location: query

          Type: boolean

        etag

          Description: Optional. The weak etag of the request. 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.

          Location: query

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Deletes a single Automation resource.

  • ▼ ▲ clouddeploy.projects.locations.deliveryPipelines.automations.get

      Path: v1/{+name}

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/automations/{automationsId}

      HTTP Method: GET

      Parameters:

        name

          Description: Required. Name of the `Automation`. Format must be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/automations/{automation_name}.

          Pattern: ^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+/automations/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Gets details of a single Automation.

  • ▼ ▲ clouddeploy.projects.locations.deliveryPipelines.automations.list

      Path: v1/{+parent}/automations

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/automations

      HTTP Method: GET

      Parameters:

        parent

          Description: Required. The parent, which owns this collection of automations. Format must be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}.

          Pattern: ^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+$

          Location: path

          Required: Yes

          Type: string

        pageSize

          Description: The maximum number of automations to return. The service may return fewer than this value. If unspecified, at most 50 automations will be returned. The maximum value is 1000; values above 1000 will be set to 1000.

          Location: query

          Type: integer

          Format: int32

        pageToken

          Description: A page token, received from a previous `ListAutomations` call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters match the call that provided the page token.

          Location: query

          Type: string

        filter

          Description: Filter automations to be returned. All fields can be used in the filter.

          Location: query

          Type: string

        orderBy

          Description: Field to sort by.

          Location: query

          Type: string

      Parameter Order: parent

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Lists Automations in a given project and location.

  • ▼ ▲ clouddeploy.projects.locations.deliveryPipelines.automationRuns.get

      Path: v1/{+name}

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/automationRuns/{automationRunsId}

      HTTP Method: GET

      Parameters:

        name

          Description: Required. Name of the `AutomationRun`. Format must be projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run}.

          Pattern: ^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+/automationRuns/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Gets details of a single AutomationRun.

  • ▼ ▲ clouddeploy.projects.locations.deliveryPipelines.automationRuns.list

      Path: v1/{+parent}/automationRuns

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/automationRuns

      HTTP Method: GET

      Parameters:

        parent

          Description: Required. The parent, which owns this collection of automationRuns. Format must be projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}.

          Pattern: ^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+$

          Location: path

          Required: Yes

          Type: string

        pageSize

          Description: The maximum number of automationRuns to return. The service may return fewer than this value. If unspecified, at most 50 automationRuns will be returned. The maximum value is 1000; values above 1000 will be set to 1000.

          Location: query

          Type: integer

          Format: int32

        pageToken

          Description: A page token, received from a previous `ListAutomationRuns` call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters match the call that provided the page token.

          Location: query

          Type: string

        filter

          Description: Filter automationRuns to be returned. All fields can be used in the filter.

          Location: query

          Type: string

        orderBy

          Description: Field to sort by.

          Location: query

          Type: string

      Parameter Order: parent

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Lists AutomationRuns in a given project and location.

  • ▼ ▲ clouddeploy.projects.locations.deliveryPipelines.automationRuns.cancel

      Path: v1/{+name}:cancel

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/automationRuns/{automationRunsId}:cancel

      HTTP Method: POST

      Parameters:

        name

          Description: Required. Name of the `AutomationRun`. Format is projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run}.

          Pattern: ^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+/automationRuns/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: 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.

8 new methods

Additions

    Methods

  • ▼ ▲ clouddeploy.projects.locations.deliveryPipelines.automations.create

      Path: v1/{+parent}/automations

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/automations

      HTTP Method: POST

      Parameters:

        parent

          Description: Required. The parent collection in which the `Automation` should be created. Format should be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}.

          Pattern: ^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+$

          Location: path

          Required: Yes

          Type: string

        automationId

          Description: Required. ID of the `Automation`.

          Location: query

          Type: string

        requestId

          Description: Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since 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).

          Location: query

          Type: string

        validateOnly

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

          Location: query

          Type: boolean

      Parameter Order: parent

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Creates a new Automation in a given project and location.

  • ▼ ▲ clouddeploy.projects.locations.deliveryPipelines.automations.patch

      Path: v1/{+name}

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/automations/{automationsId}

      HTTP Method: PATCH

      Parameters:

        name

          Description: Output only. Name of the `Automation`. Format is projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automations/{automation}.

          Pattern: ^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+/automations/[^/]+$

          Location: path

          Required: Yes

          Type: string

        updateMask

          Description: Required. Field mask is used to specify the fields to be overwritten in the `Automation` resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

          Location: query

          Type: string

          Format: google-fieldmask

        requestId

          Description: Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since 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).

          Location: query

          Type: string

        allowMissing

          Description: Optional. If set to true, updating a `Automation` that does not exist will result in the creation of a new `Automation`.

          Location: query

          Type: boolean

        validateOnly

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

          Location: query

          Type: boolean

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Updates the parameters of a single Automation resource.

  • ▼ ▲ clouddeploy.projects.locations.deliveryPipelines.automations.delete

      Path: v1/{+name}

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/automations/{automationsId}

      HTTP Method: DELETE

      Parameters:

        name

          Description: Required. The name of the `Automation` to delete. Format should be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/automations/{automation_name}.

          Pattern: ^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+/automations/[^/]+$

          Location: path

          Required: Yes

          Type: string

        requestId

          Description: Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee 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).

          Location: query

          Type: string

        allowMissing

          Description: Optional. If set to true, then deleting an already deleted or non-existing `Automation` will succeed.

          Location: query

          Type: boolean

        validateOnly

          Description: Optional. If set, validate the request and verify whether the resource exists, but do not actually post it.

          Location: query

          Type: boolean

        etag

          Description: Optional. The weak etag of the request. 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.

          Location: query

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Deletes a single Automation resource.

  • ▼ ▲ clouddeploy.projects.locations.deliveryPipelines.automations.get

      Path: v1/{+name}

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/automations/{automationsId}

      HTTP Method: GET

      Parameters:

        name

          Description: Required. Name of the `Automation`. Format must be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/automations/{automation_name}.

          Pattern: ^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+/automations/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Gets details of a single Automation.

  • ▼ ▲ clouddeploy.projects.locations.deliveryPipelines.automations.list

      Path: v1/{+parent}/automations

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/automations

      HTTP Method: GET

      Parameters:

        parent

          Description: Required. The parent, which owns this collection of automations. Format must be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}.

          Pattern: ^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+$

          Location: path

          Required: Yes

          Type: string

        pageSize

          Description: The maximum number of automations to return. The service may return fewer than this value. If unspecified, at most 50 automations will be returned. The maximum value is 1000; values above 1000 will be set to 1000.

          Location: query

          Type: integer

          Format: int32

        pageToken

          Description: A page token, received from a previous `ListAutomations` call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters match the call that provided the page token.

          Location: query

          Type: string

        filter

          Description: Filter automations to be returned. All fields can be used in the filter.

          Location: query

          Type: string

        orderBy

          Description: Field to sort by.

          Location: query

          Type: string

      Parameter Order: parent

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Lists Automations in a given project and location.

  • ▼ ▲ clouddeploy.projects.locations.deliveryPipelines.automationRuns.get

      Path: v1/{+name}

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/automationRuns/{automationRunsId}

      HTTP Method: GET

      Parameters:

        name

          Description: Required. Name of the `AutomationRun`. Format must be projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run}.

          Pattern: ^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+/automationRuns/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Gets details of a single AutomationRun.

  • ▼ ▲ clouddeploy.projects.locations.deliveryPipelines.automationRuns.list

      Path: v1/{+parent}/automationRuns

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/automationRuns

      HTTP Method: GET

      Parameters:

        parent

          Description: Required. The parent, which owns this collection of automationRuns. Format must be projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}.

          Pattern: ^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+$

          Location: path

          Required: Yes

          Type: string

        pageSize

          Description: The maximum number of automationRuns to return. The service may return fewer than this value. If unspecified, at most 50 automationRuns will be returned. The maximum value is 1000; values above 1000 will be set to 1000.

          Location: query

          Type: integer

          Format: int32

        pageToken

          Description: A page token, received from a previous `ListAutomationRuns` call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters match the call that provided the page token.

          Location: query

          Type: string

        filter

          Description: Filter automationRuns to be returned. All fields can be used in the filter.

          Location: query

          Type: string

        orderBy

          Description: Field to sort by.

          Location: query

          Type: string

      Parameter Order: parent

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Lists AutomationRuns in a given project and location.

  • ▼ ▲ clouddeploy.projects.locations.deliveryPipelines.automationRuns.cancel

      Path: v1/{+name}:cancel

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/automationRuns/{automationRunsId}:cancel

      HTTP Method: POST

      Parameters:

        name

          Description: Required. Name of the `AutomationRun`. Format is projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run}.

          Pattern: ^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+/automationRuns/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: 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.