Documentation

Google_Service_Apigee_Resource_OrganizationsEnvironmentsSharedflowsRevisions extends Google_Service_Resource
in package

The "revisions" collection of methods.

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

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.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
deploy()  : Google_Service_Apigee_GoogleCloudApigeeV1Deployment
Deploys a revision of a shared flow. If another revision of the same shared flow is currently deployed, set the `override` parameter to `true` to have this revision replace the currently deployed revision. You cannot use a shared flow until it has been deployed to an environment. For a request path `organizations/{org}/environments/{env}/sharedflows/{sf}/revisions/{rev}/depl oyments`, two permissions are required: * `apigee.deployments.create` on the resource `organizations/{org}/environments/{env}` * `apigee.sharedflowrevisions.deploy` on the resource `organizations/{org}/sharedflows/{sf}/revisions/{rev}` (revisions.deploy)
getDeployments()  : Google_Service_Apigee_GoogleCloudApigeeV1Deployment
Gets the deployment of a shared flow revision and actual state reported by runtime pods. (revisions.getDeployments)
undeploy()  : Google_Service_Apigee_GoogleProtobufEmpty
Undeploys a shared flow revision from an environment. For a request path `org anizations/{org}/environments/{env}/sharedflows/{sf}/revisions/{rev}/deployme nts`, two permissions are required: * `apigee.deployments.delete` on the resource `organizations/{org}/environments/{env}` * `apigee.sharedflowrevisions.undeploy` on the resource `organizations/{org}/sharedflows/{sf}/revisions/{rev}` (revisions.undeploy)
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

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

deploy()

Deploys a revision of a shared flow. If another revision of the same shared flow is currently deployed, set the `override` parameter to `true` to have this revision replace the currently deployed revision. You cannot use a shared flow until it has been deployed to an environment. For a request path `organizations/{org}/environments/{env}/sharedflows/{sf}/revisions/{rev}/depl oyments`, two permissions are required: * `apigee.deployments.create` on the resource `organizations/{org}/environments/{env}` * `apigee.sharedflowrevisions.deploy` on the resource `organizations/{org}/sharedflows/{sf}/revisions/{rev}` (revisions.deploy)

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

Required. Name of the shared flow revision to deploy in the following format: organizations/{org}/environments/{env}/sharedflows/{sh aredflow}/revisions/{rev}

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

Optional parameters.

Tags
opt_param

bool override Flag that specifies whether to force the deployment of the new revision over the currently deployed revision by overriding conflict checks. If an existing shared flow revision is deployed, to ensure seamless deployment with no downtime, set this parameter to true. In this case, hybrid deploys the new revision fully before undeploying the existing revision. If set to false, you must undeploy the existing revision before deploying the new revision.

Return values
Google_Service_Apigee_GoogleCloudApigeeV1Deployment

getDeployments()

Gets the deployment of a shared flow revision and actual state reported by runtime pods. (revisions.getDeployments)

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

Required. Name representing a shared flow in an environment in the following format: organizations/{org}/environments/{env}/ sharedflows/{sharedflow}/revisions/{rev}

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

Optional parameters.

Return values
Google_Service_Apigee_GoogleCloudApigeeV1Deployment

undeploy()

Undeploys a shared flow revision from an environment. For a request path `org anizations/{org}/environments/{env}/sharedflows/{sf}/revisions/{rev}/deployme nts`, two permissions are required: * `apigee.deployments.delete` on the resource `organizations/{org}/environments/{env}` * `apigee.sharedflowrevisions.undeploy` on the resource `organizations/{org}/sharedflows/{sf}/revisions/{rev}` (revisions.undeploy)

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

Required. Name of the shared flow revision to undeploy in the following format: organizations/{org}/environments/{env}/sharedflows/{sh aredflow}/revisions/{rev}

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

Optional parameters.

Return values
Google_Service_Apigee_GoogleProtobufEmpty

convertToArrayAndStripNulls()

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

Search results