archive_deployments

Creates, updates, deletes, gets or lists an archive_deployments resource.

Overview

Name	archive_deployments
Type	Resource
Id	google.apigee.archive_deployments

Fields

The following fields are returned by SELECT queries:

organizations_environments_archive_deployments_get

Successful response

Name	Datatype	Description
name	string	Name of the Archive Deployment in the following format: organizations/{org}/environments/{env}/archiveDeployments/{id}.
createdAt	string (int64)	Output only. The time at which the Archive Deployment was created in milliseconds since the epoch.
gcsUri	string	Input only. The Google Cloud Storage signed URL returned from GenerateUploadUrl and used to upload the Archive zip file.
labels	object	User-supplied key-value pairs used to organize ArchiveDeployments. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store.
operation	string	Output only. A reference to the LRO that created this Archive Deployment in the following format: organizations/{org}/operations/{id}
updatedAt	string (int64)	Output only. The time at which the Archive Deployment was updated in milliseconds since the epoch.

organizations_environments_archive_deployments_list

Successful response

Name	Datatype	Description
name	string	Name of the Archive Deployment in the following format: organizations/{org}/environments/{env}/archiveDeployments/{id}.
createdAt	string (int64)	Output only. The time at which the Archive Deployment was created in milliseconds since the epoch.
gcsUri	string	Input only. The Google Cloud Storage signed URL returned from GenerateUploadUrl and used to upload the Archive zip file.
labels	object	User-supplied key-value pairs used to organize ArchiveDeployments. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store.
operation	string	Output only. A reference to the LRO that created this Archive Deployment in the following format: organizations/{org}/operations/{id}
updatedAt	string (int64)	Output only. The time at which the Archive Deployment was updated in milliseconds since the epoch.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
organizations_environments_archive_deployments_get	select	organizationsId, environmentsId, archiveDeploymentsId		Gets the specified ArchiveDeployment.
organizations_environments_archive_deployments_list	select	organizationsId, environmentsId	filter, pageSize, pageToken	Lists the ArchiveDeployments in the specified Environment.
organizations_environments_archive_deployments_create	insert	organizationsId, environmentsId		Creates a new ArchiveDeployment.
organizations_environments_archive_deployments_patch	update	organizationsId, environmentsId, archiveDeploymentsId	updateMask	Updates an existing ArchiveDeployment. Labels can modified but most of the other fields are not modifiable.
organizations_environments_archive_deployments_delete	delete	organizationsId, environmentsId, archiveDeploymentsId		Deletes an archive deployment.
organizations_environments_archive_deployments_generate_upload_url	exec	organizationsId, environmentsId		Generates a signed URL for uploading an Archive zip file to Google Cloud Storage. Once the upload is complete, the signed URL should be passed to CreateArchiveDeployment. When uploading to the generated signed URL, please follow these restrictions: * Source file type should be a zip file. * Source file size should not exceed 1GB limit. * No credentials should be attached - the signed URLs provide access to the target bucket using internal service identity; if credentials were attached, the identity from the credentials would be used, but that identity does not have permissions to upload files to the URL. When making a HTTP PUT request, these two headers need to be specified: * content-type: application/zip * x-goog-content-length-range: 0,1073741824 And this header SHOULD NOT be specified: * Authorization: Bearer YOUR_TOKEN
organizations_environments_archive_deployments_generate_download_url	exec	organizationsId, environmentsId, archiveDeploymentsId		Generates a signed URL for downloading the original zip file used to create an Archive Deployment. The URL is only valid for a limited period and should be used within minutes after generation. Each call returns a new upload URL.

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.

Name	Datatype	Description
archiveDeploymentsId	string
environmentsId	string
organizationsId	string
filter	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

organizations_environments_archive_deployments_get

Gets the specified ArchiveDeployment.

SELECT
name,
createdAt,
gcsUri,
labels,
operation,
updatedAt
FROM google.apigee.archive_deployments
WHERE organizationsId = '{{ organizationsId }}' -- required
AND environmentsId = '{{ environmentsId }}' -- required
AND archiveDeploymentsId = '{{ archiveDeploymentsId }}' -- required;

organizations_environments_archive_deployments_list

Lists the ArchiveDeployments in the specified Environment.

SELECT
name,
createdAt,
gcsUri,
labels,
operation,
updatedAt
FROM google.apigee.archive_deployments
WHERE organizationsId = '{{ organizationsId }}' -- required
AND environmentsId = '{{ environmentsId }}' -- required
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

organizations_environments_archive_deployments_create

Creates a new ArchiveDeployment.

INSERT INTO google.apigee.archive_deployments (
data__name,
data__labels,
data__gcsUri,
organizationsId,
environmentsId
)
SELECT 
'{{ name }}',
'{{ labels }}',
'{{ gcsUri }}',
'{{ organizationsId }}',
'{{ environmentsId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: archive_deployments
  props:
    - name: organizationsId
      value: string
      description: Required parameter for the archive_deployments resource.
    - name: environmentsId
      value: string
      description: Required parameter for the archive_deployments resource.
    - name: name
      value: string
      description: >
        Name of the Archive Deployment in the following format: `organizations/{org}/environments/{env}/archiveDeployments/{id}`.
        
    - name: labels
      value: object
      description: >
        User-supplied key-value pairs used to organize ArchiveDeployments. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store.
        
    - name: gcsUri
      value: string
      description: >
        Input only. The Google Cloud Storage signed URL returned from GenerateUploadUrl and used to upload the Archive zip file.
        

UPDATE examples

organizations_environments_archive_deployments_patch

Updates an existing ArchiveDeployment. Labels can modified but most of the other fields are not modifiable.

UPDATE google.apigee.archive_deployments
SET 
data__name = '{{ name }}',
data__labels = '{{ labels }}',
data__gcsUri = '{{ gcsUri }}'
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND environmentsId = '{{ environmentsId }}' --required
AND archiveDeploymentsId = '{{ archiveDeploymentsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
createdAt,
gcsUri,
labels,
operation,
updatedAt;

DELETE examples

organizations_environments_archive_deployments_delete

Deletes an archive deployment.

DELETE FROM google.apigee.archive_deployments
WHERE organizationsId = '{{ organizationsId }}' --required
AND environmentsId = '{{ environmentsId }}' --required
AND archiveDeploymentsId = '{{ archiveDeploymentsId }}' --required;

Lifecycle Methods

organizations_environments_archive_deployments_generate_upload_url

Generates a signed URL for uploading an Archive zip file to Google Cloud Storage. Once the upload is complete, the signed URL should be passed to CreateArchiveDeployment. When uploading to the generated signed URL, please follow these restrictions: * Source file type should be a zip file. * Source file size should not exceed 1GB limit. * No credentials should be attached - the signed URLs provide access to the target bucket using internal service identity; if credentials were attached, the identity from the credentials would be used, but that identity does not have permissions to upload files to the URL. When making a HTTP PUT request, these two headers need to be specified: * content-type: application/zip * x-goog-content-length-range: 0,1073741824 And this header SHOULD NOT be specified: * Authorization: Bearer YOUR_TOKEN

EXEC google.apigee.archive_deployments.organizations_environments_archive_deployments_generate_upload_url 
@organizationsId='{{ organizationsId }}' --required, 
@environmentsId='{{ environmentsId }}' --required;

organizations_environments_archive_deployments_generate_download_url

Generates a signed URL for downloading the original zip file used to create an Archive Deployment. The URL is only valid for a limited period and should be used within minutes after generation. Each call returns a new upload URL.

EXEC google.apigee.archive_deployments.organizations_environments_archive_deployments_generate_download_url 
@organizationsId='{{ organizationsId }}' --required, 
@environmentsId='{{ environmentsId }}' --required, 
@archiveDeploymentsId='{{ archiveDeploymentsId }}' --required;