Documentation

Google_Service_Apigee_Resource_OrganizationsEnvironmentsReferences extends Google_Service_Resource
in package

The "references" collection of methods.

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

Table of Contents

$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_GoogleCloudApigeeV1Reference
Creates a Reference in the specified environment. (references.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_Apigee_GoogleCloudApigeeV1Reference
Deletes a Reference from an environment. Returns the deleted Reference resource. (references.delete)
get()  : Google_Service_Apigee_GoogleCloudApigeeV1Reference
Gets a Reference resource. (references.get)
update()  : Google_Service_Apigee_GoogleCloudApigeeV1Reference
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. (references.update)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$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'))

Methods

__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
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

create()

Creates a Reference in the specified environment. (references.create)

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

Required. The parent environment name under which the Reference will be created. Must be of the form organizations/{org}/environments/{env}.

$postBody : Google_Service_Apigee_GoogleCloudApigeeV1Reference
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Apigee_GoogleCloudApigeeV1Reference —

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>
Tags
static
Return values
string —

$requestUrl

delete()

Deletes a Reference from an environment. Returns the deleted Reference resource. (references.delete)

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

Required. The name of the Reference to delete. Must be of the form organizations/{org}/environments/{env}/references/{ref}.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Apigee_GoogleCloudApigeeV1Reference —

get()

Gets a Reference resource. (references.get)

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

Required. The name of the Reference to get. Must be of the form organizations/{org}/environments/{env}/references/{ref}.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Apigee_GoogleCloudApigeeV1Reference —

update()

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. (references.update)

public update(string $name, Google_Service_Apigee_GoogleCloudApigeeV1Reference $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Apigee_GoogleCloudApigeeV1Reference
Parameters
$name : string

Required. The name of the Reference to update. Must be of the form organizations/{org}/environments/{env}/references/{ref}.

$postBody : Google_Service_Apigee_GoogleCloudApigeeV1Reference
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Apigee_GoogleCloudApigeeV1Reference —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results