Reference documentation and code samples for the Google Cloud Channel V1 Client class ChannelPartnerLink.
Entity representing a link between distributors and their indirect resellers in an n-tier resale channel.
Generated from protobuf message google.cloud.channel.v1.ChannelPartnerLink
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Output only. Resource name for the channel partner link, in the format accounts/{account_id}/channelPartnerLinks/{id}. |
↳ reseller_cloud_identity_id |
string
Required. Cloud Identity ID of the linked reseller. |
↳ link_state |
int
Required. State of the channel partner link. |
↳ invite_link_uri |
string
Output only. URI of the web page where partner accepts the link invitation. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Timestamp of when the channel partner link is created. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. Timestamp of when the channel partner link is updated. |
↳ public_id |
string
Output only. Public identifier that a customer must use to generate a transfer token to move to this distributor-reseller combination. |
↳ channel_partner_cloud_identity_info |
Google\Cloud\Channel\V1\CloudIdentityInfo
Output only. Cloud Identity info of the channel partner (IR). |
getName
Output only. Resource name for the channel partner link, in the format accounts/{account_id}/channelPartnerLinks/{id}.
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Output only. Resource name for the channel partner link, in the format accounts/{account_id}/channelPartnerLinks/{id}.
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getResellerCloudIdentityId
Required. Cloud Identity ID of the linked reseller.
Generated from protobuf field string reseller_cloud_identity_id = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
string | |
setResellerCloudIdentityId
Required. Cloud Identity ID of the linked reseller.
Generated from protobuf field string reseller_cloud_identity_id = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLinkState
Required. State of the channel partner link.
Generated from protobuf field .google.cloud.channel.v1.ChannelPartnerLinkState link_state = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
int | |
setLinkState
Required. State of the channel partner link.
Generated from protobuf field .google.cloud.channel.v1.ChannelPartnerLinkState link_state = 3 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getInviteLinkUri
Output only. URI of the web page where partner accepts the link invitation.
Generated from protobuf field string invite_link_uri = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
string | |
setInviteLinkUri
Output only. URI of the web page where partner accepts the link invitation.
Generated from protobuf field string invite_link_uri = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Output only. Timestamp of when the channel partner link is created.
Generated from protobuf field .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. Timestamp of when the channel partner link is created.
Generated from protobuf field .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdateTime
Output only. Timestamp of when the channel partner link is updated.
Generated from protobuf field .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Timestamp of when the channel partner link is updated.
Generated from protobuf field .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPublicId
Output only. Public identifier that a customer must use to generate a transfer token to move to this distributor-reseller combination.
Generated from protobuf field string public_id = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
string | |
setPublicId
Output only. Public identifier that a customer must use to generate a transfer token to move to this distributor-reseller combination.
Generated from protobuf field string public_id = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getChannelPartnerCloudIdentityInfo
Output only. Cloud Identity info of the channel partner (IR).
Generated from protobuf field .google.cloud.channel.v1.CloudIdentityInfo channel_partner_cloud_identity_info = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Channel\V1\CloudIdentityInfo|null | |
hasChannelPartnerCloudIdentityInfo
clearChannelPartnerCloudIdentityInfo
setChannelPartnerCloudIdentityInfo
Output only. Cloud Identity info of the channel partner (IR).
Generated from protobuf field .google.cloud.channel.v1.CloudIdentityInfo channel_partner_cloud_identity_info = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Channel\V1\CloudIdentityInfo
|
| Returns | |
|---|---|
| Type | Description |
$this | |