com.google.api.services.apigee.v1

Class Apigee.Organizations.Environments.Deployments

java.lang.Object

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

Enclosing class:

Apigee.Organizations.Environments

public class Apigee.Organizations.Environments.Deployments
extends Object

The "deployments" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Apigee.Organizations.Environments.Deployments.Get
class	Apigee.Organizations.Environments.Deployments.GetIamPolicy
class	Apigee.Organizations.Environments.Deployments.List
class	Apigee.Organizations.Environments.Deployments.SetIamPolicy
class	Apigee.Organizations.Environments.Deployments.TestIamPermissions

Constructor Summary

Constructors

Constructor and Description
Deployments()

Method Summary

Modifier and Type	Method and Description
Apigee.Organizations.Environments.Deployments.Get	get(String name) Gets a particular deployment of Api proxy or a shared flow in an environment Create a request for the method "deployments.get".
Apigee.Organizations.Environments.Deployments.GetIamPolicy	getIamPolicy(String resource) Gets the IAM policy on a deployment.
Apigee.Organizations.Environments.Deployments.List	list(String parent) Lists all deployments of API proxies or shared flows in an environment.
Apigee.Organizations.Environments.Deployments.SetIamPolicy	setIamPolicy(String resource, GoogleIamV1SetIamPolicyRequest content) Sets the IAM policy on a deployment, if the policy already exists it will be replaced.
Apigee.Organizations.Environments.Deployments.TestIamPermissions	testIamPermissions(String resource, GoogleIamV1TestIamPermissionsRequest content) Tests the permissions of a user on a deployment, and returns a subset of permissions that the user has on the deployment.

Methods inherited from class java.lang.Object

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

Constructor Detail

Deployments

public Deployments()

Method Detail

get

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

Gets a particular deployment of Api proxy or a shared flow in an environment Create a request for the method "deployments.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 api proxy or the shared flow deployment. Use the following structure in your request: `organizations/{org}/environments/{env}/deployments/{deployment}`

Returns:

the request

Throws:

IOException

getIamPolicy

public Apigee.Organizations.Environments.Deployments.GetIamPolicy getIamPolicy(String resource)
                                                                        throws IOException

Gets the IAM policy on a deployment. For more information, see [Manage users, roles, and permissions using the API](https://cloud.google.com/apigee/docs/api-platform/system- administration/manage-users-roles). You must have the `apigee.deployments.getIamPolicy` permission to call this API. Create a request for the method "deployments.getIamPolicy". 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:

resource - REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

Returns:

the request

Throws:

IOException

list

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

Lists all deployments of API proxies or shared flows in an environment. Create a request for the method "deployments.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 return deployment information in the following format: `organizations/{org}/environments/{env}`

Returns:

the request

Throws:

IOException

setIamPolicy

public Apigee.Organizations.Environments.Deployments.SetIamPolicy setIamPolicy(String resource,
                                                                               GoogleIamV1SetIamPolicyRequest content)
                                                                        throws IOException

Sets the IAM policy on a deployment, if the policy already exists it will be replaced. For more information, see [Manage users, roles, and permissions using the API](https://cloud.google.com/apigee/docs/api-platform/system-administration/manage-users-roles). You must have the `apigee.deployments.setIamPolicy` permission to call this API. Create a request for the method "deployments.setIamPolicy". 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:

resource - REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

content - the GoogleIamV1SetIamPolicyRequest

Returns:

the request

Throws:

IOException

testIamPermissions

public Apigee.Organizations.Environments.Deployments.TestIamPermissions testIamPermissions(String resource,
                                                                                           GoogleIamV1TestIamPermissionsRequest content)
                                                                                    throws IOException

Tests the permissions of a user on a deployment, and returns a subset of permissions that the user has on the deployment. If the deployment does not exist, an empty permission set is returned (a NOT_FOUND error is not returned). Create a request for the method "deployments.testIamPermissions". 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:

resource - REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

content - the GoogleIamV1TestIamPermissionsRequest

Returns:

the request

Throws:

IOException