1. class
  2. Google
  3. \
  4. Service
  5. \
  6. DataFusion
  7. \
  8. Resource
  9. \
  10. ProjectsLocationsInstances

ProjectsLocationsInstances

class ProjectsLocationsInstances extends Resource (View source)

The "instances" collection of methods.

Typical usage is:

 $datafusionService = new Google\Service\DataFusion(...);
 $instances = $datafusionService->projects_locations_instances;

Methods

Operation
create(string $parent, Instance $postBody, array $optParams = [])

Creates a new Data Fusion instance in the specified project and location.

Operation
delete(string $name, array $optParams = [])

Deletes a single Date Fusion instance. (instances.delete)

Instance
get(string $name, array $optParams = [])

Gets details of a single Data Fusion instance. (instances.get)

Policy
getIamPolicy(string $resource, array $optParams = [])

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)

ListInstancesResponse
listProjectsLocationsInstances(string $parent, array $optParams = [])

Lists Data Fusion instances in the specified project and location.

Operation
patch(string $name, Instance $postBody, array $optParams = [])

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

Operation
restart(string $name, RestartInstanceRequest $postBody, array $optParams = [])

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

Policy
setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

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)

TestIamPermissionsResponse
testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

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.

Details

at line 55
Operation create(string $parent, Instance $postBody, array $optParams = [])

Creates a new Data Fusion instance in the specified project and location.

(instances.create)

Parameters

string $parent

Required. The instance's project and location in the format projects/{project}/locations/{location}.
Instance $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 70
Operation delete(string $name, array $optParams = [])

Deletes a single Date Fusion instance. (instances.delete)

Parameters

string $name

Required. The instance resource name in the format projects/{project}/locations/{location}/instances/{instance}
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 85
Instance get(string $name, array $optParams = [])

Gets details of a single Data Fusion instance. (instances.get)

Parameters

string $name

Required. The instance resource name in the format projects/{project}/locations/{location}/instances/{instance}.
array $optParams

Optional parameters.

Return Value

Instance

Exceptions

Exception

at line 116
Policy getIamPolicy(string $resource, array $optParams = [])

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)

Parameters

string $resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.
array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

at line 142
ListInstancesResponse listProjectsLocationsInstances(string $parent, array $optParams = [])

Lists Data Fusion instances in the specified project and location.

(instances.listProjectsLocationsInstances)

Parameters

string $parent

Required. 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.
array $optParams

Optional parameters.

Return Value

ListInstancesResponse

Exceptions

Exception

at line 164
Operation patch(string $name, Instance $postBody, array $optParams = [])

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

Parameters

string $name

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

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 182
Operation restart(string $name, RestartInstanceRequest $postBody, array $optParams = [])

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

Parameters

string $name

Required. Name of the Data Fusion instance which need to be restarted in the form of projects/{project}/locations/{location}/instances/{instance}
RestartInstanceRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 202
Policy setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

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)

Parameters

string $resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.
SetIamPolicyRequest $postBody
array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

at line 225
TestIamPermissionsResponse testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

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.

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

Parameters

string $resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.
TestIamPermissionsRequest $postBody
array $optParams

Optional parameters.

Return Value

TestIamPermissionsResponse

Exceptions

Exception