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.
},
}

Cloud Deploy API . projects . locations . customTargetTypes

Instance Methods

Method Details