Google Cloud Channel V1 Client - Class TransferEntitlementsRequest (1.1.1)

Reference documentation and code samples for the Google Cloud Channel V1 Client class TransferEntitlementsRequest.

Request message for CloudChannelService.TransferEntitlements.

Generated from protobuf message google.cloud.channel.v1.TransferEntitlementsRequest

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The resource name of the reseller's customer account that will receive transferred entitlements. Parent uses the format: accounts/{account_id}/customers/{customer_id}

↳ entitlements array<Google\Cloud\Channel\V1\Entitlement>

Required. The new entitlements to create or transfer.

↳ auth_token string

The super admin of the resold customer generates this token to authorize a reseller to access their Cloud Identity and purchase entitlements on their behalf. You can omit this token after authorization. See https://support.google.com/a/answer/7643790 for more details.

↳ request_id string

Optional. You can specify an optional unique request ID, and if you need to retry your request, the server will know to ignore the request if it's complete. For example, 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 it received the original operation with the same request ID. If it did, it will ignore the second request. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

getParent

Required. The resource name of the reseller's customer account that will receive transferred entitlements. Parent uses the format: accounts/{account_id}/customers/{customer_id}

Returns
TypeDescription
string

setParent

Required. The resource name of the reseller's customer account that will receive transferred entitlements. Parent uses the format: accounts/{account_id}/customers/{customer_id}

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getEntitlements

Required. The new entitlements to create or transfer.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setEntitlements

Required. The new entitlements to create or transfer.

Parameter
NameDescription
var array<Google\Cloud\Channel\V1\Entitlement>
Returns
TypeDescription
$this

getAuthToken

The super admin of the resold customer generates this token to authorize a reseller to access their Cloud Identity and purchase entitlements on their behalf. You can omit this token after authorization.

See https://support.google.com/a/answer/7643790 for more details.

Returns
TypeDescription
string

setAuthToken

The super admin of the resold customer generates this token to authorize a reseller to access their Cloud Identity and purchase entitlements on their behalf. You can omit this token after authorization.

See https://support.google.com/a/answer/7643790 for more details.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getRequestId

Optional. You can specify an optional unique request ID, and if you need to retry your request, the server will know to ignore the request if it's complete.

For example, 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 it received the original operation with the same request ID. If it did, it will ignore the second request. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Returns
TypeDescription
string

setRequestId

Optional. You can specify an optional unique request ID, and if you need to retry your request, the server will know to ignore the request if it's complete.

For example, 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 it received the original operation with the same request ID. If it did, it will ignore the second request. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Parameter
NameDescription
var string
Returns
TypeDescription
$this