class ProjectsLocationsCollectors extends Resource (View source)

The "collectors" collection of methods.

Typical usage is:

 $rapidmigrationassessmentService = new Google\Service\RapidMigrationAssessment(...);
 $collectors = $rapidmigrationassessmentService->projects_locations_collectors;

Methods

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

Create a Collector to manage the on-prem appliance which collects information about Customer assets. (collectors.create)

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

Deletes a single Collector - changes state of collector to "Deleting".

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

Gets details of a single Collector. (collectors.get)

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

Lists Collectors in a given project and location.

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

Updates the parameters of a single Collector. (collectors.patch)

pause(string $name, PauseCollectorRequest $postBody, array $optParams = [])

Pauses the given collector. (collectors.pause)

register(string $name, RegisterCollectorRequest $postBody, array $optParams = [])

Registers the given collector. (collectors.register)

resume(string $name, ResumeCollectorRequest $postBody, array $optParams = [])

Resumes the given collector. (collectors.resume)

Details

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

Create a Collector to manage the on-prem appliance which collects information about Customer assets. (collectors.create)

Parameters

string $parent

Required. Name of the parent (project+location).

Collector $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

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

Deletes a single Collector - changes state of collector to "Deleting".

Background jobs does final deletion thorugh producer api. (collectors.delete)

Parameters

string $name

Required. Name of the resource.

array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

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

Gets details of a single Collector. (collectors.get)

Parameters

string $name

Required. Name of the resource.

array $optParams

Optional parameters.

Return Value

Collector

Exceptions

Exception

ListCollectorsResponse listProjectsLocationsCollectors(string $parent, array $optParams = [])

Lists Collectors in a given project and location.

(collectors.listProjectsLocationsCollectors)

Parameters

string $parent

Required. Parent value for ListCollectorsRequest.

array $optParams

Optional parameters.

Return Value

ListCollectorsResponse

Exceptions

Exception

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

Updates the parameters of a single Collector. (collectors.patch)

Parameters

string $name

name of resource.

Collector $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation pause(string $name, PauseCollectorRequest $postBody, array $optParams = [])

Pauses the given collector. (collectors.pause)

Parameters

string $name

Required. Name of the resource.

PauseCollectorRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation register(string $name, RegisterCollectorRequest $postBody, array $optParams = [])

Registers the given collector. (collectors.register)

Parameters

string $name

Required. Name of the resource.

RegisterCollectorRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation resume(string $name, ResumeCollectorRequest $postBody, array $optParams = [])

Resumes the given collector. (collectors.resume)

Parameters

string $name

Required. Name of the resource.

ResumeCollectorRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception