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

ProjectsLocationsConnections

class ProjectsLocationsConnections extends Resource (View source)

The "connections" collection of methods.

Typical usage is:

 $bigqueryconnectionService = new Google\Service\BigQueryConnectionService(...);
 $connections = $bigqueryconnectionService->projects_locations_connections;

Methods

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

Creates a new connection. (connections.create)

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

Deletes connection and associated credential. (connections.delete)

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

Returns specified connection. (connections.get)

Policy
getIamPolicy(string $resource, GetIamPolicyRequest $postBody, 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. (connections.getIamPolicy)

ListConnectionsResponse
listProjectsLocationsConnections(string $parent, array $optParams = [])

Returns a list of connections in the given project.

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

Updates the specified connection. For security reasons, also resets credential if connection properties are in the update field mask.

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. (connections.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 52
Connection create(string $parent, Connection $postBody, array $optParams = [])

Creates a new connection. (connections.create)

Parameters

string $parent

Required. Parent resource name. Must be in the format projects/{project_id}/locations/{location_id}
Connection $postBody
array $optParams

Optional parameters.

Return Value

Connection

Exceptions

Exception

at line 67
BigqueryconnectionEmpty delete(string $name, array $optParams = [])

Deletes connection and associated credential. (connections.delete)

Parameters

string $name

Required. Name of the deleted connection, for example: projects/{project_id}/locations/{location_id}/connections/{connection_id}
array $optParams

Optional parameters.

Return Value

BigqueryconnectionEmpty

Exceptions

Exception

at line 82
Connection get(string $name, array $optParams = [])

Returns specified connection. (connections.get)

Parameters

string $name

Required. Name of the requested connection, for example: projects/{project_id}/locations/{location_id}/connections/{connection_id}
array $optParams

Optional parameters.

Return Value

Connection

Exceptions

Exception

at line 101
Policy getIamPolicy(string $resource, GetIamPolicyRequest $postBody, 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. (connections.getIamPolicy)

Parameters

string $resource

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

Optional parameters.

Return Value

Policy

Exceptions

Exception

at line 120
ListConnectionsResponse listProjectsLocationsConnections(string $parent, array $optParams = [])

Returns a list of connections in the given project.

(connections.listProjectsLocationsConnections)

Parameters

string $parent

Required. Parent resource name. Must be in the form: projects/{project_id}/locations/{location_id}
array $optParams

Optional parameters.

Return Value

ListConnectionsResponse

Exceptions

Exception

at line 141
Connection patch(string $name, Connection $postBody, array $optParams = [])

Updates the specified connection. For security reasons, also resets credential if connection properties are in the update field mask.

(connections.patch)

Parameters

string $name

Required. Name of the connection to update, for example: projects/{project_id}/locations/{location_id}/connections/{connection_id}
Connection $postBody
array $optParams

Optional parameters.

Return Value

Connection

Exceptions

Exception

at line 161
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. (connections.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 184
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. (connections.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