com.google.api.services.apigee.v1

Class Apigee.Organizations.Environments.Keyvaluemaps.Entries

java.lang.Object

com.google.api.services.apigee.v1.Apigee.Organizations.Environments.Keyvaluemaps.Entries

Enclosing class:

Apigee.Organizations.Environments.Keyvaluemaps

public class Apigee.Organizations.Environments.Keyvaluemaps.Entries
extends Object

The "entries" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Apigee.Organizations.Environments.Keyvaluemaps.Entries.Create
class	Apigee.Organizations.Environments.Keyvaluemaps.Entries.Delete
class	Apigee.Organizations.Environments.Keyvaluemaps.Entries.Get
class	Apigee.Organizations.Environments.Keyvaluemaps.Entries.List
class	Apigee.Organizations.Environments.Keyvaluemaps.Entries.Update

Constructor Summary

Constructors

Constructor and Description
Entries()

Method Summary

Modifier and Type	Method and Description
Apigee.Organizations.Environments.Keyvaluemaps.Entries.Create	create(String parent, GoogleCloudApigeeV1KeyValueEntry content) Creates key value entries in a key value map scoped to an organization, environment, or API proxy.
Apigee.Organizations.Environments.Keyvaluemaps.Entries.Delete	delete(String name) Deletes a key value entry from a key value map scoped to an organization, environment, or API proxy.
Apigee.Organizations.Environments.Keyvaluemaps.Entries.Get	get(String name) Get the key value entry value for a key value map scoped to an organization, environment, or API proxy.
Apigee.Organizations.Environments.Keyvaluemaps.Entries.List	list(String parent) Lists key value entries for key values maps scoped to an organization, environment, or API proxy.
Apigee.Organizations.Environments.Keyvaluemaps.Entries.Update	update(String name, GoogleCloudApigeeV1KeyValueEntry content) Update key value entry scoped to an organization, environment, or API proxy for an existing key.

Methods inherited from class java.lang.Object

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

Constructor Detail

Entries

public Entries()

Method Detail

create

public Apigee.Organizations.Environments.Keyvaluemaps.Entries.Create create(String parent,
                                                                            GoogleCloudApigeeV1KeyValueEntry content)
                                                                     throws IOException

Creates key value entries in a key value map scoped to an organization, environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x and higher. Create a request for the method "entries.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. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system- administration/spaces/apigee-spaces-overview).

content - the GoogleCloudApigeeV1KeyValueEntry

Returns:

the request

Throws:

IOException

delete

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

Deletes a key value entry from a key value map scoped to an organization, environment, or API proxy. **Notes:** * After you delete the key value entry, the policy consuming the entry will continue to function with its cached values for a few minutes. This is expected behavior. * Supported for Apigee hybrid 1.8.x and higher. Create a request for the method "entries.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. Scope as indicated by the URI in which to delete the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `o rganizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/ {entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system- administration/spaces/apigee-spaces-overview).

Returns:

the request

Throws:

IOException

get

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

Get the key value entry value for a key value map scoped to an organization, environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x and higher. Create a request for the method "entries.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. Scope as indicated by the URI in which to fetch the key value map entry/value. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `o rganizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/ {entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system- administration/spaces/apigee-spaces-overview).

Returns:

the request

Throws:

IOException

list

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

Lists key value entries for key values maps scoped to an organization, environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x and higher. Create a request for the method "entries.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. Scope as indicated by the URI in which to list key value maps. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system- administration/spaces/apigee-spaces-overview).

Returns:

the request

Throws:

IOException

update

public Apigee.Organizations.Environments.Keyvaluemaps.Entries.Update update(String name,
                                                                            GoogleCloudApigeeV1KeyValueEntry content)
                                                                     throws IOException

Update key value entry scoped to an organization, environment, or API proxy for an existing key. Create a request for the method "entries.update". 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. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system- administration/spaces/apigee-spaces-overview).

content - the GoogleCloudApigeeV1KeyValueEntry

Returns:

the request

Throws:

IOException