+ close()
Close httplib2 connections.
+
+ create(parent, body=None, customTargetTypeId=None, requestId=None, validateOnly=None, x__xgafv=None)
Creates a new CustomTargetType in a given project and location.
+
+ delete(name, allowMissing=None, etag=None, requestId=None, validateOnly=None, x__xgafv=None)
Deletes a single CustomTargetType.
+ +Gets details of a single CustomTargetType.
+
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists CustomTargetTypes in a given project and location.
+ +Retrieves the next page of results.
+ +Updates a single CustomTargetType.
+close()
+ Close httplib2 connections.+
create(parent, body=None, customTargetTypeId=None, requestId=None, validateOnly=None, x__xgafv=None)
+ Creates a new CustomTargetType in a given project and location.
+
+Args:
+ parent: string, Required. The parent collection in which the `CustomTargetType` should be created in. Format should be `projects/{project_id}/locations/{location_name}`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # 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 a runtime that does not have a 1P integration with Cloud Deploy.
+ "annotations": { # Optional. 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.
+ "a_key": "A String",
+ },
+ "createTime": "A String", # Output only. Time at which the `CustomTargetType` was created.
+ "customActions": { # CustomTargetSkaffoldActions represents the `CustomTargetType` configuration using Skaffold custom actions. # Configures render and deploy for the `CustomTargetType` using Skaffold custom actions.
+ "deployAction": "A String", # Required. The Skaffold custom action responsible for deploy operations.
+ "includeSkaffoldModules": [ # Optional. List of Skaffold modules Cloud Deploy will include in the Skaffold Config as required before performing diagnose.
+ { # Skaffold Config modules and their remote source.
+ "configs": [ # Optional. The Skaffold Config modules to use from the specified source.
+ "A String",
+ ],
+ "git": { # Git repository containing Skaffold Config modules. # Remote git repository containing the Skaffold Config modules.
+ "path": "A String", # Optional. Relative path from the repository root to the Skaffold file.
+ "ref": "A String", # Optional. Git ref the package should be cloned from.
+ "repo": "A String", # Required. Git repository the package should be cloned from.
+ },
+ "googleCloudStorage": { # Cloud Storage bucket containing Skaffold Config modules. # Cloud Storage bucket containing the Skaffold Config modules.
+ "path": "A String", # Optional. Relative path from the source to the Skaffold file.
+ "source": "A String", # Required. Cloud Storage source paths to copy recursively. For example, providing "gs://my-bucket/dir/configs/*" will result in Skaffold copying all files within the "dir/configs" directory in the bucket "my-bucket".
+ },
+ },
+ ],
+ "renderAction": "A String", # Optional. The Skaffold custom action responsible for render operations. If not provided then Cloud Deploy will perform the render operations via `skaffold render`.
+ },
+ "customTargetTypeId": "A String", # Output only. Resource id of the `CustomTargetType`.
+ "description": "A String", # Optional. Description of the `CustomTargetType`. Max length is 255 characters.
+ "etag": "A String", # Optional. 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.
+ "labels": { # Optional. 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.
+ "a_key": "A String",
+ },
+ "name": "A String", # Optional. Name of the `CustomTargetType`. Format is `projects/{project}/locations/{location}/customTargetTypes/a-z{0,62}`.
+ "uid": "A String", # Output only. Unique identifier of the `CustomTargetType`.
+ "updateTime": "A String", # Output only. Most recent time at which the `CustomTargetType` was updated.
+}
+
+ customTargetTypeId: string, Required. ID of the `CustomTargetType`.
+ requestId: string, 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).
+ validateOnly: 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.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # 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](https://github.com/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](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+delete(name, allowMissing=None, etag=None, requestId=None, validateOnly=None, x__xgafv=None)
+ Deletes a single CustomTargetType.
+
+Args:
+ name: string, Required. The name of the `CustomTargetType` to delete. Format must be `projects/{project_id}/locations/{location_name}/customTargetTypes/{custom_target_type}`. (required)
+ allowMissing: boolean, Optional. If set to true, then deleting an already deleted or non-existing `CustomTargetType` will succeed.
+ etag: string, Optional. 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.
+ requestId: string, 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).
+ validateOnly: boolean, Optional. If set to true, the request is validated but no actual change is made.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # 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](https://github.com/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](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+get(name, x__xgafv=None)
+ Gets details of a single CustomTargetType.
+
+Args:
+ name: string, Required. Name of the `CustomTargetType`. Format must be `projects/{project_id}/locations/{location_name}/customTargetTypes/{custom_target_type}`. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # 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 a runtime that does not have a 1P integration with Cloud Deploy.
+ "annotations": { # Optional. 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.
+ "a_key": "A String",
+ },
+ "createTime": "A String", # Output only. Time at which the `CustomTargetType` was created.
+ "customActions": { # CustomTargetSkaffoldActions represents the `CustomTargetType` configuration using Skaffold custom actions. # Configures render and deploy for the `CustomTargetType` using Skaffold custom actions.
+ "deployAction": "A String", # Required. The Skaffold custom action responsible for deploy operations.
+ "includeSkaffoldModules": [ # Optional. List of Skaffold modules Cloud Deploy will include in the Skaffold Config as required before performing diagnose.
+ { # Skaffold Config modules and their remote source.
+ "configs": [ # Optional. The Skaffold Config modules to use from the specified source.
+ "A String",
+ ],
+ "git": { # Git repository containing Skaffold Config modules. # Remote git repository containing the Skaffold Config modules.
+ "path": "A String", # Optional. Relative path from the repository root to the Skaffold file.
+ "ref": "A String", # Optional. Git ref the package should be cloned from.
+ "repo": "A String", # Required. Git repository the package should be cloned from.
+ },
+ "googleCloudStorage": { # Cloud Storage bucket containing Skaffold Config modules. # Cloud Storage bucket containing the Skaffold Config modules.
+ "path": "A String", # Optional. Relative path from the source to the Skaffold file.
+ "source": "A String", # Required. Cloud Storage source paths to copy recursively. For example, providing "gs://my-bucket/dir/configs/*" will result in Skaffold copying all files within the "dir/configs" directory in the bucket "my-bucket".
+ },
+ },
+ ],
+ "renderAction": "A String", # Optional. The Skaffold custom action responsible for render operations. If not provided then Cloud Deploy will perform the render operations via `skaffold render`.
+ },
+ "customTargetTypeId": "A String", # Output only. Resource id of the `CustomTargetType`.
+ "description": "A String", # Optional. Description of the `CustomTargetType`. Max length is 255 characters.
+ "etag": "A String", # Optional. 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.
+ "labels": { # Optional. 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.
+ "a_key": "A String",
+ },
+ "name": "A String", # Optional. Name of the `CustomTargetType`. Format is `projects/{project}/locations/{location}/customTargetTypes/a-z{0,62}`.
+ "uid": "A String", # Output only. Unique identifier of the `CustomTargetType`.
+ "updateTime": "A String", # Output only. Most recent time at which the `CustomTargetType` was updated.
+}
+list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists CustomTargetTypes in a given project and location.
+
+Args:
+ parent: string, Required. The parent that owns this collection of custom target types. Format must be `projects/{project_id}/locations/{location_name}`. (required)
+ filter: string, Optional. Filter custom target types to be returned. See https://google.aip.dev/160 for more details.
+ orderBy: string, Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details.
+ pageSize: integer, Optional. The maximum number of `CustomTargetType` objects to return. The service may return fewer than this value. If unspecified, at most 50 `CustomTargetType` objects will be returned. The maximum value is 1000; values above 1000 will be set to 1000.
+ pageToken: string, Optional. A page token, received from a previous `ListCustomTargetTypes` call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters match the call that provided the page token.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The response object from `ListCustomTargetTypes.`
+ "customTargetTypes": [ # The `CustomTargetType` objects.
+ { # 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 a runtime that does not have a 1P integration with Cloud Deploy.
+ "annotations": { # Optional. 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.
+ "a_key": "A String",
+ },
+ "createTime": "A String", # Output only. Time at which the `CustomTargetType` was created.
+ "customActions": { # CustomTargetSkaffoldActions represents the `CustomTargetType` configuration using Skaffold custom actions. # Configures render and deploy for the `CustomTargetType` using Skaffold custom actions.
+ "deployAction": "A String", # Required. The Skaffold custom action responsible for deploy operations.
+ "includeSkaffoldModules": [ # Optional. List of Skaffold modules Cloud Deploy will include in the Skaffold Config as required before performing diagnose.
+ { # Skaffold Config modules and their remote source.
+ "configs": [ # Optional. The Skaffold Config modules to use from the specified source.
+ "A String",
+ ],
+ "git": { # Git repository containing Skaffold Config modules. # Remote git repository containing the Skaffold Config modules.
+ "path": "A String", # Optional. Relative path from the repository root to the Skaffold file.
+ "ref": "A String", # Optional. Git ref the package should be cloned from.
+ "repo": "A String", # Required. Git repository the package should be cloned from.
+ },
+ "googleCloudStorage": { # Cloud Storage bucket containing Skaffold Config modules. # Cloud Storage bucket containing the Skaffold Config modules.
+ "path": "A String", # Optional. Relative path from the source to the Skaffold file.
+ "source": "A String", # Required. Cloud Storage source paths to copy recursively. For example, providing "gs://my-bucket/dir/configs/*" will result in Skaffold copying all files within the "dir/configs" directory in the bucket "my-bucket".
+ },
+ },
+ ],
+ "renderAction": "A String", # Optional. The Skaffold custom action responsible for render operations. If not provided then Cloud Deploy will perform the render operations via `skaffold render`.
+ },
+ "customTargetTypeId": "A String", # Output only. Resource id of the `CustomTargetType`.
+ "description": "A String", # Optional. Description of the `CustomTargetType`. Max length is 255 characters.
+ "etag": "A String", # Optional. 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.
+ "labels": { # Optional. 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.
+ "a_key": "A String",
+ },
+ "name": "A String", # Optional. Name of the `CustomTargetType`. Format is `projects/{project}/locations/{location}/customTargetTypes/a-z{0,62}`.
+ "uid": "A String", # Output only. Unique identifier of the `CustomTargetType`.
+ "updateTime": "A String", # Output only. Most recent time at which the `CustomTargetType` was updated.
+ },
+ ],
+ "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+ "unreachable": [ # Locations that could not be reached.
+ "A String",
+ ],
+}
+list_next()
+ Retrieves the next page of results. + + Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + + Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++
patch(name, allowMissing=None, body=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)
+ Updates a single CustomTargetType.
+
+Args:
+ name: string, Optional. Name of the `CustomTargetType`. Format is `projects/{project}/locations/{location}/customTargetTypes/a-z{0,62}`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # 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 a runtime that does not have a 1P integration with Cloud Deploy.
+ "annotations": { # Optional. 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.
+ "a_key": "A String",
+ },
+ "createTime": "A String", # Output only. Time at which the `CustomTargetType` was created.
+ "customActions": { # CustomTargetSkaffoldActions represents the `CustomTargetType` configuration using Skaffold custom actions. # Configures render and deploy for the `CustomTargetType` using Skaffold custom actions.
+ "deployAction": "A String", # Required. The Skaffold custom action responsible for deploy operations.
+ "includeSkaffoldModules": [ # Optional. List of Skaffold modules Cloud Deploy will include in the Skaffold Config as required before performing diagnose.
+ { # Skaffold Config modules and their remote source.
+ "configs": [ # Optional. The Skaffold Config modules to use from the specified source.
+ "A String",
+ ],
+ "git": { # Git repository containing Skaffold Config modules. # Remote git repository containing the Skaffold Config modules.
+ "path": "A String", # Optional. Relative path from the repository root to the Skaffold file.
+ "ref": "A String", # Optional. Git ref the package should be cloned from.
+ "repo": "A String", # Required. Git repository the package should be cloned from.
+ },
+ "googleCloudStorage": { # Cloud Storage bucket containing Skaffold Config modules. # Cloud Storage bucket containing the Skaffold Config modules.
+ "path": "A String", # Optional. Relative path from the source to the Skaffold file.
+ "source": "A String", # Required. Cloud Storage source paths to copy recursively. For example, providing "gs://my-bucket/dir/configs/*" will result in Skaffold copying all files within the "dir/configs" directory in the bucket "my-bucket".
+ },
+ },
+ ],
+ "renderAction": "A String", # Optional. The Skaffold custom action responsible for render operations. If not provided then Cloud Deploy will perform the render operations via `skaffold render`.
+ },
+ "customTargetTypeId": "A String", # Output only. Resource id of the `CustomTargetType`.
+ "description": "A String", # Optional. Description of the `CustomTargetType`. Max length is 255 characters.
+ "etag": "A String", # Optional. 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.
+ "labels": { # Optional. 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.
+ "a_key": "A String",
+ },
+ "name": "A String", # Optional. Name of the `CustomTargetType`. Format is `projects/{project}/locations/{location}/customTargetTypes/a-z{0,62}`.
+ "uid": "A String", # Output only. Unique identifier of the `CustomTargetType`.
+ "updateTime": "A String", # Output only. Most recent time at which the `CustomTargetType` was updated.
+}
+
+ allowMissing: boolean, Optional. If set to true, updating a `CustomTargetType` that does not exist will result in the creation of a new `CustomTargetType`.
+ requestId: string, 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).
+ updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the `CustomTargetType` 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.
+ validateOnly: 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.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # 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](https://github.com/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](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+Lists AutomationRuns in a given project and location.
Args:
- parent: string, Required. The parent, which owns this collection of automationRuns. Format must be `projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}`. (required)
+ parent: string, Required. The parent `Delivery Pipeline`, which owns this collection of automationRuns. Format must be `projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}`. (required)
filter: string, Filter automationRuns to be returned. All fields can be used in the filter.
orderBy: string, Field to sort by.
pageSize: integer, 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.
@@ -300,15 +302,15 @@ Method Details
{ # The response object from `ListAutomationRuns`.
"automationRuns": [ # The `AutomationRuns` objects.
- { # An `AutomationRun` resource in the Cloud Deploy API. An `AutomationRun` represents an automation execution instance of an automation rule.
+ { # An `AutomationRun` resource in the Cloud Deploy API. An `AutomationRun` represents an execution instance of an automation rule.
"advanceRolloutOperation": { # Contains the information of an automated advance-rollout operation. # Output only. Advances a rollout to the next phase.
- "destinationPhase": "A String", # Output only. The phase to which the rollout will be advanced to.
+ "destinationPhase": "A String", # Output only. The phase the rollout will be advanced to.
"rollout": "A String", # Output only. The name of the rollout that initiates the `AutomationRun`.
"sourcePhase": "A String", # Output only. The phase of a deployment that initiated the operation.
"wait": "A String", # Output only. How long the operation will be paused.
},
"automationId": "A String", # Output only. The ID of the automation that initiated the operation.
- "automationSnapshot": { # 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 amongst Targets, Rollout repair and Rollout deployment strategy advancement. The intention of Automation is to reduce manual intervention in the continuous delivery process. # Output only. Snapshot of the Automation taken at AutomationRun creation time.
+ "automationSnapshot": { # 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. # Output only. Snapshot of the Automation taken at AutomationRun creation time.
"annotations": { # Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. Annotations must meet the following constraints: * Annotations are key/value pairs. * Valid annotation keys have two segments: an optional prefix and name, separated by a slash (`/`). * The name segment is required and must be 63 characters or less, beginning and ending with an alphanumeric character (`[a-z0-9A-Z]`) with dashes (`-`), underscores (`_`), dots (`.`), and alphanumerics between. * The prefix is optional. If specified, the prefix must be a DNS subdomain: a series of DNS labels separated by dots(`.`), not longer than 253 characters in total, followed by a slash (`/`). See https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#syntax-and-character-set for more details.
"a_key": "A String",
},
@@ -323,7 +325,7 @@ Method Details
{ # `AutomationRule` defines the automation activities.
"advanceRolloutRule": { # The `AdvanceRollout` automation rule will automatically advance a successful Rollout to the next phase. # Optional. The `AdvanceRolloutRule` will automatically advance a successful Rollout.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the Automation rule.
- "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
+ "targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
@@ -339,7 +341,7 @@ Method Details
},
"promoteReleaseRule": { # `PromoteRelease` rule will automatically promote a release from the current target to a specified target. # Optional. `PromoteReleaseRule` will automatically promote a release from the current target to a specified target.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the Automation rule.
- "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
+ "targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
@@ -354,7 +356,7 @@ Method Details
},
"repairRolloutRule": { # The `RepairRolloutRule` automation rule will automatically repair a failed `Rollout`. # Optional. The `RepairRolloutRule` will automatically repair a failed rollout.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the 'Automation' rule.
- "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
+ "targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
@@ -369,7 +371,7 @@ Method Details
"repairModes": [ # Required. Defines the types of automatic repair actions for failed jobs.
{ # Configuration of the repair action.
"retry": { # Retries the failed job. # Optional. Retries a failed job.
- "attempts": "A String", # Required. Total number of retries. Retry will skipped if set to 0; The minimum value is 1, and the maximum value is 10.
+ "attempts": "A String", # Required. Total number of retries. Retry is skipped if set to 0; The minimum value is 1, and the maximum value is 10.
"backoffMode": "A String", # Optional. The pattern of how wait time will be increased. Default is linear. Backoff mode will be ignored if `wait` is 0.
"wait": "A String", # Optional. How long to wait for the first retry. Default is 0, and the maximum value is 14d.
},
@@ -401,7 +403,7 @@ Method Details
},
"createTime": "A String", # Output only. Time at which the `AutomationRun` was created.
"etag": "A String", # Output only. The weak etag of the `AutomationRun` resource. 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.
- "expireTime": "A String", # Output only. Time the `AutomationRun` will expire. An `AutomationRun` will expire after 14 days from its creation date.
+ "expireTime": "A String", # Output only. Time the `AutomationRun` expires. An `AutomationRun` expires after 14 days from its creation date.
"name": "A String", # Output only. Name of the `AutomationRun`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run}`.
"promoteReleaseOperation": { # Contains the information of an automated promote-release operation. # Output only. Promotes a release to a specified 'Target'.
"phase": "A String", # Output only. The starting phase of the rollout created by this operation.
@@ -411,6 +413,8 @@ Method Details
},
"repairRolloutOperation": { # Contains the information for an automated `repair rollout` operation. # Output only. Repairs a failed 'Rollout'.
"currentRepairModeIndex": "A String", # Output only. The index of the current repair action in the repair sequence.
+ "jobId": "A String", # Output only. The job ID for the Job to repair.
+ "phaseId": "A String", # Output only. The phase ID of the phase that includes the job being repaired.
"repairPhases": [ # Output only. Records of the repair attempts. Each repair phase may have multiple retry attempts or single rollback attempt.
{ # RepairPhase tracks the repair attempts that have been made for each `RepairMode` specified in the `Automation` resource.
"retry": { # RetryPhase contains the retry attempts and the metadata for initiating a new attempt. # Output only. Records of the retry attempts for retry repair mode.
@@ -440,7 +444,7 @@ Method Details
"ruleId": "A String", # Output only. The ID of the automation rule that initiated the operation.
"serviceAccount": "A String", # Output only. Email address of the user-managed IAM service account that performs the operations against Cloud Deploy resources.
"state": "A String", # Output only. Current state of the `AutomationRun`.
- "stateDescription": "A String", # Output only. Explains the current state of the `AutomationRun`. Present only an explanation is needed.
+ "stateDescription": "A String", # Output only. Explains the current state of the `AutomationRun`. Present only when an explanation is needed.
"targetId": "A String", # Output only. The ID of the target that represents the promotion stage that initiates the `AutomationRun`. The value of this field is the last segment of a target name.
"updateTime": "A String", # Output only. Time at which the automationRun was updated.
"waitUntilTime": "A String", # Output only. Earliest time the `AutomationRun` will attempt to resume. Wait-time is configured by `wait` in automation rule.
diff --git a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.automations.html b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.automations.html
index 013c3164b0..149a263ab1 100644
--- a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.automations.html
+++ b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.automations.html
@@ -110,7 +110,7 @@ Method Details
body: object, The request body.
The object takes the form of:
-{ # 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 amongst Targets, Rollout repair and Rollout deployment strategy advancement. The intention of Automation is to reduce manual intervention in the continuous delivery process.
+{ # 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.
"annotations": { # Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. Annotations must meet the following constraints: * Annotations are key/value pairs. * Valid annotation keys have two segments: an optional prefix and name, separated by a slash (`/`). * The name segment is required and must be 63 characters or less, beginning and ending with an alphanumeric character (`[a-z0-9A-Z]`) with dashes (`-`), underscores (`_`), dots (`.`), and alphanumerics between. * The prefix is optional. If specified, the prefix must be a DNS subdomain: a series of DNS labels separated by dots(`.`), not longer than 253 characters in total, followed by a slash (`/`). See https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#syntax-and-character-set for more details.
"a_key": "A String",
},
@@ -125,7 +125,7 @@ Method Details
{ # `AutomationRule` defines the automation activities.
"advanceRolloutRule": { # The `AdvanceRollout` automation rule will automatically advance a successful Rollout to the next phase. # Optional. The `AdvanceRolloutRule` will automatically advance a successful Rollout.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the Automation rule.
- "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
+ "targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
@@ -141,7 +141,7 @@ Method Details
},
"promoteReleaseRule": { # `PromoteRelease` rule will automatically promote a release from the current target to a specified target. # Optional. `PromoteReleaseRule` will automatically promote a release from the current target to a specified target.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the Automation rule.
- "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
+ "targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
@@ -156,7 +156,7 @@ Method Details
},
"repairRolloutRule": { # The `RepairRolloutRule` automation rule will automatically repair a failed `Rollout`. # Optional. The `RepairRolloutRule` will automatically repair a failed rollout.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the 'Automation' rule.
- "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
+ "targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
@@ -171,7 +171,7 @@ Method Details
"repairModes": [ # Required. Defines the types of automatic repair actions for failed jobs.
{ # Configuration of the repair action.
"retry": { # Retries the failed job. # Optional. Retries a failed job.
- "attempts": "A String", # Required. Total number of retries. Retry will skipped if set to 0; The minimum value is 1, and the maximum value is 10.
+ "attempts": "A String", # Required. Total number of retries. Retry is skipped if set to 0; The minimum value is 1, and the maximum value is 10.
"backoffMode": "A String", # Optional. The pattern of how wait time will be increased. Default is linear. Backoff mode will be ignored if `wait` is 0.
"wait": "A String", # Optional. How long to wait for the first retry. Default is 0, and the maximum value is 14d.
},
@@ -287,7 +287,7 @@ Method Details
Returns:
An object of the form:
- { # 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 amongst Targets, Rollout repair and Rollout deployment strategy advancement. The intention of Automation is to reduce manual intervention in the continuous delivery process.
+ { # 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.
"annotations": { # Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. Annotations must meet the following constraints: * Annotations are key/value pairs. * Valid annotation keys have two segments: an optional prefix and name, separated by a slash (`/`). * The name segment is required and must be 63 characters or less, beginning and ending with an alphanumeric character (`[a-z0-9A-Z]`) with dashes (`-`), underscores (`_`), dots (`.`), and alphanumerics between. * The prefix is optional. If specified, the prefix must be a DNS subdomain: a series of DNS labels separated by dots(`.`), not longer than 253 characters in total, followed by a slash (`/`). See https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#syntax-and-character-set for more details.
"a_key": "A String",
},
@@ -302,7 +302,7 @@ Method Details
{ # `AutomationRule` defines the automation activities.
"advanceRolloutRule": { # The `AdvanceRollout` automation rule will automatically advance a successful Rollout to the next phase. # Optional. The `AdvanceRolloutRule` will automatically advance a successful Rollout.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the Automation rule.
- "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
+ "targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
@@ -318,7 +318,7 @@ Method Details
},
"promoteReleaseRule": { # `PromoteRelease` rule will automatically promote a release from the current target to a specified target. # Optional. `PromoteReleaseRule` will automatically promote a release from the current target to a specified target.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the Automation rule.
- "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
+ "targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
@@ -333,7 +333,7 @@ Method Details
},
"repairRolloutRule": { # The `RepairRolloutRule` automation rule will automatically repair a failed `Rollout`. # Optional. The `RepairRolloutRule` will automatically repair a failed rollout.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the 'Automation' rule.
- "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
+ "targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
@@ -348,7 +348,7 @@ Method Details
"repairModes": [ # Required. Defines the types of automatic repair actions for failed jobs.
{ # Configuration of the repair action.
"retry": { # Retries the failed job. # Optional. Retries a failed job.
- "attempts": "A String", # Required. Total number of retries. Retry will skipped if set to 0; The minimum value is 1, and the maximum value is 10.
+ "attempts": "A String", # Required. Total number of retries. Retry is skipped if set to 0; The minimum value is 1, and the maximum value is 10.
"backoffMode": "A String", # Optional. The pattern of how wait time will be increased. Default is linear. Backoff mode will be ignored if `wait` is 0.
"wait": "A String", # Optional. How long to wait for the first retry. Default is 0, and the maximum value is 14d.
},
@@ -385,7 +385,7 @@ Method Details
Lists Automations in a given project and location.
Args:
- parent: string, Required. The parent, which owns this collection of automations. Format must be `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`. (required)
+ parent: string, Required. The parent `Delivery Pipeline`, which owns this collection of automations. Format must be `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`. (required)
filter: string, Filter automations to be returned. All fields can be used in the filter.
orderBy: string, Field to sort by.
pageSize: integer, 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.
@@ -399,8 +399,8 @@ Method Details
An object of the form:
{ # The response object from `ListAutomations`.
- "automations": [ # The `Automations` objects.
- { # 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 amongst Targets, Rollout repair and Rollout deployment strategy advancement. The intention of Automation is to reduce manual intervention in the continuous delivery process.
+ "automations": [ # The `Automation` objects.
+ { # 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.
"annotations": { # Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. Annotations must meet the following constraints: * Annotations are key/value pairs. * Valid annotation keys have two segments: an optional prefix and name, separated by a slash (`/`). * The name segment is required and must be 63 characters or less, beginning and ending with an alphanumeric character (`[a-z0-9A-Z]`) with dashes (`-`), underscores (`_`), dots (`.`), and alphanumerics between. * The prefix is optional. If specified, the prefix must be a DNS subdomain: a series of DNS labels separated by dots(`.`), not longer than 253 characters in total, followed by a slash (`/`). See https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#syntax-and-character-set for more details.
"a_key": "A String",
},
@@ -415,7 +415,7 @@ Method Details
{ # `AutomationRule` defines the automation activities.
"advanceRolloutRule": { # The `AdvanceRollout` automation rule will automatically advance a successful Rollout to the next phase. # Optional. The `AdvanceRolloutRule` will automatically advance a successful Rollout.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the Automation rule.
- "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
+ "targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
@@ -431,7 +431,7 @@ Method Details
},
"promoteReleaseRule": { # `PromoteRelease` rule will automatically promote a release from the current target to a specified target. # Optional. `PromoteReleaseRule` will automatically promote a release from the current target to a specified target.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the Automation rule.
- "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
+ "targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
@@ -446,7 +446,7 @@ Method Details
},
"repairRolloutRule": { # The `RepairRolloutRule` automation rule will automatically repair a failed `Rollout`. # Optional. The `RepairRolloutRule` will automatically repair a failed rollout.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the 'Automation' rule.
- "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
+ "targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
@@ -461,7 +461,7 @@ Method Details
"repairModes": [ # Required. Defines the types of automatic repair actions for failed jobs.
{ # Configuration of the repair action.
"retry": { # Retries the failed job. # Optional. Retries a failed job.
- "attempts": "A String", # Required. Total number of retries. Retry will skipped if set to 0; The minimum value is 1, and the maximum value is 10.
+ "attempts": "A String", # Required. Total number of retries. Retry is skipped if set to 0; The minimum value is 1, and the maximum value is 10.
"backoffMode": "A String", # Optional. The pattern of how wait time will be increased. Default is linear. Backoff mode will be ignored if `wait` is 0.
"wait": "A String", # Optional. How long to wait for the first retry. Default is 0, and the maximum value is 14d.
},
@@ -522,7 +522,7 @@ Method Details
body: object, The request body.
The object takes the form of:
-{ # 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 amongst Targets, Rollout repair and Rollout deployment strategy advancement. The intention of Automation is to reduce manual intervention in the continuous delivery process.
+{ # 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.
"annotations": { # Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. Annotations must meet the following constraints: * Annotations are key/value pairs. * Valid annotation keys have two segments: an optional prefix and name, separated by a slash (`/`). * The name segment is required and must be 63 characters or less, beginning and ending with an alphanumeric character (`[a-z0-9A-Z]`) with dashes (`-`), underscores (`_`), dots (`.`), and alphanumerics between. * The prefix is optional. If specified, the prefix must be a DNS subdomain: a series of DNS labels separated by dots(`.`), not longer than 253 characters in total, followed by a slash (`/`). See https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#syntax-and-character-set for more details.
"a_key": "A String",
},
@@ -537,7 +537,7 @@ Method Details
{ # `AutomationRule` defines the automation activities.
"advanceRolloutRule": { # The `AdvanceRollout` automation rule will automatically advance a successful Rollout to the next phase. # Optional. The `AdvanceRolloutRule` will automatically advance a successful Rollout.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the Automation rule.
- "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
+ "targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
@@ -553,7 +553,7 @@ Method Details
},
"promoteReleaseRule": { # `PromoteRelease` rule will automatically promote a release from the current target to a specified target. # Optional. `PromoteReleaseRule` will automatically promote a release from the current target to a specified target.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the Automation rule.
- "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
+ "targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
@@ -568,7 +568,7 @@ Method Details
},
"repairRolloutRule": { # The `RepairRolloutRule` automation rule will automatically repair a failed `Rollout`. # Optional. The `RepairRolloutRule` will automatically repair a failed rollout.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the 'Automation' rule.
- "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
+ "targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
@@ -583,7 +583,7 @@ Method Details
"repairModes": [ # Required. Defines the types of automatic repair actions for failed jobs.
{ # Configuration of the repair action.
"retry": { # Retries the failed job. # Optional. Retries a failed job.
- "attempts": "A String", # Required. Total number of retries. Retry will skipped if set to 0; The minimum value is 1, and the maximum value is 10.
+ "attempts": "A String", # Required. Total number of retries. Retry is skipped if set to 0; The minimum value is 1, and the maximum value is 10.
"backoffMode": "A String", # Optional. The pattern of how wait time will be increased. Default is linear. Backoff mode will be ignored if `wait` is 0.
"wait": "A String", # Optional. How long to wait for the first retry. Default is 0, and the maximum value is 14d.
},
diff --git a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.html b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.html
index 460d822c03..fce5aa7ca2 100644
--- a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.html
+++ b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.html
@@ -146,7 +146,7 @@ Method Details
"status": True or False, # True if the Pipeline is in a valid state. Otherwise at least one condition in `PipelineCondition` is in an invalid state. Iterate over those conditions and see which condition(s) has status = false to find out what is wrong with the Pipeline.
"updateTime": "A String", # Last time the condition was updated.
},
- "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Details around targets enumerated in the pipeline.
+ "targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Details around targets enumerated in the pipeline.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
@@ -224,6 +224,15 @@ Method Details
"runtimeConfig": { # RuntimeConfig contains the runtime specific configurations for a deployment strategy. # Optional. Runtime specific configurations for the deployment strategy. The runtime configuration is used to determine how Cloud Deploy will split traffic to enable a progressive deployment.
"cloudRun": { # CloudRunConfig contains the Cloud Run runtime configuration. # Cloud Run runtime configuration.
"automaticTrafficControl": True or False, # Whether Cloud Deploy should update the traffic stanza in a Cloud Run Service on the user's behalf to facilitate traffic splitting. This is required to be true for CanaryDeployments, but optional for CustomCanaryDeployments.
+ "canaryRevisionTags": [ # Optional. A list of tags that are added to the canary revision while the canary deployment is in progress.
+ "A String",
+ ],
+ "priorRevisionTags": [ # Optional. A list of tags that are added to the prior revision while the canary deployment is in progress.
+ "A String",
+ ],
+ "stableRevisionTags": [ # Optional. A list of tags that are added to the final stable revision after the canary deployment is completed.
+ "A String",
+ ],
},
"kubernetes": { # KubernetesConfig contains the Kubernetes runtime configuration. # Kubernetes runtime configuration.
"gatewayServiceMesh": { # Information about the Kubernetes Gateway API service mesh configuration. # Kubernetes Gateway API service mesh configuration.
@@ -358,7 +367,7 @@ Method Details
"status": True or False, # True if the Pipeline is in a valid state. Otherwise at least one condition in `PipelineCondition` is in an invalid state. Iterate over those conditions and see which condition(s) has status = false to find out what is wrong with the Pipeline.
"updateTime": "A String", # Last time the condition was updated.
},
- "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Details around targets enumerated in the pipeline.
+ "targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Details around targets enumerated in the pipeline.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
@@ -436,6 +445,15 @@ Method Details
"runtimeConfig": { # RuntimeConfig contains the runtime specific configurations for a deployment strategy. # Optional. Runtime specific configurations for the deployment strategy. The runtime configuration is used to determine how Cloud Deploy will split traffic to enable a progressive deployment.
"cloudRun": { # CloudRunConfig contains the Cloud Run runtime configuration. # Cloud Run runtime configuration.
"automaticTrafficControl": True or False, # Whether Cloud Deploy should update the traffic stanza in a Cloud Run Service on the user's behalf to facilitate traffic splitting. This is required to be true for CanaryDeployments, but optional for CustomCanaryDeployments.
+ "canaryRevisionTags": [ # Optional. A list of tags that are added to the canary revision while the canary deployment is in progress.
+ "A String",
+ ],
+ "priorRevisionTags": [ # Optional. A list of tags that are added to the prior revision while the canary deployment is in progress.
+ "A String",
+ ],
+ "stableRevisionTags": [ # Optional. A list of tags that are added to the final stable revision after the canary deployment is completed.
+ "A String",
+ ],
},
"kubernetes": { # KubernetesConfig contains the Kubernetes runtime configuration. # Kubernetes runtime configuration.
"gatewayServiceMesh": { # Information about the Kubernetes Gateway API service mesh configuration. # Kubernetes Gateway API service mesh configuration.
@@ -553,7 +571,7 @@ Method Details
"status": True or False, # True if the Pipeline is in a valid state. Otherwise at least one condition in `PipelineCondition` is in an invalid state. Iterate over those conditions and see which condition(s) has status = false to find out what is wrong with the Pipeline.
"updateTime": "A String", # Last time the condition was updated.
},
- "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Details around targets enumerated in the pipeline.
+ "targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Details around targets enumerated in the pipeline.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
@@ -631,6 +649,15 @@ Method Details
"runtimeConfig": { # RuntimeConfig contains the runtime specific configurations for a deployment strategy. # Optional. Runtime specific configurations for the deployment strategy. The runtime configuration is used to determine how Cloud Deploy will split traffic to enable a progressive deployment.
"cloudRun": { # CloudRunConfig contains the Cloud Run runtime configuration. # Cloud Run runtime configuration.
"automaticTrafficControl": True or False, # Whether Cloud Deploy should update the traffic stanza in a Cloud Run Service on the user's behalf to facilitate traffic splitting. This is required to be true for CanaryDeployments, but optional for CustomCanaryDeployments.
+ "canaryRevisionTags": [ # Optional. A list of tags that are added to the canary revision while the canary deployment is in progress.
+ "A String",
+ ],
+ "priorRevisionTags": [ # Optional. A list of tags that are added to the prior revision while the canary deployment is in progress.
+ "A String",
+ ],
+ "stableRevisionTags": [ # Optional. A list of tags that are added to the final stable revision after the canary deployment is completed.
+ "A String",
+ ],
},
"kubernetes": { # KubernetesConfig contains the Kubernetes runtime configuration. # Kubernetes runtime configuration.
"gatewayServiceMesh": { # Information about the Kubernetes Gateway API service mesh configuration. # Kubernetes Gateway API service mesh configuration.
@@ -709,7 +736,7 @@ Method Details
"status": True or False, # True if the Pipeline is in a valid state. Otherwise at least one condition in `PipelineCondition` is in an invalid state. Iterate over those conditions and see which condition(s) has status = false to find out what is wrong with the Pipeline.
"updateTime": "A String", # Last time the condition was updated.
},
- "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Details around targets enumerated in the pipeline.
+ "targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Details around targets enumerated in the pipeline.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
@@ -787,6 +814,15 @@ Method Details
"runtimeConfig": { # RuntimeConfig contains the runtime specific configurations for a deployment strategy. # Optional. Runtime specific configurations for the deployment strategy. The runtime configuration is used to determine how Cloud Deploy will split traffic to enable a progressive deployment.
"cloudRun": { # CloudRunConfig contains the Cloud Run runtime configuration. # Cloud Run runtime configuration.
"automaticTrafficControl": True or False, # Whether Cloud Deploy should update the traffic stanza in a Cloud Run Service on the user's behalf to facilitate traffic splitting. This is required to be true for CanaryDeployments, but optional for CustomCanaryDeployments.
+ "canaryRevisionTags": [ # Optional. A list of tags that are added to the canary revision while the canary deployment is in progress.
+ "A String",
+ ],
+ "priorRevisionTags": [ # Optional. A list of tags that are added to the prior revision while the canary deployment is in progress.
+ "A String",
+ ],
+ "stableRevisionTags": [ # Optional. A list of tags that are added to the final stable revision after the canary deployment is completed.
+ "A String",
+ ],
},
"kubernetes": { # KubernetesConfig contains the Kubernetes runtime configuration. # Kubernetes runtime configuration.
"gatewayServiceMesh": { # Information about the Kubernetes Gateway API service mesh configuration. # Kubernetes Gateway API service mesh configuration.
@@ -908,6 +944,11 @@ Method Details
"A String",
],
},
+ "custom": { # CustomMetadata contains information from a user defined operation. # Output only. Custom metadata provided by user defined `Rollout` operations.
+ "values": { # Output only. Key-value pairs provided by the user defined operation.
+ "a_key": "A String",
+ },
+ },
},
"name": "A String", # Optional. Name of the `Rollout`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/a-z{0,62}`.
"phases": [ # Output only. The phases that represent the workflows of this `Rollout`.
@@ -1132,6 +1173,11 @@ Method Details
"A String",
],
},
+ "custom": { # CustomMetadata contains information from a user defined operation. # Output only. Custom metadata provided by user defined `Rollout` operations.
+ "values": { # Output only. Key-value pairs provided by the user defined operation.
+ "a_key": "A String",
+ },
+ },
},
"name": "A String", # Optional. Name of the `Rollout`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/a-z{0,62}`.
"phases": [ # Output only. The phases that represent the workflows of this `Rollout`.
diff --git a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.html b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.html
index e348612e88..b2cbc870d9 100644
--- a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.html
+++ b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.html
@@ -151,14 +151,51 @@ Method Details
"releaseReadyCondition": { # ReleaseReadyCondition contains information around the status of the Release. If a release is not ready, you cannot create a rollout with the release. # Details around the Releases's overall status.
"status": True or False, # True if the Release is in a valid state. Otherwise at least one condition in `ReleaseCondition` is in an invalid state. Iterate over those conditions and see which condition(s) has status = false to find out what is wrong with the Release.
},
- "skaffoldSupportedCondition": { # SkaffoldSupportedCondition contains information about when support for the release's version of skaffold ends. # Details around the support state of the release's skaffold version.
- "maintenanceModeTime": "A String", # The time at which this release's version of skaffold will enter maintenance mode.
- "skaffoldSupportState": "A String", # The skaffold support state for this release's version of skaffold.
- "status": True or False, # True if the version of skaffold used by this release is supported.
- "supportExpirationTime": "A String", # The time at which this release's version of skaffold will no longer be supported.
+ "skaffoldSupportedCondition": { # SkaffoldSupportedCondition contains information about when support for the release's version of Skaffold ends. # Details around the support state of the release's Skaffold version.
+ "maintenanceModeTime": "A String", # The time at which this release's version of Skaffold will enter maintenance mode.
+ "skaffoldSupportState": "A String", # The Skaffold support state for this release's version of Skaffold.
+ "status": True or False, # True if the version of Skaffold used by this release is supported.
+ "supportExpirationTime": "A String", # The time at which this release's version of Skaffold will no longer be supported.
},
},
"createTime": "A String", # Output only. Time at which the `Release` was created.
+ "customTargetTypeSnapshots": [ # Output only. Snapshot of the custom target types referenced by the targets taken at release creation time.
+ { # 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 a runtime that does not have a 1P integration with Cloud Deploy.
+ "annotations": { # Optional. 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.
+ "a_key": "A String",
+ },
+ "createTime": "A String", # Output only. Time at which the `CustomTargetType` was created.
+ "customActions": { # CustomTargetSkaffoldActions represents the `CustomTargetType` configuration using Skaffold custom actions. # Configures render and deploy for the `CustomTargetType` using Skaffold custom actions.
+ "deployAction": "A String", # Required. The Skaffold custom action responsible for deploy operations.
+ "includeSkaffoldModules": [ # Optional. List of Skaffold modules Cloud Deploy will include in the Skaffold Config as required before performing diagnose.
+ { # Skaffold Config modules and their remote source.
+ "configs": [ # Optional. The Skaffold Config modules to use from the specified source.
+ "A String",
+ ],
+ "git": { # Git repository containing Skaffold Config modules. # Remote git repository containing the Skaffold Config modules.
+ "path": "A String", # Optional. Relative path from the repository root to the Skaffold file.
+ "ref": "A String", # Optional. Git ref the package should be cloned from.
+ "repo": "A String", # Required. Git repository the package should be cloned from.
+ },
+ "googleCloudStorage": { # Cloud Storage bucket containing Skaffold Config modules. # Cloud Storage bucket containing the Skaffold Config modules.
+ "path": "A String", # Optional. Relative path from the source to the Skaffold file.
+ "source": "A String", # Required. Cloud Storage source paths to copy recursively. For example, providing "gs://my-bucket/dir/configs/*" will result in Skaffold copying all files within the "dir/configs" directory in the bucket "my-bucket".
+ },
+ },
+ ],
+ "renderAction": "A String", # Optional. The Skaffold custom action responsible for render operations. If not provided then Cloud Deploy will perform the render operations via `skaffold render`.
+ },
+ "customTargetTypeId": "A String", # Output only. Resource id of the `CustomTargetType`.
+ "description": "A String", # Optional. Description of the `CustomTargetType`. Max length is 255 characters.
+ "etag": "A String", # Optional. 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.
+ "labels": { # Optional. 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.
+ "a_key": "A String",
+ },
+ "name": "A String", # Optional. Name of the `CustomTargetType`. Format is `projects/{project}/locations/{location}/customTargetTypes/a-z{0,62}`.
+ "uid": "A String", # Output only. Unique identifier of the `CustomTargetType`.
+ "updateTime": "A String", # Output only. Most recent time at which the `CustomTargetType` was updated.
+ },
+ ],
"deliveryPipelineSnapshot": { # A `DeliveryPipeline` resource in the Cloud Deploy API. A `DeliveryPipeline` defines a pipeline through which a Skaffold configuration can progress. # Output only. Snapshot of the parent pipeline taken at release creation time.
"annotations": { # User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy.
"a_key": "A String",
@@ -168,7 +205,7 @@ Method Details
"status": True or False, # True if the Pipeline is in a valid state. Otherwise at least one condition in `PipelineCondition` is in an invalid state. Iterate over those conditions and see which condition(s) has status = false to find out what is wrong with the Pipeline.
"updateTime": "A String", # Last time the condition was updated.
},
- "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Details around targets enumerated in the pipeline.
+ "targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Details around targets enumerated in the pipeline.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
@@ -246,6 +283,15 @@ Method Details
"runtimeConfig": { # RuntimeConfig contains the runtime specific configurations for a deployment strategy. # Optional. Runtime specific configurations for the deployment strategy. The runtime configuration is used to determine how Cloud Deploy will split traffic to enable a progressive deployment.
"cloudRun": { # CloudRunConfig contains the Cloud Run runtime configuration. # Cloud Run runtime configuration.
"automaticTrafficControl": True or False, # Whether Cloud Deploy should update the traffic stanza in a Cloud Run Service on the user's behalf to facilitate traffic splitting. This is required to be true for CanaryDeployments, but optional for CustomCanaryDeployments.
+ "canaryRevisionTags": [ # Optional. A list of tags that are added to the canary revision while the canary deployment is in progress.
+ "A String",
+ ],
+ "priorRevisionTags": [ # Optional. A list of tags that are added to the prior revision while the canary deployment is in progress.
+ "A String",
+ ],
+ "stableRevisionTags": [ # Optional. A list of tags that are added to the final stable revision after the canary deployment is completed.
+ "A String",
+ ],
},
"kubernetes": { # KubernetesConfig contains the Kubernetes runtime configuration. # Kubernetes runtime configuration.
"gatewayServiceMesh": { # Information about the Kubernetes Gateway API service mesh configuration. # Kubernetes Gateway API service mesh configuration.
@@ -321,6 +367,11 @@ Method Details
"cloudRun": { # CloudRunRenderMetadata contains Cloud Run information associated with a `Release` render. # Output only. Metadata associated with rendering for Cloud Run.
"service": "A String", # Output only. The name of the Cloud Run Service in the rendered manifest. Format is `projects/{project}/locations/{location}/services/{service}`.
},
+ "custom": { # CustomMetadata contains information from a user defined operation. # Output only. Custom metadata provided by user defined render operation.
+ "values": { # Output only. Key-value pairs provided by the user defined operation.
+ "a_key": "A String",
+ },
+ },
},
"renderingBuild": "A String", # Output only. The resource name of the Cloud Build `Build` object that is used to render the manifest for this target. Format is `projects/{project}/locations/{location}/builds/{build}`.
"renderingState": "A String", # Output only. Current state of the render operation for this Target.
@@ -335,6 +386,9 @@ Method Details
"membership": "A String", # Membership of the GKE Hub-registered cluster to which to apply the Skaffold configuration. Format is `projects/{project}/locations/{location}/memberships/{membership_name}`.
},
"createTime": "A String", # Output only. Time at which the `Target` was created.
+ "customTarget": { # Information specifying a Custom Target. # Optional. Information specifying a Custom Target.
+ "customTargetType": "A String", # Required. The name of the CustomTargetType. Format must be `projects/{project}/locations/{location}/customTargetTypes/{custom_target_type}`.
+ },
"deployParameters": { # Optional. The deploy parameters to use for this target.
"a_key": "A String",
},
@@ -446,14 +500,51 @@ Method Details
"releaseReadyCondition": { # ReleaseReadyCondition contains information around the status of the Release. If a release is not ready, you cannot create a rollout with the release. # Details around the Releases's overall status.
"status": True or False, # True if the Release is in a valid state. Otherwise at least one condition in `ReleaseCondition` is in an invalid state. Iterate over those conditions and see which condition(s) has status = false to find out what is wrong with the Release.
},
- "skaffoldSupportedCondition": { # SkaffoldSupportedCondition contains information about when support for the release's version of skaffold ends. # Details around the support state of the release's skaffold version.
- "maintenanceModeTime": "A String", # The time at which this release's version of skaffold will enter maintenance mode.
- "skaffoldSupportState": "A String", # The skaffold support state for this release's version of skaffold.
- "status": True or False, # True if the version of skaffold used by this release is supported.
- "supportExpirationTime": "A String", # The time at which this release's version of skaffold will no longer be supported.
+ "skaffoldSupportedCondition": { # SkaffoldSupportedCondition contains information about when support for the release's version of Skaffold ends. # Details around the support state of the release's Skaffold version.
+ "maintenanceModeTime": "A String", # The time at which this release's version of Skaffold will enter maintenance mode.
+ "skaffoldSupportState": "A String", # The Skaffold support state for this release's version of Skaffold.
+ "status": True or False, # True if the version of Skaffold used by this release is supported.
+ "supportExpirationTime": "A String", # The time at which this release's version of Skaffold will no longer be supported.
},
},
"createTime": "A String", # Output only. Time at which the `Release` was created.
+ "customTargetTypeSnapshots": [ # Output only. Snapshot of the custom target types referenced by the targets taken at release creation time.
+ { # 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 a runtime that does not have a 1P integration with Cloud Deploy.
+ "annotations": { # Optional. 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.
+ "a_key": "A String",
+ },
+ "createTime": "A String", # Output only. Time at which the `CustomTargetType` was created.
+ "customActions": { # CustomTargetSkaffoldActions represents the `CustomTargetType` configuration using Skaffold custom actions. # Configures render and deploy for the `CustomTargetType` using Skaffold custom actions.
+ "deployAction": "A String", # Required. The Skaffold custom action responsible for deploy operations.
+ "includeSkaffoldModules": [ # Optional. List of Skaffold modules Cloud Deploy will include in the Skaffold Config as required before performing diagnose.
+ { # Skaffold Config modules and their remote source.
+ "configs": [ # Optional. The Skaffold Config modules to use from the specified source.
+ "A String",
+ ],
+ "git": { # Git repository containing Skaffold Config modules. # Remote git repository containing the Skaffold Config modules.
+ "path": "A String", # Optional. Relative path from the repository root to the Skaffold file.
+ "ref": "A String", # Optional. Git ref the package should be cloned from.
+ "repo": "A String", # Required. Git repository the package should be cloned from.
+ },
+ "googleCloudStorage": { # Cloud Storage bucket containing Skaffold Config modules. # Cloud Storage bucket containing the Skaffold Config modules.
+ "path": "A String", # Optional. Relative path from the source to the Skaffold file.
+ "source": "A String", # Required. Cloud Storage source paths to copy recursively. For example, providing "gs://my-bucket/dir/configs/*" will result in Skaffold copying all files within the "dir/configs" directory in the bucket "my-bucket".
+ },
+ },
+ ],
+ "renderAction": "A String", # Optional. The Skaffold custom action responsible for render operations. If not provided then Cloud Deploy will perform the render operations via `skaffold render`.
+ },
+ "customTargetTypeId": "A String", # Output only. Resource id of the `CustomTargetType`.
+ "description": "A String", # Optional. Description of the `CustomTargetType`. Max length is 255 characters.
+ "etag": "A String", # Optional. 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.
+ "labels": { # Optional. 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.
+ "a_key": "A String",
+ },
+ "name": "A String", # Optional. Name of the `CustomTargetType`. Format is `projects/{project}/locations/{location}/customTargetTypes/a-z{0,62}`.
+ "uid": "A String", # Output only. Unique identifier of the `CustomTargetType`.
+ "updateTime": "A String", # Output only. Most recent time at which the `CustomTargetType` was updated.
+ },
+ ],
"deliveryPipelineSnapshot": { # A `DeliveryPipeline` resource in the Cloud Deploy API. A `DeliveryPipeline` defines a pipeline through which a Skaffold configuration can progress. # Output only. Snapshot of the parent pipeline taken at release creation time.
"annotations": { # User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy.
"a_key": "A String",
@@ -463,7 +554,7 @@ Method Details
"status": True or False, # True if the Pipeline is in a valid state. Otherwise at least one condition in `PipelineCondition` is in an invalid state. Iterate over those conditions and see which condition(s) has status = false to find out what is wrong with the Pipeline.
"updateTime": "A String", # Last time the condition was updated.
},
- "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Details around targets enumerated in the pipeline.
+ "targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Details around targets enumerated in the pipeline.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
@@ -541,6 +632,15 @@ Method Details
"runtimeConfig": { # RuntimeConfig contains the runtime specific configurations for a deployment strategy. # Optional. Runtime specific configurations for the deployment strategy. The runtime configuration is used to determine how Cloud Deploy will split traffic to enable a progressive deployment.
"cloudRun": { # CloudRunConfig contains the Cloud Run runtime configuration. # Cloud Run runtime configuration.
"automaticTrafficControl": True or False, # Whether Cloud Deploy should update the traffic stanza in a Cloud Run Service on the user's behalf to facilitate traffic splitting. This is required to be true for CanaryDeployments, but optional for CustomCanaryDeployments.
+ "canaryRevisionTags": [ # Optional. A list of tags that are added to the canary revision while the canary deployment is in progress.
+ "A String",
+ ],
+ "priorRevisionTags": [ # Optional. A list of tags that are added to the prior revision while the canary deployment is in progress.
+ "A String",
+ ],
+ "stableRevisionTags": [ # Optional. A list of tags that are added to the final stable revision after the canary deployment is completed.
+ "A String",
+ ],
},
"kubernetes": { # KubernetesConfig contains the Kubernetes runtime configuration. # Kubernetes runtime configuration.
"gatewayServiceMesh": { # Information about the Kubernetes Gateway API service mesh configuration. # Kubernetes Gateway API service mesh configuration.
@@ -616,6 +716,11 @@ Method Details
"cloudRun": { # CloudRunRenderMetadata contains Cloud Run information associated with a `Release` render. # Output only. Metadata associated with rendering for Cloud Run.
"service": "A String", # Output only. The name of the Cloud Run Service in the rendered manifest. Format is `projects/{project}/locations/{location}/services/{service}`.
},
+ "custom": { # CustomMetadata contains information from a user defined operation. # Output only. Custom metadata provided by user defined render operation.
+ "values": { # Output only. Key-value pairs provided by the user defined operation.
+ "a_key": "A String",
+ },
+ },
},
"renderingBuild": "A String", # Output only. The resource name of the Cloud Build `Build` object that is used to render the manifest for this target. Format is `projects/{project}/locations/{location}/builds/{build}`.
"renderingState": "A String", # Output only. Current state of the render operation for this Target.
@@ -630,6 +735,9 @@ Method Details
"membership": "A String", # Membership of the GKE Hub-registered cluster to which to apply the Skaffold configuration. Format is `projects/{project}/locations/{location}/memberships/{membership_name}`.
},
"createTime": "A String", # Output only. Time at which the `Target` was created.
+ "customTarget": { # Information specifying a Custom Target. # Optional. Information specifying a Custom Target.
+ "customTargetType": "A String", # Required. The name of the CustomTargetType. Format must be `projects/{project}/locations/{location}/customTargetTypes/{custom_target_type}`.
+ },
"deployParameters": { # Optional. The deploy parameters to use for this target.
"a_key": "A String",
},
@@ -717,14 +825,51 @@ Method Details
"releaseReadyCondition": { # ReleaseReadyCondition contains information around the status of the Release. If a release is not ready, you cannot create a rollout with the release. # Details around the Releases's overall status.
"status": True or False, # True if the Release is in a valid state. Otherwise at least one condition in `ReleaseCondition` is in an invalid state. Iterate over those conditions and see which condition(s) has status = false to find out what is wrong with the Release.
},
- "skaffoldSupportedCondition": { # SkaffoldSupportedCondition contains information about when support for the release's version of skaffold ends. # Details around the support state of the release's skaffold version.
- "maintenanceModeTime": "A String", # The time at which this release's version of skaffold will enter maintenance mode.
- "skaffoldSupportState": "A String", # The skaffold support state for this release's version of skaffold.
- "status": True or False, # True if the version of skaffold used by this release is supported.
- "supportExpirationTime": "A String", # The time at which this release's version of skaffold will no longer be supported.
+ "skaffoldSupportedCondition": { # SkaffoldSupportedCondition contains information about when support for the release's version of Skaffold ends. # Details around the support state of the release's Skaffold version.
+ "maintenanceModeTime": "A String", # The time at which this release's version of Skaffold will enter maintenance mode.
+ "skaffoldSupportState": "A String", # The Skaffold support state for this release's version of Skaffold.
+ "status": True or False, # True if the version of Skaffold used by this release is supported.
+ "supportExpirationTime": "A String", # The time at which this release's version of Skaffold will no longer be supported.
},
},
"createTime": "A String", # Output only. Time at which the `Release` was created.
+ "customTargetTypeSnapshots": [ # Output only. Snapshot of the custom target types referenced by the targets taken at release creation time.
+ { # 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 a runtime that does not have a 1P integration with Cloud Deploy.
+ "annotations": { # Optional. 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.
+ "a_key": "A String",
+ },
+ "createTime": "A String", # Output only. Time at which the `CustomTargetType` was created.
+ "customActions": { # CustomTargetSkaffoldActions represents the `CustomTargetType` configuration using Skaffold custom actions. # Configures render and deploy for the `CustomTargetType` using Skaffold custom actions.
+ "deployAction": "A String", # Required. The Skaffold custom action responsible for deploy operations.
+ "includeSkaffoldModules": [ # Optional. List of Skaffold modules Cloud Deploy will include in the Skaffold Config as required before performing diagnose.
+ { # Skaffold Config modules and their remote source.
+ "configs": [ # Optional. The Skaffold Config modules to use from the specified source.
+ "A String",
+ ],
+ "git": { # Git repository containing Skaffold Config modules. # Remote git repository containing the Skaffold Config modules.
+ "path": "A String", # Optional. Relative path from the repository root to the Skaffold file.
+ "ref": "A String", # Optional. Git ref the package should be cloned from.
+ "repo": "A String", # Required. Git repository the package should be cloned from.
+ },
+ "googleCloudStorage": { # Cloud Storage bucket containing Skaffold Config modules. # Cloud Storage bucket containing the Skaffold Config modules.
+ "path": "A String", # Optional. Relative path from the source to the Skaffold file.
+ "source": "A String", # Required. Cloud Storage source paths to copy recursively. For example, providing "gs://my-bucket/dir/configs/*" will result in Skaffold copying all files within the "dir/configs" directory in the bucket "my-bucket".
+ },
+ },
+ ],
+ "renderAction": "A String", # Optional. The Skaffold custom action responsible for render operations. If not provided then Cloud Deploy will perform the render operations via `skaffold render`.
+ },
+ "customTargetTypeId": "A String", # Output only. Resource id of the `CustomTargetType`.
+ "description": "A String", # Optional. Description of the `CustomTargetType`. Max length is 255 characters.
+ "etag": "A String", # Optional. 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.
+ "labels": { # Optional. 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.
+ "a_key": "A String",
+ },
+ "name": "A String", # Optional. Name of the `CustomTargetType`. Format is `projects/{project}/locations/{location}/customTargetTypes/a-z{0,62}`.
+ "uid": "A String", # Output only. Unique identifier of the `CustomTargetType`.
+ "updateTime": "A String", # Output only. Most recent time at which the `CustomTargetType` was updated.
+ },
+ ],
"deliveryPipelineSnapshot": { # A `DeliveryPipeline` resource in the Cloud Deploy API. A `DeliveryPipeline` defines a pipeline through which a Skaffold configuration can progress. # Output only. Snapshot of the parent pipeline taken at release creation time.
"annotations": { # User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy.
"a_key": "A String",
@@ -734,7 +879,7 @@ Method Details
"status": True or False, # True if the Pipeline is in a valid state. Otherwise at least one condition in `PipelineCondition` is in an invalid state. Iterate over those conditions and see which condition(s) has status = false to find out what is wrong with the Pipeline.
"updateTime": "A String", # Last time the condition was updated.
},
- "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Details around targets enumerated in the pipeline.
+ "targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Details around targets enumerated in the pipeline.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
@@ -812,6 +957,15 @@ Method Details
"runtimeConfig": { # RuntimeConfig contains the runtime specific configurations for a deployment strategy. # Optional. Runtime specific configurations for the deployment strategy. The runtime configuration is used to determine how Cloud Deploy will split traffic to enable a progressive deployment.
"cloudRun": { # CloudRunConfig contains the Cloud Run runtime configuration. # Cloud Run runtime configuration.
"automaticTrafficControl": True or False, # Whether Cloud Deploy should update the traffic stanza in a Cloud Run Service on the user's behalf to facilitate traffic splitting. This is required to be true for CanaryDeployments, but optional for CustomCanaryDeployments.
+ "canaryRevisionTags": [ # Optional. A list of tags that are added to the canary revision while the canary deployment is in progress.
+ "A String",
+ ],
+ "priorRevisionTags": [ # Optional. A list of tags that are added to the prior revision while the canary deployment is in progress.
+ "A String",
+ ],
+ "stableRevisionTags": [ # Optional. A list of tags that are added to the final stable revision after the canary deployment is completed.
+ "A String",
+ ],
},
"kubernetes": { # KubernetesConfig contains the Kubernetes runtime configuration. # Kubernetes runtime configuration.
"gatewayServiceMesh": { # Information about the Kubernetes Gateway API service mesh configuration. # Kubernetes Gateway API service mesh configuration.
@@ -887,6 +1041,11 @@ Method Details
"cloudRun": { # CloudRunRenderMetadata contains Cloud Run information associated with a `Release` render. # Output only. Metadata associated with rendering for Cloud Run.
"service": "A String", # Output only. The name of the Cloud Run Service in the rendered manifest. Format is `projects/{project}/locations/{location}/services/{service}`.
},
+ "custom": { # CustomMetadata contains information from a user defined operation. # Output only. Custom metadata provided by user defined render operation.
+ "values": { # Output only. Key-value pairs provided by the user defined operation.
+ "a_key": "A String",
+ },
+ },
},
"renderingBuild": "A String", # Output only. The resource name of the Cloud Build `Build` object that is used to render the manifest for this target. Format is `projects/{project}/locations/{location}/builds/{build}`.
"renderingState": "A String", # Output only. Current state of the render operation for this Target.
@@ -901,6 +1060,9 @@ Method Details
"membership": "A String", # Membership of the GKE Hub-registered cluster to which to apply the Skaffold configuration. Format is `projects/{project}/locations/{location}/memberships/{membership_name}`.
},
"createTime": "A String", # Output only. Time at which the `Target` was created.
+ "customTarget": { # Information specifying a Custom Target. # Optional. Information specifying a Custom Target.
+ "customTargetType": "A String", # Required. The name of the CustomTargetType. Format must be `projects/{project}/locations/{location}/customTargetTypes/{custom_target_type}`.
+ },
"deployParameters": { # Optional. The deploy parameters to use for this target.
"a_key": "A String",
},
diff --git a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.html b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.html
index ca0d0ebc32..4d90d364ea 100644
--- a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.html
+++ b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.html
@@ -235,6 +235,11 @@ Method Details
"A String",
],
},
+ "custom": { # CustomMetadata contains information from a user defined operation. # Output only. Custom metadata provided by user defined `Rollout` operations.
+ "values": { # Output only. Key-value pairs provided by the user defined operation.
+ "a_key": "A String",
+ },
+ },
},
"name": "A String", # Optional. Name of the `Rollout`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/a-z{0,62}`.
"phases": [ # Output only. The phases that represent the workflows of this `Rollout`.
@@ -489,6 +494,11 @@ Method Details
"A String",
],
},
+ "custom": { # CustomMetadata contains information from a user defined operation. # Output only. Custom metadata provided by user defined `Rollout` operations.
+ "values": { # Output only. Key-value pairs provided by the user defined operation.
+ "a_key": "A String",
+ },
+ },
},
"name": "A String", # Optional. Name of the `Rollout`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/a-z{0,62}`.
"phases": [ # Output only. The phases that represent the workflows of this `Rollout`.
@@ -744,6 +754,11 @@ Method Details
"A String",
],
},
+ "custom": { # CustomMetadata contains information from a user defined operation. # Output only. Custom metadata provided by user defined `Rollout` operations.
+ "values": { # Output only. Key-value pairs provided by the user defined operation.
+ "a_key": "A String",
+ },
+ },
},
"name": "A String", # Optional. Name of the `Rollout`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/a-z{0,62}`.
"phases": [ # Output only. The phases that represent the workflows of this `Rollout`.
diff --git a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.jobRuns.html b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.jobRuns.html
index 64cb0d9b3c..f09b89bc9c 100644
--- a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.jobRuns.html
+++ b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.jobRuns.html
@@ -138,6 +138,14 @@ Method Details
"A String",
],
},
+ "custom": { # CustomMetadata contains information from a user defined operation. # Output only. Custom metadata provided by user defined deploy operation.
+ "values": { # Output only. Key-value pairs provided by the user defined operation.
+ "a_key": "A String",
+ },
+ },
+ "customTarget": { # CustomTargetDeployMetadata contains information from a Custom Target deploy operation. # Output only. Custom Target metadata associated with a `DeployJobRun`.
+ "skipMessage": "A String", # Output only. Skip message provided in the results of a custom deploy operation.
+ },
},
},
"endTime": "A String", # Output only. Time at which the `JobRun` ended.
@@ -217,6 +225,14 @@ Method Details
"A String",
],
},
+ "custom": { # CustomMetadata contains information from a user defined operation. # Output only. Custom metadata provided by user defined deploy operation.
+ "values": { # Output only. Key-value pairs provided by the user defined operation.
+ "a_key": "A String",
+ },
+ },
+ "customTarget": { # CustomTargetDeployMetadata contains information from a Custom Target deploy operation. # Output only. Custom Target metadata associated with a `DeployJobRun`.
+ "skipMessage": "A String", # Output only. Skip message provided in the results of a custom deploy operation.
+ },
},
},
"endTime": "A String", # Output only. Time at which the `JobRun` ended.
diff --git a/docs/dyn/clouddeploy_v1.projects.locations.html b/docs/dyn/clouddeploy_v1.projects.locations.html
index 8d8dab1929..5845e9ea78 100644
--- a/docs/dyn/clouddeploy_v1.projects.locations.html
+++ b/docs/dyn/clouddeploy_v1.projects.locations.html
@@ -74,6 +74,11 @@
Cloud Deploy API . projects . locations
Instance Methods
+
+Returns the customTargetTypes Resource.
+
@@ -156,13 +161,13 @@ Method Details
"name": "A String", # Name of the configuration.
"supportedVersions": [ # All supported versions of Skaffold.
{ # Details of a supported Skaffold version.
- "maintenanceModeTime": "A String", # The time at which this version of skaffold will enter maintenance mode.
+ "maintenanceModeTime": "A String", # The time at which this version of Skaffold will enter maintenance mode.
"supportEndDate": { # 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 # Date when this version is expected to no longer be supported.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
- "supportExpirationTime": "A String", # The time at which this version of skaffold will no longer be supported.
+ "supportExpirationTime": "A String", # The time at which this version of Skaffold will no longer be supported.
"version": "A String", # Release version number. For example, "1.20.3".
},
],
diff --git a/docs/dyn/clouddeploy_v1.projects.locations.targets.html b/docs/dyn/clouddeploy_v1.projects.locations.targets.html
index 1d25922011..a08ad06854 100644
--- a/docs/dyn/clouddeploy_v1.projects.locations.targets.html
+++ b/docs/dyn/clouddeploy_v1.projects.locations.targets.html
@@ -127,6 +127,9 @@ Method Details
"membership": "A String", # Membership of the GKE Hub-registered cluster to which to apply the Skaffold configuration. Format is `projects/{project}/locations/{location}/memberships/{membership_name}`.
},
"createTime": "A String", # Output only. Time at which the `Target` was created.
+ "customTarget": { # Information specifying a Custom Target. # Optional. Information specifying a Custom Target.
+ "customTargetType": "A String", # Required. The name of the CustomTargetType. Format must be `projects/{project}/locations/{location}/customTargetTypes/{custom_target_type}`.
+ },
"deployParameters": { # Optional. The deploy parameters to use for this target.
"a_key": "A String",
},
@@ -267,6 +270,9 @@ Method Details
"membership": "A String", # Membership of the GKE Hub-registered cluster to which to apply the Skaffold configuration. Format is `projects/{project}/locations/{location}/memberships/{membership_name}`.
},
"createTime": "A String", # Output only. Time at which the `Target` was created.
+ "customTarget": { # Information specifying a Custom Target. # Optional. Information specifying a Custom Target.
+ "customTargetType": "A String", # Required. The name of the CustomTargetType. Format must be `projects/{project}/locations/{location}/customTargetTypes/{custom_target_type}`.
+ },
"deployParameters": { # Optional. The deploy parameters to use for this target.
"a_key": "A String",
},
@@ -392,6 +398,9 @@ Method Details
"membership": "A String", # Membership of the GKE Hub-registered cluster to which to apply the Skaffold configuration. Format is `projects/{project}/locations/{location}/memberships/{membership_name}`.
},
"createTime": "A String", # Output only. Time at which the `Target` was created.
+ "customTarget": { # Information specifying a Custom Target. # Optional. Information specifying a Custom Target.
+ "customTargetType": "A String", # Required. The name of the CustomTargetType. Format must be `projects/{project}/locations/{location}/customTargetTypes/{custom_target_type}`.
+ },
"deployParameters": { # Optional. The deploy parameters to use for this target.
"a_key": "A String",
},
@@ -476,6 +485,9 @@ Method Details
"membership": "A String", # Membership of the GKE Hub-registered cluster to which to apply the Skaffold configuration. Format is `projects/{project}/locations/{location}/memberships/{membership_name}`.
},
"createTime": "A String", # Output only. Time at which the `Target` was created.
+ "customTarget": { # Information specifying a Custom Target. # Optional. Information specifying a Custom Target.
+ "customTargetType": "A String", # Required. The name of the CustomTargetType. Format must be `projects/{project}/locations/{location}/customTargetTypes/{custom_target_type}`.
+ },
"deployParameters": { # Optional. The deploy parameters to use for this target.
"a_key": "A String",
},
diff --git a/googleapiclient/discovery_cache/documents/clouddeploy.v1.json b/googleapiclient/discovery_cache/documents/clouddeploy.v1.json
index 6908d6399c..7d6391f1ef 100644
--- a/googleapiclient/discovery_cache/documents/clouddeploy.v1.json
+++ b/googleapiclient/discovery_cache/documents/clouddeploy.v1.json
@@ -202,6 +202,218 @@
}
},
"resources": {
+ "customTargetTypes": {
+ "methods": {
+ "create": {
+ "description": "Creates a new CustomTargetType in a given project and location.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customTargetTypes",
+ "httpMethod": "POST",
+ "id": "clouddeploy.projects.locations.customTargetTypes.create",
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "customTargetTypeId": {
+ "description": "Required. ID of the `CustomTargetType`.",
+ "location": "query",
+ "type": "string"
+ },
+ "parent": {
+ "description": "Required. The parent collection in which the `CustomTargetType` should be created in. Format should be `projects/{project_id}/locations/{location_name}`.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "required": true,
+ "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"
+ }
+ },
+ "path": "v1/{+parent}/customTargetTypes",
+ "request": {
+ "$ref": "CustomTargetType"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "delete": {
+ "description": "Deletes a single CustomTargetType.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customTargetTypes/{customTargetTypesId}",
+ "httpMethod": "DELETE",
+ "id": "clouddeploy.projects.locations.customTargetTypes.delete",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "allowMissing": {
+ "description": "Optional. If set to true, then deleting an already deleted or non-existing `CustomTargetType` will succeed.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "etag": {
+ "description": "Optional. 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"
+ },
+ "name": {
+ "description": "Required. The name of the `CustomTargetType` to delete. Format must be `projects/{project_id}/locations/{location_name}/customTargetTypes/{custom_target_type}`.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/customTargetTypes/[^/]+$",
+ "required": true,
+ "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"
+ },
+ "validateOnly": {
+ "description": "Optional. If set to true, the request is validated but no actual change is made.",
+ "location": "query",
+ "type": "boolean"
+ }
+ },
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "description": "Gets details of a single CustomTargetType.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customTargetTypes/{customTargetTypesId}",
+ "httpMethod": "GET",
+ "id": "clouddeploy.projects.locations.customTargetTypes.get",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. Name of the `CustomTargetType`. Format must be `projects/{project_id}/locations/{location_name}/customTargetTypes/{custom_target_type}`.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/customTargetTypes/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "CustomTargetType"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "list": {
+ "description": "Lists CustomTargetTypes in a given project and location.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customTargetTypes",
+ "httpMethod": "GET",
+ "id": "clouddeploy.projects.locations.customTargetTypes.list",
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "filter": {
+ "description": "Optional. Filter custom target types to be returned. See https://google.aip.dev/160 for more details.",
+ "location": "query",
+ "type": "string"
+ },
+ "orderBy": {
+ "description": "Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details.",
+ "location": "query",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Optional. The maximum number of `CustomTargetType` objects to return. The service may return fewer than this value. If unspecified, at most 50 `CustomTargetType` objects will be returned. The maximum value is 1000; values above 1000 will be set to 1000.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Optional. A page token, received from a previous `ListCustomTargetTypes` 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"
+ },
+ "parent": {
+ "description": "Required. The parent that owns this collection of custom target types. Format must be `projects/{project_id}/locations/{location_name}`.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+parent}/customTargetTypes",
+ "response": {
+ "$ref": "ListCustomTargetTypesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "patch": {
+ "description": "Updates a single CustomTargetType.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customTargetTypes/{customTargetTypesId}",
+ "httpMethod": "PATCH",
+ "id": "clouddeploy.projects.locations.customTargetTypes.patch",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "allowMissing": {
+ "description": "Optional. If set to true, updating a `CustomTargetType` that does not exist will result in the creation of a new `CustomTargetType`.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "Optional. Name of the `CustomTargetType`. Format is `projects/{project}/locations/{location}/customTargetTypes/a-z{0,62}`.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/customTargetTypes/[^/]+$",
+ "required": true,
+ "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"
+ },
+ "updateMask": {
+ "description": "Required. Field mask is used to specify the fields to be overwritten in the `CustomTargetType` 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.",
+ "format": "google-fieldmask",
+ "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"
+ }
+ },
+ "path": "v1/{+name}",
+ "request": {
+ "$ref": "CustomTargetType"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ }
+ },
"deliveryPipelines": {
"methods": {
"create": {
@@ -620,7 +832,7 @@
"type": "string"
},
"parent": {
- "description": "Required. The parent, which owns this collection of automationRuns. Format must be `projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}`.",
+ "description": "Required. The parent `Delivery Pipeline`, which owns this collection of automationRuns. Format must be `projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+$",
"required": true,
@@ -783,7 +995,7 @@
"type": "string"
},
"parent": {
- "description": "Required. The parent, which owns this collection of automations. Format must be `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.",
+ "description": "Required. The parent `Delivery Pipeline`, which owns this collection of automations. Format must be `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+$",
"required": true,
@@ -1794,7 +2006,7 @@
}
}
},
- "revision": "20231110",
+ "revision": "20231130",
"rootUrl": "https://clouddeploy.googleapis.com/",
"schemas": {
"AbandonReleaseRequest": {
@@ -1837,7 +2049,7 @@
"id": "AdvanceRolloutOperation",
"properties": {
"destinationPhase": {
- "description": "Output only. The phase to which the rollout will be advanced to.",
+ "description": "Output only. The phase the rollout will be advanced to.",
"readOnly": true,
"type": "string"
},
@@ -1982,7 +2194,7 @@
"type": "object"
},
"Automation": {
- "description": "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 amongst Targets, Rollout repair and Rollout deployment strategy advancement. The intention of Automation is to reduce manual intervention in the continuous delivery process.",
+ "description": "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.",
"id": "Automation",
"properties": {
"annotations": {
@@ -2177,7 +2389,7 @@
"type": "object"
},
"AutomationRun": {
- "description": "An `AutomationRun` resource in the Cloud Deploy API. An `AutomationRun` represents an automation execution instance of an automation rule.",
+ "description": "An `AutomationRun` resource in the Cloud Deploy API. An `AutomationRun` represents an execution instance of an automation rule.",
"id": "AutomationRun",
"properties": {
"advanceRolloutOperation": {
@@ -2207,7 +2419,7 @@
"type": "string"
},
"expireTime": {
- "description": "Output only. Time the `AutomationRun` will expire. An `AutomationRun` will expire after 14 days from its creation date.",
+ "description": "Output only. Time the `AutomationRun` expires. An `AutomationRun` expires after 14 days from its creation date.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
@@ -2259,7 +2471,7 @@
"type": "string"
},
"stateDescription": {
- "description": "Output only. Explains the current state of the `AutomationRun`. Present only an explanation is needed.",
+ "description": "Output only. Explains the current state of the `AutomationRun`. Present only when an explanation is needed.",
"readOnly": true,
"type": "string"
},
@@ -2491,6 +2703,27 @@
"automaticTrafficControl": {
"description": "Whether Cloud Deploy should update the traffic stanza in a Cloud Run Service on the user's behalf to facilitate traffic splitting. This is required to be true for CanaryDeployments, but optional for CustomCanaryDeployments.",
"type": "boolean"
+ },
+ "canaryRevisionTags": {
+ "description": "Optional. A list of tags that are added to the canary revision while the canary deployment is in progress.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "priorRevisionTags": {
+ "description": "Optional. A list of tags that are added to the prior revision while the canary deployment is in progress.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "stableRevisionTags": {
+ "description": "Optional. A list of tags that are added to the final stable revision after the canary deployment is completed.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
}
},
"type": "object"
@@ -2607,6 +2840,125 @@
},
"type": "object"
},
+ "CustomMetadata": {
+ "description": "CustomMetadata contains information from a user defined operation.",
+ "id": "CustomMetadata",
+ "properties": {
+ "values": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Output only. Key-value pairs provided by the user defined operation.",
+ "readOnly": true,
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "CustomTarget": {
+ "description": "Information specifying a Custom Target.",
+ "id": "CustomTarget",
+ "properties": {
+ "customTargetType": {
+ "description": "Required. The name of the CustomTargetType. Format must be `projects/{project}/locations/{location}/customTargetTypes/{custom_target_type}`.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CustomTargetDeployMetadata": {
+ "description": "CustomTargetDeployMetadata contains information from a Custom Target deploy operation.",
+ "id": "CustomTargetDeployMetadata",
+ "properties": {
+ "skipMessage": {
+ "description": "Output only. Skip message provided in the results of a custom deploy operation.",
+ "readOnly": true,
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CustomTargetSkaffoldActions": {
+ "description": "CustomTargetSkaffoldActions represents the `CustomTargetType` configuration using Skaffold custom actions.",
+ "id": "CustomTargetSkaffoldActions",
+ "properties": {
+ "deployAction": {
+ "description": "Required. The Skaffold custom action responsible for deploy operations.",
+ "type": "string"
+ },
+ "includeSkaffoldModules": {
+ "description": "Optional. List of Skaffold modules Cloud Deploy will include in the Skaffold Config as required before performing diagnose.",
+ "items": {
+ "$ref": "SkaffoldModules"
+ },
+ "type": "array"
+ },
+ "renderAction": {
+ "description": "Optional. The Skaffold custom action responsible for render operations. If not provided then Cloud Deploy will perform the render operations via `skaffold render`.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CustomTargetType": {
+ "description": "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 a runtime that does not have a 1P integration with Cloud Deploy.",
+ "id": "CustomTargetType",
+ "properties": {
+ "annotations": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Optional. 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.",
+ "type": "object"
+ },
+ "createTime": {
+ "description": "Output only. Time at which the `CustomTargetType` was created.",
+ "format": "google-datetime",
+ "readOnly": true,
+ "type": "string"
+ },
+ "customActions": {
+ "$ref": "CustomTargetSkaffoldActions",
+ "description": "Configures render and deploy for the `CustomTargetType` using Skaffold custom actions."
+ },
+ "customTargetTypeId": {
+ "description": "Output only. Resource id of the `CustomTargetType`.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "description": {
+ "description": "Optional. Description of the `CustomTargetType`. Max length is 255 characters.",
+ "type": "string"
+ },
+ "etag": {
+ "description": "Optional. 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.",
+ "type": "string"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Optional. 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.",
+ "type": "object"
+ },
+ "name": {
+ "description": "Optional. Name of the `CustomTargetType`. Format is `projects/{project}/locations/{location}/customTargetTypes/a-z{0,62}`.",
+ "type": "string"
+ },
+ "uid": {
+ "description": "Output only. Unique identifier of the `CustomTargetType`.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "updateTime": {
+ "description": "Output only. Most recent time at which the `CustomTargetType` was updated.",
+ "format": "google-datetime",
+ "readOnly": true,
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
"Date": {
"description": "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",
"id": "Date",
@@ -2804,7 +3156,8 @@
"EXECUTION_FAILED",
"DEADLINE_EXCEEDED",
"MISSING_RESOURCES_FOR_CANARY",
- "CLOUD_BUILD_REQUEST_FAILED"
+ "CLOUD_BUILD_REQUEST_FAILED",
+ "DEPLOY_FEATURE_NOT_SUPPORTED"
],
"enumDescriptions": [
"No reason for failure is specified.",
@@ -2812,7 +3165,8 @@
"The deploy operation did not complete successfully; check Cloud Build logs.",
"The deploy job run did not complete within the alloted time.",
"There were missing resources in the runtime environment required for a canary deployment. Check the Cloud Build logs for more information.",
- "Cloud Build failed to fulfill Cloud Deploy's request. See failure_message for additional details."
+ "Cloud Build failed to fulfill Cloud Deploy's request. See failure_message for additional details.",
+ "The deploy operation had a feature configured that is not supported."
],
"readOnly": true,
"type": "string"
@@ -2838,6 +3192,16 @@
"$ref": "CloudRunMetadata",
"description": "Output only. The name of the Cloud Run Service that is associated with a `DeployJobRun`.",
"readOnly": true
+ },
+ "custom": {
+ "$ref": "CustomMetadata",
+ "description": "Output only. Custom metadata provided by user defined deploy operation.",
+ "readOnly": true
+ },
+ "customTarget": {
+ "$ref": "CustomTargetDeployMetadata",
+ "description": "Output only. Custom Target metadata associated with a `DeployJobRun`.",
+ "readOnly": true
}
},
"type": "object"
@@ -3323,7 +3687,7 @@
"id": "ListAutomationsResponse",
"properties": {
"automations": {
- "description": "The `Automations` objects.",
+ "description": "The `Automation` objects.",
"items": {
"$ref": "Automation"
},
@@ -3343,6 +3707,31 @@
},
"type": "object"
},
+ "ListCustomTargetTypesResponse": {
+ "description": "The response object from `ListCustomTargetTypes.`",
+ "id": "ListCustomTargetTypesResponse",
+ "properties": {
+ "customTargetTypes": {
+ "description": "The `CustomTargetType` objects.",
+ "items": {
+ "$ref": "CustomTargetType"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
+ "type": "string"
+ },
+ "unreachable": {
+ "description": "Locations that could not be reached.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
"ListDeliveryPipelinesResponse": {
"description": "The response object from `ListDeliveryPipelines`.",
"id": "ListDeliveryPipelinesResponse",
@@ -3551,6 +3940,11 @@
"$ref": "CloudRunMetadata",
"description": "Output only. The name of the Cloud Run Service that is associated with a `Rollout`.",
"readOnly": true
+ },
+ "custom": {
+ "$ref": "CustomMetadata",
+ "description": "Output only. Custom metadata provided by user defined `Rollout` operations.",
+ "readOnly": true
}
},
"type": "object"
@@ -4061,6 +4455,14 @@
"readOnly": true,
"type": "string"
},
+ "customTargetTypeSnapshots": {
+ "description": "Output only. Snapshot of the custom target types referenced by the targets taken at release creation time.",
+ "items": {
+ "$ref": "CustomTargetType"
+ },
+ "readOnly": true,
+ "type": "array"
+ },
"deliveryPipelineSnapshot": {
"$ref": "DeliveryPipeline",
"description": "Output only. Snapshot of the parent pipeline taken at release creation time.",
@@ -4175,7 +4577,7 @@
},
"skaffoldSupportedCondition": {
"$ref": "SkaffoldSupportedCondition",
- "description": "Details around the support state of the release's skaffold version."
+ "description": "Details around the support state of the release's Skaffold version."
}
},
"type": "object"
@@ -4279,6 +4681,11 @@
"$ref": "CloudRunRenderMetadata",
"description": "Output only. Metadata associated with rendering for Cloud Run.",
"readOnly": true
+ },
+ "custom": {
+ "$ref": "CustomMetadata",
+ "description": "Output only. Custom metadata provided by user defined render operation.",
+ "readOnly": true
}
},
"type": "object"
@@ -4325,6 +4732,16 @@
"readOnly": true,
"type": "string"
},
+ "jobId": {
+ "description": "Output only. The job ID for the Job to repair.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "phaseId": {
+ "description": "Output only. The phase ID of the phase that includes the job being repaired.",
+ "readOnly": true,
+ "type": "string"
+ },
"repairPhases": {
"description": "Output only. Records of the repair attempts. Each repair phase may have multiple retry attempts or single rollback attempt.",
"items": {
@@ -4383,7 +4800,7 @@
"id": "Retry",
"properties": {
"attempts": {
- "description": "Required. Total number of retries. Retry will skipped if set to 0; The minimum value is 1, and the maximum value is 10.",
+ "description": "Required. Total number of retries. Retry is skipped if set to 0; The minimum value is 1, and the maximum value is 10.",
"format": "int64",
"type": "string"
},
@@ -4505,11 +4922,13 @@
"type": "string"
},
"jobId": {
+ "deprecated": true,
"description": "Output only. The job ID for the Job to retry.",
"readOnly": true,
"type": "string"
},
"phaseId": {
+ "deprecated": true,
"description": "Output only. The phase ID of the phase that includes the job being retried.",
"readOnly": true,
"type": "string"
@@ -4699,7 +5118,8 @@
"RELEASE_FAILED",
"RELEASE_ABANDONED",
"VERIFICATION_CONFIG_NOT_FOUND",
- "CLOUD_BUILD_REQUEST_FAILED"
+ "CLOUD_BUILD_REQUEST_FAILED",
+ "OPERATION_FEATURE_NOT_SUPPORTED"
],
"enumDescriptions": [
"No reason for failure is specified.",
@@ -4708,8 +5128,9 @@
"Deployment did not complete within the alloted time.",
"Release is in a failed state.",
"Release is abandoned.",
- "No skaffold verify configuration was found.",
- "Cloud Build failed to fulfill Cloud Deploy's request. See failure_message for additional details."
+ "No Skaffold verify configuration was found.",
+ "Cloud Build failed to fulfill Cloud Deploy's request. See failure_message for additional details.",
+ "A Rollout operation had a feature configured that is not supported."
],
"readOnly": true,
"type": "string"
@@ -5046,17 +5467,73 @@
},
"type": "object"
},
+ "SkaffoldGCSSource": {
+ "description": "Cloud Storage bucket containing Skaffold Config modules.",
+ "id": "SkaffoldGCSSource",
+ "properties": {
+ "path": {
+ "description": "Optional. Relative path from the source to the Skaffold file.",
+ "type": "string"
+ },
+ "source": {
+ "description": "Required. Cloud Storage source paths to copy recursively. For example, providing \"gs://my-bucket/dir/configs/*\" will result in Skaffold copying all files within the \"dir/configs\" directory in the bucket \"my-bucket\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SkaffoldGitSource": {
+ "description": "Git repository containing Skaffold Config modules.",
+ "id": "SkaffoldGitSource",
+ "properties": {
+ "path": {
+ "description": "Optional. Relative path from the repository root to the Skaffold file.",
+ "type": "string"
+ },
+ "ref": {
+ "description": "Optional. Git ref the package should be cloned from.",
+ "type": "string"
+ },
+ "repo": {
+ "description": "Required. Git repository the package should be cloned from.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SkaffoldModules": {
+ "description": "Skaffold Config modules and their remote source.",
+ "id": "SkaffoldModules",
+ "properties": {
+ "configs": {
+ "description": "Optional. The Skaffold Config modules to use from the specified source.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "git": {
+ "$ref": "SkaffoldGitSource",
+ "description": "Remote git repository containing the Skaffold Config modules."
+ },
+ "googleCloudStorage": {
+ "$ref": "SkaffoldGCSSource",
+ "description": "Cloud Storage bucket containing the Skaffold Config modules."
+ }
+ },
+ "type": "object"
+ },
"SkaffoldSupportedCondition": {
- "description": "SkaffoldSupportedCondition contains information about when support for the release's version of skaffold ends.",
+ "description": "SkaffoldSupportedCondition contains information about when support for the release's version of Skaffold ends.",
"id": "SkaffoldSupportedCondition",
"properties": {
"maintenanceModeTime": {
- "description": "The time at which this release's version of skaffold will enter maintenance mode.",
+ "description": "The time at which this release's version of Skaffold will enter maintenance mode.",
"format": "google-datetime",
"type": "string"
},
"skaffoldSupportState": {
- "description": "The skaffold support state for this release's version of skaffold.",
+ "description": "The Skaffold support state for this release's version of Skaffold.",
"enum": [
"SKAFFOLD_SUPPORT_STATE_UNSPECIFIED",
"SKAFFOLD_SUPPORT_STATE_SUPPORTED",
@@ -5065,18 +5542,18 @@
],
"enumDescriptions": [
"Default value. This value is unused.",
- "This skaffold version is currently supported.",
- "This skaffold version is in maintenance mode.",
- "This skaffold version is no longer supported."
+ "This Skaffold version is currently supported.",
+ "This Skaffold version is in maintenance mode.",
+ "This Skaffold version is no longer supported."
],
"type": "string"
},
"status": {
- "description": "True if the version of skaffold used by this release is supported.",
+ "description": "True if the version of Skaffold used by this release is supported.",
"type": "boolean"
},
"supportExpirationTime": {
- "description": "The time at which this release's version of skaffold will no longer be supported.",
+ "description": "The time at which this release's version of Skaffold will no longer be supported.",
"format": "google-datetime",
"type": "string"
}
@@ -5088,7 +5565,7 @@
"id": "SkaffoldVersion",
"properties": {
"maintenanceModeTime": {
- "description": "The time at which this version of skaffold will enter maintenance mode.",
+ "description": "The time at which this version of Skaffold will enter maintenance mode.",
"format": "google-datetime",
"type": "string"
},
@@ -5097,7 +5574,7 @@
"description": "Date when this version is expected to no longer be supported."
},
"supportExpirationTime": {
- "description": "The time at which this version of skaffold will no longer be supported.",
+ "description": "The time at which this version of Skaffold will no longer be supported.",
"format": "google-datetime",
"type": "string"
},
@@ -5219,6 +5696,10 @@
"readOnly": true,
"type": "string"
},
+ "customTarget": {
+ "$ref": "CustomTarget",
+ "description": "Optional. Information specifying a Custom Target."
+ },
"deployParameters": {
"additionalProperties": {
"type": "string"
@@ -5397,16 +5878,18 @@
"CLOUD_BUILD_REQUEST_FAILED",
"VERIFICATION_CONFIG_NOT_FOUND",
"CUSTOM_ACTION_NOT_FOUND",
- "DEPLOYMENT_STRATEGY_NOT_SUPPORTED"
+ "DEPLOYMENT_STRATEGY_NOT_SUPPORTED",
+ "RENDER_FEATURE_NOT_SUPPORTED"
],
"enumDescriptions": [
"No reason for failure is specified.",
"Cloud Build is not available, either because it is not enabled or because Cloud Deploy has insufficient permissions. See [required permission](https://cloud.google.com/deploy/docs/cloud-deploy-service-account#required_permissions).",
"The render operation did not complete successfully; check Cloud Build logs.",
"Cloud Build failed to fulfill Cloud Deploy's request. See failure_message for additional details.",
- "The render operation did not complete successfully because the verification stanza required for verify was not found on the skaffold configuration.",
- "The render operation did not complete successfully because the custom action required for predeploy or postdeploy was not found in the skaffold configuration. See failure_message for additional details.",
- "Release failed during rendering because the release configuration is not supported with the specified deployment strategy."
+ "The render operation did not complete successfully because the verification stanza required for verify was not found on the Skaffold configuration.",
+ "The render operation did not complete successfully because the custom action required for predeploy or postdeploy was not found in the Skaffold configuration. See failure_message for additional details.",
+ "Release failed during rendering because the release configuration is not supported with the specified deployment strategy.",
+ "The render operation had a feature configured that is not supported."
],
"readOnly": true,
"type": "string"
@@ -5447,7 +5930,7 @@
"type": "object"
},
"TargetsPresentCondition": {
- "description": "TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist.",
+ "description": "`TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist.",
"id": "TargetsPresentCondition",
"properties": {
"missingTargets": {