Apigee API . organizations . apiproducts . attributes

Instance Methods

close()

Close httplib2 connections.

delete(name, x__xgafv=None)

Deletes an API product attribute.

get(name, x__xgafv=None)

Gets the value of an API product attribute.

list(parent, x__xgafv=None)

Lists all API product attributes.

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

Updates the value of an API product attribute. **Note**: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with entities also get cached for at least 180 seconds after entity is accessed during runtime. In this case, the `ExpiresIn` element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds.

Method Details

close()
Close httplib2 connections.
delete(name, x__xgafv=None)
Deletes an API product attribute.

Args:
  name: string, Required. Name of the API product attribute. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/attributes/{attribute}` (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 pair to store extra metadata.
  "name": "A String", # API key of the attribute.
  "value": "A String", # Value of the attribute.
}
get(name, x__xgafv=None)
Gets the value of an API product attribute.

Args:
  name: string, Required. Name of the API product attribute. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/attributes/{attribute}` (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 pair to store extra metadata.
  "name": "A String", # API key of the attribute.
  "value": "A String", # Value of the attribute.
}
list(parent, x__xgafv=None)
Lists all API product attributes.

Args:
  parent: string, Required. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  "attribute": [ # List of attributes.
    { # Key-value pair to store extra metadata.
      "name": "A String", # API key of the attribute.
      "value": "A String", # Value of the attribute.
    },
  ],
}
updateApiProductAttribute(name, body=None, x__xgafv=None)
Updates the value of an API product attribute. **Note**: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with entities also get cached for at least 180 seconds after entity is accessed during runtime. In this case, the `ExpiresIn` element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds.

Args:
  name: string, Required. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Key-value pair to store extra metadata.
  "name": "A String", # API key of the attribute.
  "value": "A String", # Value of the attribute.
}

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

Returns:
  An object of the form:

    { # Key-value pair to store extra metadata.
  "name": "A String", # API key of the attribute.
  "value": "A String", # Value of the attribute.
}