Documentation

Google_Service_Apigee_Resource_OrganizationsEnvironmentsFlowhooks extends Google_Service_Resource
in package

The "flowhooks" collection of methods.

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

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
attachSharedFlowToFlowHook()  : Google_Service_Apigee_GoogleCloudApigeeV1FlowHook
Attaches a shared flow to a flow hook. (flowhooks.attachSharedFlowToFlowHook)
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
detachSharedFlowFromFlowHook()  : Google_Service_Apigee_GoogleCloudApigeeV1FlowHook
Detaches a shared flow from a flow hook.
get()  : Google_Service_Apigee_GoogleCloudApigeeV1FlowHook
Returns the name of the shared flow attached to the specified flow hook. If there's no shared flow attached to the flow hook, the API does not return an error; it simply does not return a name in the response. (flowhooks.get)
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 —

attachSharedFlowToFlowHook()

Attaches a shared flow to a flow hook. (flowhooks.attachSharedFlowToFlowHook)

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

Required. Name of the flow hook to which the shared flow should be attached in the following format: organizations/{org}/environments/{env}/flowhooks/{flowhook}

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

Optional parameters.

Return values
Google_Service_Apigee_GoogleCloudApigeeV1FlowHook —

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 —

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

detachSharedFlowFromFlowHook()

Detaches a shared flow from a flow hook.

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

(flowhooks.detachSharedFlowFromFlowHook)

Parameters
$name : string

Required. Name of the flow hook to detach in the following format: organizations/{org}/environments/{env}/flowhooks/{flowhook}

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

Optional parameters.

Return values
Google_Service_Apigee_GoogleCloudApigeeV1FlowHook —

get()

Returns the name of the shared flow attached to the specified flow hook. If there's no shared flow attached to the flow hook, the API does not return an error; it simply does not return a name in the response. (flowhooks.get)

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

Required. Name of the flow hook in the following format: organizations/{org}/environments/{env}/flowhooks/{flowhook}

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

Optional parameters.

Return values
Google_Service_Apigee_GoogleCloudApigeeV1FlowHook —

convertToArrayAndStripNulls()

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

Search results