class OrganizationsApis extends Resource (View source)

The "apis" collection of methods.

Typical usage is:

 $apigeeService = new Google\Service\Apigee(...);
 $apis = $apigeeService->organizations_apis;

Methods

create(string $parent, GoogleApiHttpBody $postBody, array $optParams = [])

Creates an API proxy. The API proxy created will not be accessible at runtime until it is deployed to an environment. Create a new API proxy by setting the name query parameter to the name of the API proxy. Import an API proxy configuration bundle stored in zip format on your local machine to your organization by doing the following: Set the name query parameter to the name of the API proxy. Set the action query parameter to import. Set the Content-Type header to multipart/form-data. Pass as a file the name of API proxy configuration bundle stored in zip format on your local machine using the file form field. Note: To validate the API proxy configuration bundle only without importing it, set the action query parameter to validate. When importing an API proxy configuration bundle, if the API proxy does not exist, it will be created. If the API proxy exists, then a new revision is created. Invalid API proxy configurations are rejected, and a list of validation errors is returned to the client.

delete(string $name, array $optParams = [])

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

get(string $name, array $optParams = [])

Gets an API proxy including a list of existing revisions. (apis.get)

listOrganizationsApis(string $parent, array $optParams = [])

Lists the names of all API proxies in an organization. The names returned correspond to the names defined in the configuration files for each API proxy. (apis.listOrganizationsApis)

patch(string $name, GoogleCloudApigeeV1ApiProxy $postBody, array $optParams = [])

Updates an existing API proxy. (apis.patch)

Details

GoogleCloudApigeeV1ApiProxyRevision create(string $parent, GoogleApiHttpBody $postBody, array $optParams = [])

Creates an API proxy. The API proxy created will not be accessible at runtime until it is deployed to an environment. Create a new API proxy by setting the name query parameter to the name of the API proxy. Import an API proxy configuration bundle stored in zip format on your local machine to your organization by doing the following: Set the name query parameter to the name of the API proxy. Set the action query parameter to import. Set the Content-Type header to multipart/form-data. Pass as a file the name of API proxy configuration bundle stored in zip format on your local machine using the file form field. Note: To validate the API proxy configuration bundle only without importing it, set the action query parameter to validate. When importing an API proxy configuration bundle, if the API proxy does not exist, it will be created. If the API proxy exists, then a new revision is created. Invalid API proxy configurations are rejected, and a list of validation errors is returned to the client.

(apis.create)

Parameters

string $parent

Required. Name of the organization in the following format: organizations/{org}

GoogleApiHttpBody $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1ApiProxyRevision

Exceptions

Exception

GoogleCloudApigeeV1ApiProxy delete(string $name, array $optParams = [])

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

(apis.delete)

Parameters

string $name

Required. Name of the API proxy in the following format: organizations/{org}/apis/{api}

array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1ApiProxy

Exceptions

Exception

GoogleCloudApigeeV1ApiProxy get(string $name, array $optParams = [])

Gets an API proxy including a list of existing revisions. (apis.get)

Parameters

string $name

Required. Name of the API proxy in the following format: organizations/{org}/apis/{api}

array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1ApiProxy

Exceptions

Exception

GoogleCloudApigeeV1ListApiProxiesResponse listOrganizationsApis(string $parent, array $optParams = [])

Lists the names of all API proxies in an organization. The names returned correspond to the names defined in the configuration files for each API proxy. (apis.listOrganizationsApis)

Parameters

string $parent

Required. Name of the organization in the following format: organizations/{org}

array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1ListApiProxiesResponse

Exceptions

Exception

GoogleCloudApigeeV1ApiProxy patch(string $name, GoogleCloudApigeeV1ApiProxy $postBody, array $optParams = [])

Updates an existing API proxy. (apis.patch)

Parameters

string $name

Required. API proxy to update in the following format: organizations/{org}/apis/{api}

GoogleCloudApigeeV1ApiProxy $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1ApiProxy

Exceptions

Exception