1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Apigee
  7. \
  8. Resource
  9. \
  10. OrganizationsInstances

OrganizationsInstances

class OrganizationsInstances extends Resource (View source)

The "instances" collection of methods.

Typical usage is:

 $apigeeService = new Google\Service\Apigee(...);
 $instances = $apigeeService->organizations_instances;

Methods

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

Creates an Apigee runtime instance. The instance is accessible from the authorized network configured on the organization. Note: Not supported for Apigee hybrid. (instances.create)

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

Deletes an Apigee runtime instance. The instance stops serving requests and the runtime data is deleted. Note: Not supported for Apigee hybrid.

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

Gets the details for an Apigee runtime instance. Note: Not supported for Apigee hybrid. (instances.get)

GoogleCloudApigeeV1ListInstancesResponse
listOrganizationsInstances(string $parent, array $optParams = [])

Lists all Apigee runtime instances for the organization. Note: Not supported for Apigee hybrid. (instances.listOrganizationsInstances)

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

Updates an Apigee runtime instance. You can update the fields described in NodeConfig. No other fields will be updated. Note: Not supported for Apigee hybrid. (instances.patch)

GoogleCloudApigeeV1ReportInstanceStatusResponse
reportStatus(string $instance, GoogleCloudApigeeV1ReportInstanceStatusRequest $postBody, array $optParams = [])

Reports the latest status for a runtime instance. (instances.reportStatus)

Details

at line 48
GoogleLongrunningOperation create(string $parent, GoogleCloudApigeeV1Instance $postBody, array $optParams = [])

Creates an Apigee runtime instance. The instance is accessible from the authorized network configured on the organization. Note: Not supported for Apigee hybrid. (instances.create)

Parameters

string $parent

Required. Name of the organization. Use the following structure in your request: organizations/{org}.
GoogleCloudApigeeV1Instance $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

at line 65
GoogleLongrunningOperation delete(string $name, array $optParams = [])

Deletes an Apigee runtime instance. The instance stops serving requests and the runtime data is deleted. Note: Not supported for Apigee hybrid.

(instances.delete)

Parameters

string $name

Required. Name of the instance. Use the following structure in your request: organizations/{org}/instances/{instance}.
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

at line 81
GoogleCloudApigeeV1Instance get(string $name, array $optParams = [])

Gets the details for an Apigee runtime instance. Note: Not supported for Apigee hybrid. (instances.get)

Parameters

string $name

Required. Name of the instance. Use the following structure in your request: organizations/{org}/instances/{instance}.
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1Instance

Exceptions

Exception

at line 102
GoogleCloudApigeeV1ListInstancesResponse listOrganizationsInstances(string $parent, array $optParams = [])

Lists all Apigee runtime instances for the organization. Note: Not supported for Apigee hybrid. (instances.listOrganizationsInstances)

Parameters

string $parent

Required. Name of the organization. Use the following structure in your request: organizations/{org}.
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1ListInstancesResponse

Exceptions

Exception

at line 122
GoogleLongrunningOperation patch(string $name, GoogleCloudApigeeV1Instance $postBody, array $optParams = [])

Updates an Apigee runtime instance. You can update the fields described in NodeConfig. No other fields will be updated. Note: Not supported for Apigee hybrid. (instances.patch)

Parameters

string $name

Required. Name of the instance. Use the following structure in your request: organizations/{org}/instances/{instance}.
GoogleCloudApigeeV1Instance $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

at line 139
GoogleCloudApigeeV1ReportInstanceStatusResponse reportStatus(string $instance, GoogleCloudApigeeV1ReportInstanceStatusRequest $postBody, array $optParams = [])

Reports the latest status for a runtime instance. (instances.reportStatus)

Parameters

string $instance

The name of the instance reporting this status. For SaaS the request will be rejected if no instance exists under this name. Format is organizations/{org}/instances/{instance}
GoogleCloudApigeeV1ReportInstanceStatusRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1ReportInstanceStatusResponse

Exceptions

Exception