Apigee API . organizations . environments . references

close()

Close httplib2 connections.

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

Creates a Reference in the specified environment.

Args:
  parent: string, Required. The parent environment name under which the Reference will be created. Must be of the form `organizations/{org}/environments/{env}`. (required)
  body: object, The request body.
    The object takes the form of:

{ # A Reference configuration. References must refer to a keystore that also exists in the parent environment.
  "description": "A String", # Optional. A human-readable description of this reference.
  "name": "A String", # Required. The resource id of this reference. Values must match the regular expression [\w\s\-.]+.
  "refers": "A String", # Required. The id of the resource to which this reference refers. Must be the id of a resource that exists in the parent environment and is of the given resource_type.
  "resourceType": "A String", # The type of resource referred to by this reference. Valid values are 'KeyStore' or 'TrustStore'.
}

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

Returns:
  An object of the form:

    { # A Reference configuration. References must refer to a keystore that also exists in the parent environment.
  "description": "A String", # Optional. A human-readable description of this reference.
  "name": "A String", # Required. The resource id of this reference. Values must match the regular expression [\w\s\-.]+.
  "refers": "A String", # Required. The id of the resource to which this reference refers. Must be the id of a resource that exists in the parent environment and is of the given resource_type.
  "resourceType": "A String", # The type of resource referred to by this reference. Valid values are 'KeyStore' or 'TrustStore'.
}

delete(name, x__xgafv=None)

Deletes a Reference from an environment. Returns the deleted Reference resource.

Args:
  name: string, Required. The name of the Reference to delete. Must be of the form `organizations/{org}/environments/{env}/references/{ref}`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A Reference configuration. References must refer to a keystore that also exists in the parent environment.
  "description": "A String", # Optional. A human-readable description of this reference.
  "name": "A String", # Required. The resource id of this reference. Values must match the regular expression [\w\s\-.]+.
  "refers": "A String", # Required. The id of the resource to which this reference refers. Must be the id of a resource that exists in the parent environment and is of the given resource_type.
  "resourceType": "A String", # The type of resource referred to by this reference. Valid values are 'KeyStore' or 'TrustStore'.
}

get(name, x__xgafv=None)

Gets a Reference resource.

Args:
  name: string, Required. The name of the Reference to get. Must be of the form `organizations/{org}/environments/{env}/references/{ref}`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A Reference configuration. References must refer to a keystore that also exists in the parent environment.
  "description": "A String", # Optional. A human-readable description of this reference.
  "name": "A String", # Required. The resource id of this reference. Values must match the regular expression [\w\s\-.]+.
  "refers": "A String", # Required. The id of the resource to which this reference refers. Must be the id of a resource that exists in the parent environment and is of the given resource_type.
  "resourceType": "A String", # The type of resource referred to by this reference. Valid values are 'KeyStore' or 'TrustStore'.
}

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

Updates an existing Reference. Note that this operation has PUT semantics; it will replace the entirety of the existing Reference with the resource in the request body.

Args:
  name: string, Required. The name of the Reference to update. Must be of the form `organizations/{org}/environments/{env}/references/{ref}`. (required)
  body: object, The request body.
    The object takes the form of:

{ # A Reference configuration. References must refer to a keystore that also exists in the parent environment.
  "description": "A String", # Optional. A human-readable description of this reference.
  "name": "A String", # Required. The resource id of this reference. Values must match the regular expression [\w\s\-.]+.
  "refers": "A String", # Required. The id of the resource to which this reference refers. Must be the id of a resource that exists in the parent environment and is of the given resource_type.
  "resourceType": "A String", # The type of resource referred to by this reference. Valid values are 'KeyStore' or 'TrustStore'.
}

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

Returns:
  An object of the form:

    { # A Reference configuration. References must refer to a keystore that also exists in the parent environment.
  "description": "A String", # Optional. A human-readable description of this reference.
  "name": "A String", # Required. The resource id of this reference. Values must match the regular expression [\w\s\-.]+.
  "refers": "A String", # Required. The id of the resource to which this reference refers. Must be the id of a resource that exists in the parent environment and is of the given resource_type.
  "resourceType": "A String", # The type of resource referred to by this reference. Valid values are 'KeyStore' or 'TrustStore'.
}