com.google.api.services.apigee.v1

Class Apigee.Organizations.Environments.ArchiveDeployments

java.lang.Object

com.google.api.services.apigee.v1.Apigee.Organizations.Environments.ArchiveDeployments

Enclosing class:

Apigee.Organizations.Environments

public class Apigee.Organizations.Environments.ArchiveDeployments
extends Object

The "archiveDeployments" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Apigee.Organizations.Environments.ArchiveDeployments.Create
class	Apigee.Organizations.Environments.ArchiveDeployments.Delete
class	Apigee.Organizations.Environments.ArchiveDeployments.GenerateDownloadUrl
class	Apigee.Organizations.Environments.ArchiveDeployments.GenerateUploadUrl
class	Apigee.Organizations.Environments.ArchiveDeployments.Get
class	Apigee.Organizations.Environments.ArchiveDeployments.List
class	Apigee.Organizations.Environments.ArchiveDeployments.Patch

Constructor Summary

Constructors

Constructor and Description
ArchiveDeployments()

Method Summary

Modifier and Type	Method and Description
Apigee.Organizations.Environments.ArchiveDeployments.Create	create(String parent, GoogleCloudApigeeV1ArchiveDeployment content) Creates a new ArchiveDeployment.
Apigee.Organizations.Environments.ArchiveDeployments.Delete	delete(String name) Deletes an archive deployment.
Apigee.Organizations.Environments.ArchiveDeployments.GenerateDownloadUrl	generateDownloadUrl(String name, GoogleCloudApigeeV1GenerateDownloadUrlRequest content) Generates a signed URL for downloading the original zip file used to create an Archive Deployment.
Apigee.Organizations.Environments.ArchiveDeployments.GenerateUploadUrl	generateUploadUrl(String parent, GoogleCloudApigeeV1GenerateUploadUrlRequest content) Generates a signed URL for uploading an Archive zip file to Google Cloud Storage.
Apigee.Organizations.Environments.ArchiveDeployments.Get	get(String name) Gets the specified ArchiveDeployment.
Apigee.Organizations.Environments.ArchiveDeployments.List	list(String parent) Lists the ArchiveDeployments in the specified Environment.
Apigee.Organizations.Environments.ArchiveDeployments.Patch	patch(String name, GoogleCloudApigeeV1ArchiveDeployment content) Updates an existing ArchiveDeployment.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ArchiveDeployments

public ArchiveDeployments()

Method Detail

create

public Apigee.Organizations.Environments.ArchiveDeployments.Create create(String parent,
                                                                          GoogleCloudApigeeV1ArchiveDeployment content)
                                                                   throws IOException

Creates a new ArchiveDeployment. Create a request for the method "archiveDeployments.create". This request holds the parameters needed by the apigee server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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

content - the GoogleCloudApigeeV1ArchiveDeployment

Returns:

the request

Throws:

IOException

delete

public Apigee.Organizations.Environments.ArchiveDeployments.Delete delete(String name)
                                                                   throws IOException

Deletes an archive deployment. Create a request for the method "archiveDeployments.delete". This request holds the parameters needed by the apigee server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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

Returns:

the request

Throws:

IOException

generateDownloadUrl

public Apigee.Organizations.Environments.ArchiveDeployments.GenerateDownloadUrl generateDownloadUrl(String name,
                                                                                                    GoogleCloudApigeeV1GenerateDownloadUrlRequest content)
                                                                                             throws IOException

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. Create a request for the method "archiveDeployments.generateDownloadUrl". This request holds the parameters needed by the apigee server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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

content - the GoogleCloudApigeeV1GenerateDownloadUrlRequest

Returns:

the request

Throws:

IOException

generateUploadUrl

public Apigee.Organizations.Environments.ArchiveDeployments.GenerateUploadUrl generateUploadUrl(String parent,
                                                                                                GoogleCloudApigeeV1GenerateUploadUrlRequest content)
                                                                                         throws IOException

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` Create a request for the method "archiveDeployments.generateUploadUrl". This request holds the parameters needed by the apigee server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The organization and environment to upload to.

content - the GoogleCloudApigeeV1GenerateUploadUrlRequest

Returns:

the request

Throws:

IOException

get

public Apigee.Organizations.Environments.ArchiveDeployments.Get get(String name)
                                                             throws IOException

Gets the specified ArchiveDeployment. Create a request for the method "archiveDeployments.get". This request holds the parameters needed by the apigee server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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

Returns:

the request

Throws:

IOException

list

public Apigee.Organizations.Environments.ArchiveDeployments.List list(String parent)
                                                               throws IOException

Lists the ArchiveDeployments in the specified Environment. Create a request for the method "archiveDeployments.list". This request holds the parameters needed by the apigee server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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

Returns:

the request

Throws:

IOException

patch

public Apigee.Organizations.Environments.ArchiveDeployments.Patch patch(String name,
                                                                        GoogleCloudApigeeV1ArchiveDeployment content)
                                                                 throws IOException

Updates an existing ArchiveDeployment. Labels can modified but most of the other fields are not modifiable. Create a request for the method "archiveDeployments.patch". This request holds the parameters needed by the apigee server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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

content - the GoogleCloudApigeeV1ArchiveDeployment

Returns:

the request

Throws:

IOException