class OrganizationsEnvironmentsArchiveDeployments extends Resource (View source)

The "archiveDeployments" collection of methods.

Typical usage is:

 $apigeeService = new Google\Service\Apigee(...);
 $archiveDeployments = $apigeeService->organizations_environments_archiveDeployments;

Methods

create(string $parent, GoogleCloudApigeeV1ArchiveDeployment $postBody, array $optParams = [])

Creates a new ArchiveDeployment. (archiveDeployments.create)

delete(string $name, array $optParams = [])

Deletes an archive deployment. (archiveDeployments.delete)

generateDownloadUrl(string $name, GoogleCloudApigeeV1GenerateDownloadUrlRequest $postBody, array $optParams = [])

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.

generateUploadUrl(string $parent, GoogleCloudApigeeV1GenerateUploadUrlRequest $postBody, array $optParams = [])

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 (archiveDeployments.generateUploadUrl)

get(string $name, array $optParams = [])

Gets the specified ArchiveDeployment. (archiveDeployments.get)

listOrganizationsEnvironmentsArchiveDeployments(string $parent, array $optParams = [])

Lists the ArchiveDeployments in the specified Environment.

patch(string $name, GoogleCloudApigeeV1ArchiveDeployment $postBody, array $optParams = [])

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

Details

GoogleLongrunningOperation create(string $parent, GoogleCloudApigeeV1ArchiveDeployment $postBody, array $optParams = [])

Creates a new ArchiveDeployment. (archiveDeployments.create)

Parameters

string $parent

Required. The Environment this Archive Deployment will be created in.

GoogleCloudApigeeV1ArchiveDeployment $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

GoogleProtobufEmpty delete(string $name, array $optParams = [])

Deletes an archive deployment. (archiveDeployments.delete)

Parameters

string $name

Required. Name of the Archive Deployment in the following format: organizations/{org}/environments/{env}/archiveDeployments/{id}.

array $optParams

Optional parameters.

Return Value

GoogleProtobufEmpty

Exceptions

Exception

GoogleCloudApigeeV1GenerateDownloadUrlResponse generateDownloadUrl(string $name, GoogleCloudApigeeV1GenerateDownloadUrlRequest $postBody, array $optParams = [])

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.

(archiveDeployments.generateDownloadUrl)

Parameters

string $name

Required. The name of the Archive Deployment you want to download.

GoogleCloudApigeeV1GenerateDownloadUrlRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1GenerateDownloadUrlResponse

Exceptions

Exception

GoogleCloudApigeeV1GenerateUploadUrlResponse generateUploadUrl(string $parent, GoogleCloudApigeeV1GenerateUploadUrlRequest $postBody, array $optParams = [])

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 (archiveDeployments.generateUploadUrl)

Parameters

string $parent

Required. The organization and environment to upload to.

GoogleCloudApigeeV1GenerateUploadUrlRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1GenerateUploadUrlResponse

Exceptions

Exception

GoogleCloudApigeeV1ArchiveDeployment get(string $name, array $optParams = [])

Gets the specified ArchiveDeployment. (archiveDeployments.get)

Parameters

string $name

Required. Name of the Archive Deployment in the following format: organizations/{org}/environments/{env}/archiveDeployments/{id}.

array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1ArchiveDeployment

Exceptions

Exception

GoogleCloudApigeeV1ListArchiveDeploymentsResponse listOrganizationsEnvironmentsArchiveDeployments(string $parent, array $optParams = [])

Lists the ArchiveDeployments in the specified Environment.

(archiveDeployments.listOrganizationsEnvironmentsArchiveDeployments)

Parameters

string $parent

Required. Name of the Environment for which to list Archive Deployments in the format: organizations/{org}/environments/{env}.

array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1ListArchiveDeploymentsResponse

Exceptions

Exception

GoogleCloudApigeeV1ArchiveDeployment patch(string $name, GoogleCloudApigeeV1ArchiveDeployment $postBody, array $optParams = [])

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

Parameters

string $name

Name of the Archive Deployment in the following format: organizations/{org}/environments/{env}/archiveDeployments/{id}.

GoogleCloudApigeeV1ArchiveDeployment $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1ArchiveDeployment

Exceptions

Exception