Documentation

Google_Service_ServiceManagement_Resource_ServicesRollouts extends Google_Service_Resource
in package

The "rollouts" collection of methods.

Typical usage is: $servicemanagementService = new Google_Service_ServiceManagement(...); $rollouts = $servicemanagementService->rollouts;

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_ServiceManagement_Operation
Creates a new service configuration rollout. Based on rollout, the Google Service Management will roll out the service configurations to different backend services. For example, the logging configuration will be pushed to Google Cloud Logging. Please note that any previous pending and running Rollouts and associated Operations will be automatically cancelled so that the latest Rollout will not be blocked by previous Rollouts. Only the 100 most recent (in any state) and the last 10 successful (if not already part of the set of 100 most recent) rollouts are kept for each service. The rest will be deleted eventually. Operation (rollouts.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
get()  : Google_Service_ServiceManagement_Rollout
Gets a service configuration rollout. (rollouts.get)
listServicesRollouts()  : Google_Service_ServiceManagement_ListServiceRolloutsResponse
Lists the history of the service configuration rollouts for a managed service, from the newest to the oldest. (rollouts.listServicesRollouts)
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 new service configuration rollout. Based on rollout, the Google Service Management will roll out the service configurations to different backend services. For example, the logging configuration will be pushed to Google Cloud Logging. Please note that any previous pending and running Rollouts and associated Operations will be automatically cancelled so that the latest Rollout will not be blocked by previous Rollouts. Only the 100 most recent (in any state) and the last 10 successful (if not already part of the set of 100 most recent) rollouts are kept for each service. The rest will be deleted eventually. Operation (rollouts.create)

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

Required. The name of the service. See the overview for naming requirements. For example: example.googleapis.com.

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

Optional parameters.

Return values
Google_Service_ServiceManagement_Operation

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

get()

Gets a service configuration rollout. (rollouts.get)

public get(string $serviceName, string $rolloutId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ServiceManagement_Rollout
Parameters
$serviceName : string

Required. The name of the service. See the overview for naming requirements. For example: example.googleapis.com.

$rolloutId : string

Required. The id of the rollout resource.

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

Optional parameters.

Return values
Google_Service_ServiceManagement_Rollout

listServicesRollouts()

Lists the history of the service configuration rollouts for a managed service, from the newest to the oldest. (rollouts.listServicesRollouts)

public listServicesRollouts(string $serviceName[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ServiceManagement_ListServiceRolloutsResponse
Parameters
$serviceName : string

Required. The name of the service. See the overview for naming requirements. For example: example.googleapis.com.

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

Optional parameters.

Tags
opt_param

string filter Required. Use filter to return subset of rollouts. The following filters are supported: -- To limit the results to only those in status 'SUCCESS', use filter='status=SUCCESS' -- To limit the results to those in status 'CANCELLED' or 'FAILED', use filter='status=CANCELLED OR status=FAILED'

opt_param

int pageSize The max number of items to include in the response list. Page size is 50 if not specified. Maximum value is 100.

opt_param

string pageToken The token of the page to retrieve.

Return values
Google_Service_ServiceManagement_ListServiceRolloutsResponse

convertToArrayAndStripNulls()

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

Search results