Documentation

Google_Service_Assuredworkloads_Resource_OrganizationsLocationsWorkloads extends Google_Service_Resource
in package

Application

The "workloads" collection of methods.

Typical usage is: $assuredworkloadsService = new Google_Service_Assuredworkloads(...); $workloads = $assuredworkloadsService->workloads;

$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_Assuredworkloads_GoogleLongrunningOperation: Creates Assured Workload. (workloads.create)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_Assuredworkloads_GoogleProtobufEmpty: Deletes the workload. Make sure that workload's direct children are already in a deleted state, otherwise the request will fail with a FAILED_PRECONDITION error. (workloads.delete)
get() : Google_Service_Assuredworkloads_GoogleCloudAssuredworkloadsV1beta1Workload: Gets Assured Workload associated with a CRM Node (workloads.get)
listOrganizationsLocationsWorkloads() : Google_Service_Assuredworkloads_GoogleCloudAssuredworkloadsV1beta1ListWorkloadsResponse: Lists Assured Workloads under a CRM Node.
patch() : Google_Service_Assuredworkloads_GoogleCloudAssuredworkloadsV1beta1Workload: Updates an existing workload. Currently allows updating of workload display_name and labels. For force updates don't set etag field in the Workload. Only one update operation per workload can be in progress.
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

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

__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

Return values

Google_Http_Request|expectedClass —

create()

Creates Assured Workload. (workloads.create)


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

Parameters

$parent : string: Required. The resource name of the new Workload's parent. Must be of the form organizations/{org_id}/locations/{location_id}.
$postBody : Google_Service_Assuredworkloads_GoogleCloudAssuredworkloadsV1beta1Workload
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Assuredworkloads_GoogleLongrunningOperation —

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>

Return values

string —

$requestUrl

delete()

Deletes the workload. Make sure that workload's direct children are already in a deleted state, otherwise the request will fail with a FAILED_PRECONDITION error. (workloads.delete)


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

Parameters

$name : string: Required. The name field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id}
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Assuredworkloads_GoogleProtobufEmpty —

get()

Gets Assured Workload associated with a CRM Node (workloads.get)


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

Parameters

$name : string: Required. The resource name of the Workload to fetch. This is the workloads's relative path in the API, formatted as "organizations /{organization_id}/locations/{location_id}/workloads/{workload_id}". For example, "organizations/123/locations/us-east1/workloads/assured-workload-1".
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Assuredworkloads_GoogleCloudAssuredworkloadsV1beta1Workload —

listOrganizationsLocationsWorkloads()

Lists Assured Workloads under a CRM Node.


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

(workloads.listOrganizationsLocationsWorkloads)

Parameters

$parent : string: Required. Parent Resource to list workloads from. Must be of the form organizations/{org_id}/locations/{location}.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Assuredworkloads_GoogleCloudAssuredworkloadsV1beta1ListWorkloadsResponse —

patch()

Updates an existing workload. Currently allows updating of workload display_name and labels. For force updates don't set etag field in the Workload. Only one update operation per workload can be in progress.


    public
                patch(string $name, Google_Service_Assuredworkloads_GoogleCloudAssuredworkloadsV1beta1Workload $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Assuredworkloads_GoogleCloudAssuredworkloadsV1beta1Workload

(workloads.patch)

Parameters

$name : string: Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read- only.
$postBody : Google_Service_Assuredworkloads_GoogleCloudAssuredworkloadsV1beta1Workload
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Assuredworkloads_GoogleCloudAssuredworkloadsV1beta1Workload —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —