Documentation

Google_Service_DataFusion_Resource_ProjectsLocationsInstances extends Google_Service_Resource
in package

The "instances" collection of methods.

Typical usage is: $datafusionService = new Google_Service_DataFusion(...); $instances = $datafusionService->instances;

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_DataFusion_Operation
Creates a new Data Fusion instance in the specified project and location.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_DataFusion_Operation
Deletes a single Date Fusion instance. (instances.delete)
get()  : Google_Service_DataFusion_Instance
Gets details of a single Data Fusion instance. (instances.get)
getIamPolicy()  : Google_Service_DataFusion_Policy
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (instances.getIamPolicy)
listProjectsLocationsInstances()  : Google_Service_DataFusion_ListInstancesResponse
Lists Data Fusion instances in the specified project and location.
patch()  : Google_Service_DataFusion_Operation
Updates a single Data Fusion instance. (instances.patch)
restart()  : Google_Service_DataFusion_Operation
Restart a single Data Fusion instance. At the end of an operation instance is fully restarted. (instances.restart)
setIamPolicy()  : Google_Service_DataFusion_Policy
Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. (instances.setIamPolicy)
testIamPermissions()  : Google_Service_DataFusion_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.
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 Data Fusion instance in the specified project and location.

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

(instances.create)

Parameters
$parent : string

The instance's project and location in the format projects/{project}/locations/{location}.

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

Optional parameters.

Tags
opt_param

string instanceId The name of the instance to create.

Return values
Google_Service_DataFusion_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

getIamPolicy()

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

public getIamPolicy(string $resource[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DataFusion_Policy
Parameters
$resource : string

REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

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

Optional parameters.

Tags
opt_param

int options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource- policies).

Return values
Google_Service_DataFusion_Policy

listProjectsLocationsInstances()

Lists Data Fusion instances in the specified project and location.

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

(instances.listProjectsLocationsInstances)

Parameters
$parent : string

The project and location for which to retrieve instance information in the format projects/{project}/locations/{location}. If the location is specified as '-' (wildcard), then all regions available to the project are queried, and the results are aggregated.

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

Optional parameters.

Tags
opt_param

string filter List filter.

opt_param

int pageSize The maximum number of items to return.

opt_param

string pageToken The next_page_token value to use if there are additional results to retrieve for this list request.

opt_param

string orderBy Sort results. Supported values are "name", "name desc", or "" (unsorted).

Return values
Google_Service_DataFusion_ListInstancesResponse

patch()

Updates a single Data Fusion instance. (instances.patch)

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

Output only. The name of this instance is in the form of projects/{project}/locations/{location}/instances/{instance}.

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

Optional parameters.

Tags
opt_param

string updateMask Field mask is used to specify the fields that the update will overwrite in an instance resource. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask, all the supported fields (labels, options, and version currently) will be overwritten.

Return values
Google_Service_DataFusion_Operation

restart()

Restart a single Data Fusion instance. At the end of an operation instance is fully restarted. (instances.restart)

public restart(string $name, Google_Service_DataFusion_RestartInstanceRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DataFusion_Operation
Parameters
$name : string

Name of the Data Fusion instance which need to be restarted in the form of projects/{project}/locations/{location}/instances/{instance}

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

Optional parameters.

Return values
Google_Service_DataFusion_Operation

setIamPolicy()

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

public setIamPolicy(string $resource, Google_Service_DataFusion_SetIamPolicyRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DataFusion_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_DataFusion_SetIamPolicyRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_DataFusion_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_DataFusion_TestIamPermissionsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DataFusion_TestIamPermissionsResponse

This operation may "fail open" without warning. (instances.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_DataFusion_TestIamPermissionsRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_DataFusion_TestIamPermissionsResponse

convertToArrayAndStripNulls()

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

Search results