Documentation

Google_Service_Apigee_Resource_OrganizationsSharedflows extends Google_Service_Resource
in package

The "sharedflows" collection of methods.

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

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_GoogleCloudApigeeV1SharedFlowRevision
Uploads a ZIP-formatted shared flow configuration bundle to an organization.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_Apigee_GoogleCloudApigeeV1SharedFlow
Deletes a shared flow and all it's revisions. The shared flow must be undeployed before you can delete it. (sharedflows.delete)
get()  : Google_Service_Apigee_GoogleCloudApigeeV1SharedFlow
Gets a shared flow by name, including a list of its revisions.
listOrganizationsSharedflows()  : Google_Service_Apigee_GoogleCloudApigeeV1ListSharedFlowsResponse
Lists all shared flows in the organization.
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()

Uploads a ZIP-formatted shared flow configuration bundle to an organization.

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

If the shared flow already exists, this creates a new revision of it. If the shared flow does not exist, this creates it. Once imported, the shared flow revision must be deployed before it can be accessed at runtime. The size limit of a shared flow bundle is 15 MB. (sharedflows.create)

Parameters
$parent : string

Required. The name of the parent organization under which to create the shared flow. Must be of the form: organizations/{organization_id}

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

Optional parameters.

Tags
opt_param

string name Required. The name to give the shared flow

opt_param

string action Required. Must be set to either import or validate.

Return values
Google_Service_Apigee_GoogleCloudApigeeV1SharedFlowRevision

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 shared flow and all it's revisions. The shared flow must be undeployed before you can delete it. (sharedflows.delete)

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

Required. shared flow name of the form: organizations/{organization_id}/sharedflows/{shared_flow_id}

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

Optional parameters.

Return values
Google_Service_Apigee_GoogleCloudApigeeV1SharedFlow

get()

Gets a shared flow by name, including a list of its revisions.

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

(sharedflows.get)

Parameters
$name : string

Required. The name of the shared flow to get. Must be of the form: organizations/{organization_id}/sharedflows/{shared_flow_id}

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

Optional parameters.

Return values
Google_Service_Apigee_GoogleCloudApigeeV1SharedFlow

listOrganizationsSharedflows()

Lists all shared flows in the organization.

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

(sharedflows.listOrganizationsSharedflows)

Parameters
$parent : string

Required. The name of the parent organization under which to get shared flows. Must be of the form: organizations/{organization_id}

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

Optional parameters.

Tags
opt_param

bool includeMetaData Indicates whether to include shared flow metadata in the response.

opt_param

bool includeRevisions Indicates whether to include a list of revisions in the response.

Return values
Google_Service_Apigee_GoogleCloudApigeeV1ListSharedFlowsResponse

convertToArrayAndStripNulls()

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

Search results