Updates a channel partner link. Distributors call this method to change a link's status. For example, to suspend a partner link. You must be a distributor to call this method. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: * Required request parameters are missing or invalid. * Link state cannot change from invited to active or suspended. * Cannot send reseller_cloud_identity_id, invite_url, or name in update mask. * NOT_FOUND: ChannelPartnerLink resource not found. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The updated ChannelPartnerLink resource.

Scopes

You will need authorization for the https://www.googleapis.com/auth/apps.order scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/apps.order. You can set the scope for this method like this: cloudchannel1 --scope <scope> accounts channel-partner-links-patch ...

Required Scalar Argument

  • <name> (string)
    • Required. The resource name of the channel partner link to cancel. Name uses the format: accounts/{account_id}/channelPartnerLinks/{id} where {id} is the Cloud Identity ID of the partner.

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

GoogleCloudChannelV1UpdateChannelPartnerLinkRequest:
  channel-partner-link:
    channel-partner-cloud-identity-info:
      admin-console-uri: string
      alternate-email: string
      customer-type: string
      edu-data:
        institute-size: string
        institute-type: string
        website: string
      is-domain-verified: boolean
      language-code: string
      phone-number: string
      primary-domain: string
    create-time: string
    invite-link-uri: string
    link-state: string
    name: string
    public-id: string
    reseller-cloud-identity-id: string
    update-time: string
  update-mask: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

  • -r .channel-partner-link.channel-partner-cloud-identity-info admin-console-uri=sed
    • Output only. URI of Customer's Admin console dashboard.
  • alternate-email=no
    • The alternate email.
  • customer-type=et
    • CustomerType indicates verification type needed for using services.
  • edu-data institute-size=elitr
    • Size of the institute.
  • institute-type=sed
    • Designated institute type of customer.

  • website=no

    • Web address for the edu customer's institution.

  • .. is-domain-verified=false

    • Output only. Whether the domain is verified. This field is not returned for a Customer's cloud_identity_info resource. Partners can use the domains.get() method of the Workspace SDK's Directory API, or listen to the PRIMARY_DOMAIN_VERIFIED Pub/Sub event in to track domain verification of their resolve Workspace customers.
  • language-code=at
    • Language code.
  • phone-number=sadipscing
    • Phone number associated with the Cloud Identity.

  • primary-domain=aliquyam

    • Output only. The primary domain name.

  • .. create-time=dolores

    • Output only. Timestamp of when the channel partner link is created.
  • invite-link-uri=sadipscing
    • Output only. URI of the web page where partner accepts the link invitation.
  • link-state=erat
    • Required. State of the channel partner link.
  • name=aliquyam
    • Output only. Resource name for the channel partner link, in the format accounts/{account_id}/channelPartnerLinks/{id}.
  • public-id=amet
    • Output only. Public identifier that a customer must use to generate a transfer token to move to this distributor-reseller combination.
  • reseller-cloud-identity-id=est
    • Required. Cloud Identity ID of the linked reseller.

  • update-time=et

    • Output only. Timestamp of when the channel partner link is updated.

  • .. update-mask=sea

    • Required. The update mask that applies to the resource. The only allowable value for an update mask is channel_partner_link.link_state.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

  • The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
  • The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
  • You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
  • You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p $-xgafv=string

    • V1 error format.

  • -p access-token=string

    • OAuth access token.

  • -p alt=string

    • Data format for response.

  • -p callback=string

    • JSONP

  • -p fields=string

    • Selector specifying which fields to include in a partial response.

  • -p key=string

    • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

  • -p oauth-token=string

    • OAuth 2.0 token for the current user.

  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.

  • -p quota-user=string

    • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • -p upload-type=string

    • Legacy upload protocol for media (e.g. "media", "multipart").

  • -p upload-protocol=string

    • Upload protocol for media (e.g. "raw", "multipart").