Skip to main content

custom_target_types

Creates, updates, deletes, gets or lists a custom_target_types resource.

Overview​

Namecustom_target_types
TypeResource
Idgoogle.clouddeploy.custom_target_types

Fields​

The following fields are returned by SELECT queries:

Successful response

NameDatatypeDescription
namestringIdentifier. Name of the CustomTargetType. Format is projects/{project}/locations/{location}/customTargetTypes/{customTargetType}. The customTargetType component must match [a-z]([a-z0-9-]{0,61}[a-z0-9])?
annotationsobjectOptional. 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.
createTimestring (google-datetime)Output only. Time at which the CustomTargetType was created.
customActionsobjectOptional. Configures render and deploy for the CustomTargetType using Skaffold custom actions. (id: CustomTargetSkaffoldActions)
customTargetTypeIdstringOutput only. Resource id of the CustomTargetType.
descriptionstringOptional. Description of the CustomTargetType. Max length is 255 characters.
etagstringOptional. 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.
labelsobjectOptional. 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.
uidstringOutput only. Unique identifier of the CustomTargetType.
updateTimestring (google-datetime)Output only. Most recent time at which the CustomTargetType was updated.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectprojectsId, locationsId, customTargetTypesIdGets details of a single CustomTargetType.
listselectprojectsId, locationsIdpageSize, pageToken, filter, orderByLists CustomTargetTypes in a given project and location.
createinsertprojectsId, locationsIdcustomTargetTypeId, requestId, validateOnlyCreates a new CustomTargetType in a given project and location.
patchupdateprojectsId, locationsId, customTargetTypesIdupdateMask, requestId, allowMissing, validateOnlyUpdates a single CustomTargetType.
deletedeleteprojectsId, locationsId, customTargetTypesIdrequestId, allowMissing, validateOnly, etagDeletes a single CustomTargetType.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
customTargetTypesIdstring
locationsIdstring
projectsIdstring
allowMissingboolean
customTargetTypeIdstring
etagstring
filterstring
orderBystring
pageSizeinteger (int32)
pageTokenstring
requestIdstring
updateMaskstring (google-fieldmask)
validateOnlyboolean

SELECT examples​

Gets details of a single CustomTargetType.

SELECT
name,
annotations,
createTime,
customActions,
customTargetTypeId,
description,
etag,
labels,
uid,
updateTime
FROM google.clouddeploy.custom_target_types
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND customTargetTypesId = '{{ customTargetTypesId }}' -- required;

INSERT examples​

Creates a new CustomTargetType in a given project and location.

INSERT INTO google.clouddeploy.custom_target_types (
data__name,
data__description,
data__annotations,
data__labels,
data__etag,
data__customActions,
projectsId,
locationsId,
customTargetTypeId,
requestId,
validateOnly
)
SELECT 
'{{ name }}',
'{{ description }}',
'{{ annotations }}',
'{{ labels }}',
'{{ etag }}',
'{{ customActions }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ customTargetTypeId }}',
'{{ requestId }}',
'{{ validateOnly }}'
RETURNING
name,
done,
error,
metadata,
response
;

UPDATE examples​

Updates a single CustomTargetType.

UPDATE google.clouddeploy.custom_target_types
SET 
data__name = '{{ name }}',
data__description = '{{ description }}',
data__annotations = '{{ annotations }}',
data__labels = '{{ labels }}',
data__etag = '{{ etag }}',
data__customActions = '{{ customActions }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND customTargetTypesId = '{{ customTargetTypesId }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
AND allowMissing = {{ allowMissing}}
AND validateOnly = {{ validateOnly}}
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples​

Deletes a single CustomTargetType.

DELETE FROM google.clouddeploy.custom_target_types
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND customTargetTypesId = '{{ customTargetTypesId }}' --required
AND requestId = '{{ requestId }}'
AND allowMissing = '{{ allowMissing }}'
AND validateOnly = '{{ validateOnly }}'
AND etag = '{{ etag }}';