Google Cloud Migration Center V1 Client - Class AddAssetsToGroupRequest (0.4.5)

Reference documentation and code samples for the Google Cloud Migration Center V1 Client class AddAssetsToGroupRequest.

A request to add assets to a group.

Generated from protobuf message google.cloud.migrationcenter.v1.AddAssetsToGroupRequest

Namespace

Google \ Cloud \ MigrationCenter \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ group`	`string` Required. Group reference.
`↳ request_id`	`string` Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
`↳ assets`	`Google\Cloud\MigrationCenter\V1\AssetList` Required. List of assets to be added. The maximum number of assets that can be added in a single request is 1000.
`↳ allow_existing`	`bool` Optional. When this value is set to `false` and one of the given assets is already an existing member of the group, the operation fails with an `Already Exists` error. When set to `true` this situation is silently ignored by the server. Default value is `false`.

getGroup

Required. Group reference.

Returns
Type	Description
`string`

setGroup

Required. Group reference.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getRequestId

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Returns
Type	Description
`string`

setRequestId

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getAssets

Required. List of assets to be added.

The maximum number of assets that can be added in a single request is 1000.

Returns
Type	Description
`Google\Cloud\MigrationCenter\V1\AssetList\|null`

hasAssets

clearAssets

setAssets

Required. List of assets to be added.

The maximum number of assets that can be added in a single request is 1000.

Parameter
Name	Description
`var`	`Google\Cloud\MigrationCenter\V1\AssetList`

Returns
Type	Description
`$this`

getAllowExisting

Optional. When this value is set to false and one of the given assets is already an existing member of the group, the operation fails with an Already Exists error. When set to true this situation is silently ignored by the server.

Default value is false.

Returns
Type	Description
`bool`

setAllowExisting

Default value is false.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

static::build

Parameter
Name	Description
`group`	`string` Required. Group reference. Please see Google\Cloud\MigrationCenter\V1\MigrationCenterClient::groupName() for help formatting this field.

Returns
Type	Description
`Google\Cloud\MigrationCenter\V1\AddAssetsToGroupRequest`