class ProjectsLocationsConnectionProfiles extends Resource (View source)

The "connectionProfiles" collection of methods.

Typical usage is:

 $datamigrationService = new Google\Service\DatabaseMigrationService(...);
 $connectionProfiles = $datamigrationService->projects_locations_connectionProfiles;

Methods

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

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

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

Deletes a single Database Migration Service connection profile. A connection profile can only be deleted if it is not in use by any active migration jobs.

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

Gets details of a single connection profile. (connectionProfiles.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.

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

Retrieves a list of all connection profiles in a given project and location.

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

Update the configuration of a single connection profile.

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. (connectionProfiles.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, ConnectionProfile $postBody, array $optParams = [])

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

(connectionProfiles.create)

Parameters

string $parent

Required. The parent which owns this collection of connection profiles.

ConnectionProfile $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

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

Deletes a single Database Migration Service connection profile. A connection profile can only be deleted if it is not in use by any active migration jobs.

(connectionProfiles.delete)

Parameters

string $name

Required. Name of the connection profile resource to delete.

array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

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

Gets details of a single connection profile. (connectionProfiles.get)

Parameters

string $name

Required. Name of the connection profile resource to get.

array $optParams

Optional parameters.

Return Value

ConnectionProfile

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.

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

ListConnectionProfilesResponse listProjectsLocationsConnectionProfiles(string $parent, array $optParams = [])

Retrieves a list of all connection profiles in a given project and location.

(connectionProfiles.listProjectsLocationsConnectionProfiles)

Parameters

string $parent

Required. The parent which owns this collection of connection profiles.

array $optParams

Optional parameters.

Return Value

ListConnectionProfilesResponse

Exceptions

Exception

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

Update the configuration of a single connection profile.

(connectionProfiles.patch)

Parameters

string $name

The name of this connection profile resource in the form of projects/{project}/locations/{location}/connectionProfiles/{connectionProf ile}.

ConnectionProfile $postBody
array $optParams

Optional parameters.

Return Value

Operation

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