Apigee API . organizations . apis . keyvaluemaps . entries

close()

Close httplib2 connections.

create(parent, body=None, x__xgafv=None)

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.

Args:
  parent: string, 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}`. (required)
  body: object, The request body.
    The object takes the form of:

{ # Key value map pair where the value represents the data associated with the corresponding key. **Note**: Supported for Apigee hybrid 1.8.x and higher.
  "name": "A String", # Resource URI that can be used to identify the scope of the key value map entries.
  "value": "A String", # Required. Data or payload that is being retrieved and associated with the unique key.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Key value map pair where the value represents the data associated with the corresponding key. **Note**: Supported for Apigee hybrid 1.8.x and higher.
  "name": "A String", # Resource URI that can be used to identify the scope of the key value map entries.
  "value": "A String", # Required. Data or payload that is being retrieved and associated with the unique key.
}

delete(name, x__xgafv=None)

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.

Args:
  name: string, 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}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Key value map pair where the value represents the data associated with the corresponding key. **Note**: Supported for Apigee hybrid 1.8.x and higher.
  "name": "A String", # Resource URI that can be used to identify the scope of the key value map entries.
  "value": "A String", # Required. Data or payload that is being retrieved and associated with the unique key.
}

get(name, x__xgafv=None)

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.

Args:
  name: string, 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}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Key value map pair where the value represents the data associated with the corresponding key. **Note**: Supported for Apigee hybrid 1.8.x and higher.
  "name": "A String", # Resource URI that can be used to identify the scope of the key value map entries.
  "value": "A String", # Required. Data or payload that is being retrieved and associated with the unique key.
}

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

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.

Args:
  parent: string, 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}`. (required)
  pageSize: integer, Optional. Maximum number of key value entries to return. If unspecified, at most 100 entries will be returned.
  pageToken: string, Optional. Page token. If provides, must be a valid key value entry returned from a previous call that can be used to retrieve the next page.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The request structure for listing key value map keys and its corresponding values.
  "keyValueEntries": [ # One or more key value map keys and values.
    { # Key value map pair where the value represents the data associated with the corresponding key. **Note**: Supported for Apigee hybrid 1.8.x and higher.
      "name": "A String", # Resource URI that can be used to identify the scope of the key value map entries.
      "value": "A String", # Required. Data or payload that is being retrieved and associated with the unique key.
    },
  ],
  "nextPageToken": "A String", # Token that can be sent as `next_page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.
        

update(name, body=None, x__xgafv=None)

Update key value entry scoped to an organization, environment, or API proxy for an existing key.

Args:
  name: string, 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}`. (required)
  body: object, The request body.
    The object takes the form of:

{ # Key value map pair where the value represents the data associated with the corresponding key. **Note**: Supported for Apigee hybrid 1.8.x and higher.
  "name": "A String", # Resource URI that can be used to identify the scope of the key value map entries.
  "value": "A String", # Required. Data or payload that is being retrieved and associated with the unique key.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Key value map pair where the value represents the data associated with the corresponding key. **Note**: Supported for Apigee hybrid 1.8.x and higher.
  "name": "A String", # Resource URI that can be used to identify the scope of the key value map entries.
  "value": "A String", # Required. Data or payload that is being retrieved and associated with the unique key.
}