close()

Close httplib2 connections.

delete(name, x__xgafv=None)

Deletes an API proxy revision and all policies, resources, endpoints, and revisions associated with it. The API proxy revision must be undeployed before you can delete it.

Args:
name: string, Required. API proxy revision in the following format: `organizations/{org}/apis/{api}/revisions/{rev}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # API proxy revision.
"archive": "A String", # Output only. The archive that generated this proxy revision. This field is only present on proxy revisions that were generated by an archive. Proxies generated by archives cannot be updated, deleted, or deployed to other environments. Format: `organizations/*/environments/*/archiveDeployments/*`
"basepaths": [ # Base URL of the API proxy.
"A String",
],
"configurationVersion": { # Version of the API proxy configuration schema. Currently, only 4.0 is supported. # Version of the API proxy configuration schema to which the API proxy conforms. Currently, the only supported value is 4.0 (`majorVersion.minorVersion`). This setting may be used in the future to track the evolution of the API proxy format.
"majorVersion": 42, # Major version of the API proxy configuration schema.
"minorVersion": 42, # Minor version of the API proxy configuration schema.
},
"contextInfo": "A String", # Revision number, app name, and organization for the API proxy.
"createdAt": "A String", # Time that the API proxy revision was created in milliseconds since epoch.
"description": "A String", # Description of the API proxy revision.
"displayName": "A String", # Human-readable name of the API proxy.
"entityMetaDataAsProperties": { # Metadata describing the API proxy revision as a key-value map.
"a_key": "A String",
},
"hasExtensiblePolicy": True or False, # Output only. This field will be marked as true if revision contains any policies marked as extensible.
"integrationEndpoints": [ # List of IntegrationEndpoints in the '/integration-endpoints' directory of the API proxy. This is a 'manifest' setting designed to provide visibility into the contents of the API proxy.
"A String",
],
"lastModifiedAt": "A String", # Time that the API proxy revision was last modified in milliseconds since epoch.
"name": "A String", # Name of the API proxy.
"policies": [ # List of policy names included in the API proxy revision..
"A String",
],
"proxies": [ # List of proxy names included in the API proxy revision.
"A String",
],
"proxyEndpoints": [ # List of ProxyEndpoints in the `/proxies` directory of the API proxy. Typically, this element is included only when the API proxy was created using the Edge UI. This is a 'manifest' setting designed to provide visibility into the contents of the API proxy.
"A String",
],
"resourceFiles": { # List of resource files. # List of resource files included in the API proxy revision.
"resourceFile": [ # List of resource files.
{ # Metadata about a resource file.
"name": "A String", # ID of the resource file.
"type": "A String", # Resource file type. {{ resource_file_type }}
},
],
},
"resources": [ # List of the resources included in the API proxy revision formatted as "{type}://{name}".
"A String",
],
"revision": "A String", # API proxy revision.
"sharedFlows": [ # List of the shared flows included in the API proxy revision.
"A String",
],
"spec": "A String", # OpenAPI Specification that is associated with the API proxy. The value is set to a URL or to a path in the specification store.
"targetEndpoints": [ # List of TargetEndpoints in the `/targets` directory of the API proxy. Typically, this element is included only when the API proxy was created using the Edge UI. This is a 'manifest' setting designed to provide visibility into the contents of the API proxy.
"A String",
],
"targetServers": [ # List of TargetServers referenced in any TargetEndpoint in the API proxy. Typically, you will see this element only when the API proxy was created using the Edge UI. This is a 'manifest' setting designed to provide visibility into the contents of the API proxy.
"A String",
],
"targets": [ # List of the targets included in the API proxy revision.
"A String",
],
"teams": [ # List of the teams included in the API proxy revision.
"A String",
],
"type": "A String", # Type. Set to `Application`. Maintained for compatibility with the Apigee Edge API.
}

get(name, format=None, x__xgafv=None)

Gets an API proxy revision. To download the API proxy configuration bundle for the specified revision as a zip file, set the `format` query parameter to `bundle`. If you are using curl, specify `-o filename.zip` to save the output to a file; otherwise, it displays to `stdout`. Then, develop the API proxy configuration locally and upload the updated API proxy configuration revision, as described in [updateApiProxyRevision](updateApiProxyRevision).

Args:
  name: string, Required. API proxy revision in the following format: `organizations/{org}/apis/{api}/revisions/{rev}` (required)
  format: string, Format used when downloading the API proxy configuration revision. Set to `bundle` to download the API proxy configuration revision as a zip file.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
  "data": "A String", # The HTTP request/response body as raw binary.
  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
    {
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  ],
}

updateApiProxyRevision(name, body=None, validate=None, x__xgafv=None)

Updates an existing API proxy revision by uploading the API proxy configuration bundle as a zip file from your local machine. You can update only API proxy revisions that have never been deployed. After deployment, an API proxy revision becomes immutable, even if it is undeployed. Set the `Content-Type` header to either `multipart/form-data` or `application/octet-stream`.

Args:
name: string, Required. API proxy revision to update in the following format: `organizations/{org}/apis/{api}/revisions/{rev}` (required)
body: object, The request body.
The object takes the form of:

{ # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
"contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
"data": "A String", # The HTTP request/response body as raw binary.
"extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
}

validate: boolean, Ignored. All uploads are validated regardless of the value of this field. Maintained for compatibility with Apigee Edge API.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # API proxy revision.
"archive": "A String", # Output only. The archive that generated this proxy revision. This field is only present on proxy revisions that were generated by an archive. Proxies generated by archives cannot be updated, deleted, or deployed to other environments. Format: `organizations/*/environments/*/archiveDeployments/*`
"basepaths": [ # Base URL of the API proxy.
"A String",
],
"configurationVersion": { # Version of the API proxy configuration schema. Currently, only 4.0 is supported. # Version of the API proxy configuration schema to which the API proxy conforms. Currently, the only supported value is 4.0 (`majorVersion.minorVersion`). This setting may be used in the future to track the evolution of the API proxy format.
"majorVersion": 42, # Major version of the API proxy configuration schema.
"minorVersion": 42, # Minor version of the API proxy configuration schema.
},
"contextInfo": "A String", # Revision number, app name, and organization for the API proxy.
"createdAt": "A String", # Time that the API proxy revision was created in milliseconds since epoch.
"description": "A String", # Description of the API proxy revision.
"displayName": "A String", # Human-readable name of the API proxy.
"entityMetaDataAsProperties": { # Metadata describing the API proxy revision as a key-value map.
"a_key": "A String",
},
"hasExtensiblePolicy": True or False, # Output only. This field will be marked as true if revision contains any policies marked as extensible.
"integrationEndpoints": [ # List of IntegrationEndpoints in the '/integration-endpoints' directory of the API proxy. This is a 'manifest' setting designed to provide visibility into the contents of the API proxy.
"A String",
],
"lastModifiedAt": "A String", # Time that the API proxy revision was last modified in milliseconds since epoch.
"name": "A String", # Name of the API proxy.
"policies": [ # List of policy names included in the API proxy revision..
"A String",
],
"proxies": [ # List of proxy names included in the API proxy revision.
"A String",
],
"proxyEndpoints": [ # List of ProxyEndpoints in the `/proxies` directory of the API proxy. Typically, this element is included only when the API proxy was created using the Edge UI. This is a 'manifest' setting designed to provide visibility into the contents of the API proxy.
"A String",
],
"resourceFiles": { # List of resource files. # List of resource files included in the API proxy revision.
"resourceFile": [ # List of resource files.
{ # Metadata about a resource file.
"name": "A String", # ID of the resource file.
"type": "A String", # Resource file type. {{ resource_file_type }}
},
],
},
"resources": [ # List of the resources included in the API proxy revision formatted as "{type}://{name}".
"A String",
],
"revision": "A String", # API proxy revision.
"sharedFlows": [ # List of the shared flows included in the API proxy revision.
"A String",
],
"spec": "A String", # OpenAPI Specification that is associated with the API proxy. The value is set to a URL or to a path in the specification store.
"targetEndpoints": [ # List of TargetEndpoints in the `/targets` directory of the API proxy. Typically, this element is included only when the API proxy was created using the Edge UI. This is a 'manifest' setting designed to provide visibility into the contents of the API proxy.
"A String",
],
"targetServers": [ # List of TargetServers referenced in any TargetEndpoint in the API proxy. Typically, you will see this element only when the API proxy was created using the Edge UI. This is a 'manifest' setting designed to provide visibility into the contents of the API proxy.
"A String",
],
"targets": [ # List of the targets included in the API proxy revision.
"A String",
],
"teams": [ # List of the teams included in the API proxy revision.
"A String",
],
"type": "A String", # Type. Set to `Application`. Maintained for compatibility with the Apigee Edge API.
}

Apigee API . organizations . apis . revisions

Instance Methods

Method Details