Documentation

Google_Service_Dataproc_Resource_ProjectsRegionsAutoscalingPolicies extends Google_Service_Resource
in package

Application

The "autoscalingPolicies" collection of methods.

Typical usage is: $dataprocService = new Google_Service_Dataproc(...); $autoscalingPolicies = $dataprocService->autoscalingPolicies;

$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_Dataproc_AutoscalingPolicy: Creates new autoscaling policy. (autoscalingPolicies.create)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_Dataproc_DataprocEmpty: Deletes an autoscaling policy. It is an error to delete an autoscaling policy that is in use by one or more clusters. (autoscalingPolicies.delete)
get() : Google_Service_Dataproc_AutoscalingPolicy: Retrieves autoscaling policy. (autoscalingPolicies.get)
getIamPolicy() : Google_Service_Dataproc_Policy: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
listProjectsRegionsAutoscalingPolicies() : Google_Service_Dataproc_ListAutoscalingPoliciesResponse: Lists autoscaling policies in the project.
setIamPolicy() : Google_Service_Dataproc_Policy: Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. (autoscalingPolicies.setIamPolicy)
testIamPermissions() : Google_Service_Dataproc_TestIamPermissionsResponse: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking.
update() : Google_Service_Dataproc_AutoscalingPolicy: Updates (replaces) autoscaling policy.Disabled check for update_mask, because all updates will be full replacements. (autoscalingPolicies.update)
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 new autoscaling policy. (autoscalingPolicies.create)


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

Parameters

$parent : string: Required. The "resource name" of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies.create, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.autoscalingPolicies.create, the resource name of the location has the following format: projects/{project_id}/locations/{location}
$postBody : Google_Service_Dataproc_AutoscalingPolicy
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dataproc_AutoscalingPolicy —

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 an autoscaling policy. It is an error to delete an autoscaling policy that is in use by one or more clusters. (autoscalingPolicies.delete)


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

Parameters

$name : string: Required. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies.delete, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} For projects.locations.autoscalingPolicies.delete, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dataproc_DataprocEmpty —

get()

Retrieves autoscaling policy. (autoscalingPolicies.get)


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

Parameters

$name : string: Required. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies.get, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} For projects.locations.autoscalingPolicies.get, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dataproc_AutoscalingPolicy —

getIamPolicy()

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.


    public
                getIamPolicy(string $resource, Google_Service_Dataproc_GetIamPolicyRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dataproc_Policy

(autoscalingPolicies.getIamPolicy)

Parameters

$resource : string: REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
$postBody : Google_Service_Dataproc_GetIamPolicyRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dataproc_Policy —

listProjectsRegionsAutoscalingPolicies()

Lists autoscaling policies in the project.


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

(autoscalingPolicies.listProjectsRegionsAutoscalingPolicies)

Parameters

$parent : string: Required. The "resource name" of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies.list, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.autoscalingPolicies.list, the resource name of the location has the following format: projects/{project_id}/locations/{location}
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dataproc_ListAutoscalingPoliciesResponse —

setIamPolicy()

Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. (autoscalingPolicies.setIamPolicy)


    public
                setIamPolicy(string $resource, Google_Service_Dataproc_SetIamPolicyRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dataproc_Policy

Parameters

$resource : string: REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
$postBody : Google_Service_Dataproc_SetIamPolicyRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dataproc_Policy —

testIamPermissions()

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking.


    public
                testIamPermissions(string $resource, Google_Service_Dataproc_TestIamPermissionsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dataproc_TestIamPermissionsResponse

This operation may "fail open" without warning. (autoscalingPolicies.testIamPermissions)

Parameters

$resource : string: REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
$postBody : Google_Service_Dataproc_TestIamPermissionsRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dataproc_TestIamPermissionsResponse —

update()

Updates (replaces) autoscaling policy.Disabled check for update_mask, because all updates will be full replacements. (autoscalingPolicies.update)


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

Parameters

$name : string: Output only. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} For projects.locations.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}
$postBody : Google_Service_Dataproc_AutoscalingPolicy
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dataproc_AutoscalingPolicy —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —