class ProjectsLocationsManagementServers extends Resource (View source)

The "managementServers" collection of methods.

Typical usage is:

 $backupdrService = new Google\Service\Backupdr(...);
 $managementServers = $backupdrService->projects_locations_managementServers;

Methods

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

Creates a new ManagementServer in a given project and location.

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

Deletes a single ManagementServer. (managementServers.delete)

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

Gets details of a single ManagementServer. (managementServers.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.

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

Lists ManagementServers 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. (managementServers.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, ManagementServer $postBody, array $optParams = [])

Creates a new ManagementServer in a given project and location.

(managementServers.create)

Parameters

string $parent

Required. The management server project and location in the format 'projects/{project_id}/locations/{location}'. In Cloud Backup and DR locations map to Google Cloud regions, for example us-central1.

ManagementServer $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

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

Deletes a single ManagementServer. (managementServers.delete)

Parameters

string $name

Required. Name of the resource

array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

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

Gets details of a single ManagementServer. (managementServers.get)

Parameters

string $name

Required. Name of the management server resource name, in the format 'projects/{project_id}/locations/{location}/managementServers/{res ource_name}'

array $optParams

Optional parameters.

Return Value

ManagementServer

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.

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

ListManagementServersResponse listProjectsLocationsManagementServers(string $parent, array $optParams = [])

Lists ManagementServers in a given project and location.

(managementServers.listProjectsLocationsManagementServers)

Parameters

string $parent

Required. The project and location for which to retrieve management servers information, in the format 'projects/{project_id}/locations/{location}'. In Cloud BackupDR, locations map to Google Cloud regions, for example us-central1. To retrieve management servers for all locations, use "-" for the '{location}' value.

array $optParams

Optional parameters.

Return Value

ListManagementServersResponse

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