Documentation

Google_Service_Apigee_Resource_OrganizationsInstances extends Google_Service_Resource
in package

Application

The "instances" collection of methods.

Typical usage is: $apigeeService = new Google_Service_Apigee(...); $instances = $apigeeService->instances;

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
create() : Google_Service_Apigee_GoogleLongrunningOperation: 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)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_Apigee_GoogleLongrunningOperation: Deletes an Apigee runtime instance. The instance stops serving requests and the runtime data is deleted. **Note:** Not supported for Apigee hybrid.
get() : Google_Service_Apigee_GoogleCloudApigeeV1Instance: Gets the details for an Apigee runtime instance. **Note:** Not supported for Apigee hybrid. (instances.get)
listOrganizationsInstances() : Google_Service_Apigee_GoogleCloudApigeeV1ListInstancesResponse: Lists all Apigee runtime instances for the organization. **Note:** Not supported for Apigee hybrid. (instances.listOrganizationsInstances)
reportStatus() : Google_Service_Apigee_GoogleCloudApigeeV1ReportInstanceStatusResponse: Reports the latest status for a runtime instance. (instances.reportStatus)
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$serviceName


    private
        string
    $serviceName

$servicePath


    private
        string
    $servicePath

$stackParameters


    private
        mixed
    $stackParameters
     = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

__construct()


    public
                __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed

Parameters

$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed

Return values

mixed —

call()

TODO: This function needs simplifying.


    public
                call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass

Parameters

$name :

$arguments :

$expectedClass : = null

optional, the expected class name

Return values

Google_Http_Request|expectedClass —

create()

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)


    public
                create(string $parent, Google_Service_Apigee_GoogleCloudApigeeV1Instance $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Apigee_GoogleLongrunningOperation

Parameters

$parent : string: Required. Name of the organization. Use the following structure in your request: organizations/{org}.
$postBody : Google_Service_Apigee_GoogleCloudApigeeV1Instance
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Apigee_GoogleLongrunningOperation —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.


    public
                createRequestUri(string $restPath, array<string|int, mixed> $params) : string

Parameters

$restPath : string
$params : array<string|int, mixed>

Return values

string —

$requestUrl

delete()

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


    public
                delete(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Apigee_GoogleLongrunningOperation

(instances.delete)

Parameters

$name : string: Required. Name of the instance. Use the following structure in your request: organizations/{org}/instance/{instance}.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Apigee_GoogleLongrunningOperation —

get()

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


    public
                get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Apigee_GoogleCloudApigeeV1Instance

Parameters

$name : string: Required. Name of the instance. Use the following structure in your request: organizations/{org}/instances/{instance}.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Apigee_GoogleCloudApigeeV1Instance —

listOrganizationsInstances()

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


    public
                listOrganizationsInstances(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Apigee_GoogleCloudApigeeV1ListInstancesResponse

Parameters

$parent : string: Required. Name of the organization. Use the following structure in your request: organizations/{org}.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Apigee_GoogleCloudApigeeV1ListInstancesResponse —

reportStatus()

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


    public
                reportStatus(string $instance, Google_Service_Apigee_GoogleCloudApigeeV1ReportInstanceStatusRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Apigee_GoogleCloudApigeeV1ReportInstanceStatusResponse

Parameters

$instance : string: 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}
$postBody : Google_Service_Apigee_GoogleCloudApigeeV1ReportInstanceStatusRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Apigee_GoogleCloudApigeeV1ReportInstanceStatusResponse —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —