class ProjectsLocationsPrivateConnections extends Resource (View source)

The "privateConnections" collection of methods.

Typical usage is:

 $datamigrationService = new Google\Service\DatabaseMigrationService(...);
 $privateConnections = $datamigrationService->projects_locations_privateConnections;

Methods

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

Creates a new private connection in a given project and location.

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

Deletes a single Database Migration Service private connection.

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

Gets details of a single private connection. (privateConnections.get)

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.

listProjectsLocationsPrivateConnections(string $parent, array $optParams = [])

Retrieves a list of private connections in a given project and location.

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. (privateConnections.setIamPolicy)

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

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

Creates a new private connection in a given project and location.

(privateConnections.create)

Parameters

string $parent

Required. The parent that owns the collection of PrivateConnections.

PrivateConnection $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

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

Deletes a single Database Migration Service private connection.

(privateConnections.delete)

Parameters

string $name

Required. The name of the private connection to delete.

array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

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

Gets details of a single private connection. (privateConnections.get)

Parameters

string $name

Required. The name of the private connection to get.

array $optParams

Optional parameters.

Return Value

PrivateConnection

Exceptions

Exception

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.

(privateConnections.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

ListPrivateConnectionsResponse listProjectsLocationsPrivateConnections(string $parent, array $optParams = [])

Retrieves a list of private connections in a given project and location.

(privateConnections.listProjectsLocationsPrivateConnections)

Parameters

string $parent

Required. The parent that owns the collection of private connections.

array $optParams

Optional parameters.

Return Value

ListPrivateConnectionsResponse

Exceptions

Exception

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. (privateConnections.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

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. (privateConnections.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