Class CloudChannelServiceClient (1.0.0)

public abstract class CloudChannelServiceClient

CloudChannelService client wrapper, for convenient use.

Inheritance

Object > CloudChannelServiceClient

Namespace

Google.Cloud.Channel.V1

Assembly

Google.Cloud.Channel.V1.dll

Remarks

CloudChannelService enables Google cloud resellers and distributors to manage their customers, channel partners, entitlements and reports.

Using this service:

  1. Resellers or distributors can manage a customer entity.
  2. Distributors can register an authorized reseller in their channel and then enable delegated admin access for the reseller.
  3. Resellers or distributors can manage entitlements for their customers.

The service primarily exposes the following resources:

  • [Customer][google.cloud.channel.v1.Customer]s: A Customer represents an entity managed by a reseller or distributor. A customer typically represents an enterprise. In an n-tier resale channel hierarchy, customers are generally represented as leaf nodes. Customers primarily have an Entitlement sub-resource discussed below.

  • [Entitlement][google.cloud.channel.v1.Entitlement]s: An Entitlement represents an entity which provides a customer means to start using a service. Entitlements are created or updated as a result of a successful fulfillment.

  • [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink]s: A ChannelPartnerLink is an entity that identifies links between distributors and their indirect resellers in a channel.

Properties

ActivateEntitlementOperationsClient

public virtual OperationsClient ActivateEntitlementOperationsClient { get; }

The long-running operations client for ActivateEntitlement.

Property Value
TypeDescription
Google.LongRunning.OperationsClient

CancelEntitlementOperationsClient

public virtual OperationsClient CancelEntitlementOperationsClient { get; }

The long-running operations client for CancelEntitlement.

Property Value
TypeDescription
Google.LongRunning.OperationsClient

ChangeOfferOperationsClient

public virtual OperationsClient ChangeOfferOperationsClient { get; }

The long-running operations client for ChangeOffer.

Property Value
TypeDescription
Google.LongRunning.OperationsClient

ChangeParametersOperationsClient

public virtual OperationsClient ChangeParametersOperationsClient { get; }

The long-running operations client for ChangeParameters.

Property Value
TypeDescription
Google.LongRunning.OperationsClient

ChangeRenewalSettingsOperationsClient

public virtual OperationsClient ChangeRenewalSettingsOperationsClient { get; }

The long-running operations client for ChangeRenewalSettings.

Property Value
TypeDescription
Google.LongRunning.OperationsClient

CreateEntitlementOperationsClient

public virtual OperationsClient CreateEntitlementOperationsClient { get; }

The long-running operations client for CreateEntitlement.

Property Value
TypeDescription
Google.LongRunning.OperationsClient

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the CloudChannelService service, which is a host of "cloudchannel.googleapis.com" and a port of 443.

Property Value
TypeDescription
String

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default CloudChannelService scopes.

Property Value
TypeDescription
IReadOnlyList<String>
Remarks

The default CloudChannelService scopes are:

GrpcClient

public virtual CloudChannelService.CloudChannelServiceClient GrpcClient { get; }

The underlying gRPC CloudChannelService client

Property Value
TypeDescription
CloudChannelService.CloudChannelServiceClient

ProvisionCloudIdentityOperationsClient

public virtual OperationsClient ProvisionCloudIdentityOperationsClient { get; }

The long-running operations client for ProvisionCloudIdentity.

Property Value
TypeDescription
Google.LongRunning.OperationsClient

StartPaidServiceOperationsClient

public virtual OperationsClient StartPaidServiceOperationsClient { get; }

The long-running operations client for StartPaidService.

Property Value
TypeDescription
Google.LongRunning.OperationsClient

SuspendEntitlementOperationsClient

public virtual OperationsClient SuspendEntitlementOperationsClient { get; }

The long-running operations client for SuspendEntitlement.

Property Value
TypeDescription
Google.LongRunning.OperationsClient

TransferEntitlementsOperationsClient

public virtual OperationsClient TransferEntitlementsOperationsClient { get; }

The long-running operations client for TransferEntitlements.

Property Value
TypeDescription
Google.LongRunning.OperationsClient

TransferEntitlementsToGoogleOperationsClient

public virtual OperationsClient TransferEntitlementsToGoogleOperationsClient { get; }

The long-running operations client for TransferEntitlementsToGoogle.

Property Value
TypeDescription
Google.LongRunning.OperationsClient

Methods

ActivateEntitlement(ActivateEntitlementRequest, CallSettings)

public virtual Operation<Entitlement, OperationMetadata> ActivateEntitlement(ActivateEntitlementRequest request, CallSettings callSettings = null)

Activates a previously suspended entitlement. The entitlement must be in a suspended state for it to be activated. Entitlements suspended for pending ToS acceptance can't be activated using this method. An entitlement activation is a long-running operation and can result in updates to the state of the customer entitlement.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller or if the reseller account making the request and reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: Entitlement resource not found.
  • SUSPENSION_NOT_RESELLER_INITIATED: Can't activate an entitlement that is pending TOS acceptance. Only reseller initiated suspensions can be activated.
  • NOT_SUSPENDED: Can't activate entitlements that are already in ACTIVE state. Can only activate suspended entitlements.
  • INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Long Running Operation ID.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].

Parameters
NameDescription
requestActivateEntitlementRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Google.LongRunning.Operation<Entitlement, OperationMetadata>

The RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.Create();
// Initialize request argument(s)
ActivateEntitlementRequest request = new ActivateEntitlementRequest
{
    Name = "",
    RequestId = "",
};
// Make the request
Operation<Entitlement, OperationMetadata> response = cloudChannelServiceClient.ActivateEntitlement(request);

// Poll until the returned long-running operation is complete
Operation<Entitlement, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Entitlement result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Entitlement, OperationMetadata> retrievedResponse = cloudChannelServiceClient.PollOnceActivateEntitlement(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Entitlement retrievedResult = retrievedResponse.Result;
}

ActivateEntitlementAsync(ActivateEntitlementRequest, CallSettings)

public virtual Task<Operation<Entitlement, OperationMetadata>> ActivateEntitlementAsync(ActivateEntitlementRequest request, CallSettings callSettings = null)

Activates a previously suspended entitlement. The entitlement must be in a suspended state for it to be activated. Entitlements suspended for pending ToS acceptance can't be activated using this method. An entitlement activation is a long-running operation and can result in updates to the state of the customer entitlement.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller or if the reseller account making the request and reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: Entitlement resource not found.
  • SUSPENSION_NOT_RESELLER_INITIATED: Can't activate an entitlement that is pending TOS acceptance. Only reseller initiated suspensions can be activated.
  • NOT_SUSPENDED: Can't activate entitlements that are already in ACTIVE state. Can only activate suspended entitlements.
  • INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Long Running Operation ID.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].

Parameters
NameDescription
requestActivateEntitlementRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Google.LongRunning.Operation<Entitlement, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
ActivateEntitlementRequest request = new ActivateEntitlementRequest
{
    Name = "",
    RequestId = "",
};
// Make the request
Operation<Entitlement, OperationMetadata> response = await cloudChannelServiceClient.ActivateEntitlementAsync(request);

// Poll until the returned long-running operation is complete
Operation<Entitlement, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Entitlement result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Entitlement, OperationMetadata> retrievedResponse = await cloudChannelServiceClient.PollOnceActivateEntitlementAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Entitlement retrievedResult = retrievedResponse.Result;
}

ActivateEntitlementAsync(ActivateEntitlementRequest, CancellationToken)

public virtual Task<Operation<Entitlement, OperationMetadata>> ActivateEntitlementAsync(ActivateEntitlementRequest request, CancellationToken cancellationToken)

Activates a previously suspended entitlement. The entitlement must be in a suspended state for it to be activated. Entitlements suspended for pending ToS acceptance can't be activated using this method. An entitlement activation is a long-running operation and can result in updates to the state of the customer entitlement.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller or if the reseller account making the request and reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: Entitlement resource not found.
  • SUSPENSION_NOT_RESELLER_INITIATED: Can't activate an entitlement that is pending TOS acceptance. Only reseller initiated suspensions can be activated.
  • NOT_SUSPENDED: Can't activate entitlements that are already in ACTIVE state. Can only activate suspended entitlements.
  • INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Long Running Operation ID.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].

Parameters
NameDescription
requestActivateEntitlementRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Google.LongRunning.Operation<Entitlement, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
ActivateEntitlementRequest request = new ActivateEntitlementRequest
{
    Name = "",
    RequestId = "",
};
// Make the request
Operation<Entitlement, OperationMetadata> response = await cloudChannelServiceClient.ActivateEntitlementAsync(request);

// Poll until the returned long-running operation is complete
Operation<Entitlement, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Entitlement result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Entitlement, OperationMetadata> retrievedResponse = await cloudChannelServiceClient.PollOnceActivateEntitlementAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Entitlement retrievedResult = retrievedResponse.Result;
}

CancelEntitlement(CancelEntitlementRequest, CallSettings)

public virtual Operation<Empty, OperationMetadata> CancelEntitlement(CancelEntitlementRequest request, CallSettings callSettings = null)

Cancels a previously fulfilled entitlement. An entitlement cancellation is a long-running operation.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller or if the reseller account making the request and reseller account being queried for are different.
  • FAILED_PRECONDITION: If there are any Google Cloud projects linked to the Google Cloud entitlement's Cloud Billing subaccount.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: Entitlement resource not found.
  • DELETION_TYPE_NOT_ALLOWED: Cancel is only allowed for Google Workspace add-ons or entitlements for Google Cloud's development platform.
  • INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Long Running Operation ID.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The response will contain google.protobuf.Empty on success. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].

Parameters
NameDescription
requestCancelEntitlementRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Google.LongRunning.Operation<Google.Protobuf.WellKnownTypes.Empty, OperationMetadata>

The RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.Create();
// Initialize request argument(s)
CancelEntitlementRequest request = new CancelEntitlementRequest
{
    Name = "",
    RequestId = "",
};
// Make the request
Operation<Empty, OperationMetadata> response = cloudChannelServiceClient.CancelEntitlement(request);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = cloudChannelServiceClient.PollOnceCancelEntitlement(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

CancelEntitlementAsync(CancelEntitlementRequest, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> CancelEntitlementAsync(CancelEntitlementRequest request, CallSettings callSettings = null)

Cancels a previously fulfilled entitlement. An entitlement cancellation is a long-running operation.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller or if the reseller account making the request and reseller account being queried for are different.
  • FAILED_PRECONDITION: If there are any Google Cloud projects linked to the Google Cloud entitlement's Cloud Billing subaccount.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: Entitlement resource not found.
  • DELETION_TYPE_NOT_ALLOWED: Cancel is only allowed for Google Workspace add-ons or entitlements for Google Cloud's development platform.
  • INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Long Running Operation ID.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The response will contain google.protobuf.Empty on success. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].

Parameters
NameDescription
requestCancelEntitlementRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Google.LongRunning.Operation<Google.Protobuf.WellKnownTypes.Empty, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
CancelEntitlementRequest request = new CancelEntitlementRequest
{
    Name = "",
    RequestId = "",
};
// Make the request
Operation<Empty, OperationMetadata> response = await cloudChannelServiceClient.CancelEntitlementAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await cloudChannelServiceClient.PollOnceCancelEntitlementAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

CancelEntitlementAsync(CancelEntitlementRequest, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> CancelEntitlementAsync(CancelEntitlementRequest request, CancellationToken cancellationToken)

Cancels a previously fulfilled entitlement. An entitlement cancellation is a long-running operation.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller or if the reseller account making the request and reseller account being queried for are different.
  • FAILED_PRECONDITION: If there are any Google Cloud projects linked to the Google Cloud entitlement's Cloud Billing subaccount.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: Entitlement resource not found.
  • DELETION_TYPE_NOT_ALLOWED: Cancel is only allowed for Google Workspace add-ons or entitlements for Google Cloud's development platform.
  • INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Long Running Operation ID.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The response will contain google.protobuf.Empty on success. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].

Parameters
NameDescription
requestCancelEntitlementRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Google.LongRunning.Operation<Google.Protobuf.WellKnownTypes.Empty, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
CancelEntitlementRequest request = new CancelEntitlementRequest
{
    Name = "",
    RequestId = "",
};
// Make the request
Operation<Empty, OperationMetadata> response = await cloudChannelServiceClient.CancelEntitlementAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await cloudChannelServiceClient.PollOnceCancelEntitlementAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

ChangeOffer(ChangeOfferRequest, CallSettings)

public virtual Operation<Entitlement, OperationMetadata> ChangeOffer(ChangeOfferRequest request, CallSettings callSettings = null)

Updates the Offer for an existing customer entitlement.

An entitlement update is a long-running operation and results in updates to the entitlement as a result of fulfillment.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: Offer or Entitlement resource not found.
  • INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Long Running Operation ID.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].

Parameters
NameDescription
requestChangeOfferRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Google.LongRunning.Operation<Entitlement, OperationMetadata>

The RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.Create();
// Initialize request argument(s)
ChangeOfferRequest request = new ChangeOfferRequest
{
    Name = "",
    OfferAsOfferName = OfferName.FromAccountOffer("[ACCOUNT]", "[OFFER]"),
    Parameters = { new Parameter(), },
    PurchaseOrderId = "",
    RequestId = "",
};
// Make the request
Operation<Entitlement, OperationMetadata> response = cloudChannelServiceClient.ChangeOffer(request);

// Poll until the returned long-running operation is complete
Operation<Entitlement, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Entitlement result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Entitlement, OperationMetadata> retrievedResponse = cloudChannelServiceClient.PollOnceChangeOffer(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Entitlement retrievedResult = retrievedResponse.Result;
}

ChangeOfferAsync(ChangeOfferRequest, CallSettings)

public virtual Task<Operation<Entitlement, OperationMetadata>> ChangeOfferAsync(ChangeOfferRequest request, CallSettings callSettings = null)

Updates the Offer for an existing customer entitlement.

An entitlement update is a long-running operation and results in updates to the entitlement as a result of fulfillment.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: Offer or Entitlement resource not found.
  • INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Long Running Operation ID.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].

Parameters
NameDescription
requestChangeOfferRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Google.LongRunning.Operation<Entitlement, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
ChangeOfferRequest request = new ChangeOfferRequest
{
    Name = "",
    OfferAsOfferName = OfferName.FromAccountOffer("[ACCOUNT]", "[OFFER]"),
    Parameters = { new Parameter(), },
    PurchaseOrderId = "",
    RequestId = "",
};
// Make the request
Operation<Entitlement, OperationMetadata> response = await cloudChannelServiceClient.ChangeOfferAsync(request);

// Poll until the returned long-running operation is complete
Operation<Entitlement, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Entitlement result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Entitlement, OperationMetadata> retrievedResponse = await cloudChannelServiceClient.PollOnceChangeOfferAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Entitlement retrievedResult = retrievedResponse.Result;
}

ChangeOfferAsync(ChangeOfferRequest, CancellationToken)

public virtual Task<Operation<Entitlement, OperationMetadata>> ChangeOfferAsync(ChangeOfferRequest request, CancellationToken cancellationToken)

Updates the Offer for an existing customer entitlement.

An entitlement update is a long-running operation and results in updates to the entitlement as a result of fulfillment.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: Offer or Entitlement resource not found.
  • INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Long Running Operation ID.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].

Parameters
NameDescription
requestChangeOfferRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Google.LongRunning.Operation<Entitlement, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
ChangeOfferRequest request = new ChangeOfferRequest
{
    Name = "",
    OfferAsOfferName = OfferName.FromAccountOffer("[ACCOUNT]", "[OFFER]"),
    Parameters = { new Parameter(), },
    PurchaseOrderId = "",
    RequestId = "",
};
// Make the request
Operation<Entitlement, OperationMetadata> response = await cloudChannelServiceClient.ChangeOfferAsync(request);

// Poll until the returned long-running operation is complete
Operation<Entitlement, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Entitlement result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Entitlement, OperationMetadata> retrievedResponse = await cloudChannelServiceClient.PollOnceChangeOfferAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Entitlement retrievedResult = retrievedResponse.Result;
}

ChangeParameters(ChangeParametersRequest, CallSettings)

public virtual Operation<Entitlement, OperationMetadata> ChangeParameters(ChangeParametersRequest request, CallSettings callSettings = null)

Change parameters of the entitlement

An entitlement parameters update is a long-running operation and results in updates to the entitlement as a result of fulfillment.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request. For example, if the number of seats being changed to is greater than the allowed number of max seats for the resource. Or decreasing seats for a commitment based plan.
  • NOT_FOUND: Entitlement resource not found.
  • INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Long Running Operation ID.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].

Parameters
NameDescription
requestChangeParametersRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Google.LongRunning.Operation<Entitlement, OperationMetadata>

The RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.Create();
// Initialize request argument(s)
ChangeParametersRequest request = new ChangeParametersRequest
{
    Name = "",
    Parameters = { new Parameter(), },
    RequestId = "",
    PurchaseOrderId = "",
};
// Make the request
Operation<Entitlement, OperationMetadata> response = cloudChannelServiceClient.ChangeParameters(request);

// Poll until the returned long-running operation is complete
Operation<Entitlement, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Entitlement result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Entitlement, OperationMetadata> retrievedResponse = cloudChannelServiceClient.PollOnceChangeParameters(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Entitlement retrievedResult = retrievedResponse.Result;
}

ChangeParametersAsync(ChangeParametersRequest, CallSettings)

public virtual Task<Operation<Entitlement, OperationMetadata>> ChangeParametersAsync(ChangeParametersRequest request, CallSettings callSettings = null)

Change parameters of the entitlement

An entitlement parameters update is a long-running operation and results in updates to the entitlement as a result of fulfillment.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request. For example, if the number of seats being changed to is greater than the allowed number of max seats for the resource. Or decreasing seats for a commitment based plan.
  • NOT_FOUND: Entitlement resource not found.
  • INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Long Running Operation ID.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].

Parameters
NameDescription
requestChangeParametersRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Google.LongRunning.Operation<Entitlement, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
ChangeParametersRequest request = new ChangeParametersRequest
{
    Name = "",
    Parameters = { new Parameter(), },
    RequestId = "",
    PurchaseOrderId = "",
};
// Make the request
Operation<Entitlement, OperationMetadata> response = await cloudChannelServiceClient.ChangeParametersAsync(request);

// Poll until the returned long-running operation is complete
Operation<Entitlement, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Entitlement result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Entitlement, OperationMetadata> retrievedResponse = await cloudChannelServiceClient.PollOnceChangeParametersAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Entitlement retrievedResult = retrievedResponse.Result;
}

ChangeParametersAsync(ChangeParametersRequest, CancellationToken)

public virtual Task<Operation<Entitlement, OperationMetadata>> ChangeParametersAsync(ChangeParametersRequest request, CancellationToken cancellationToken)

Change parameters of the entitlement

An entitlement parameters update is a long-running operation and results in updates to the entitlement as a result of fulfillment.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request. For example, if the number of seats being changed to is greater than the allowed number of max seats for the resource. Or decreasing seats for a commitment based plan.
  • NOT_FOUND: Entitlement resource not found.
  • INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Long Running Operation ID.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].

Parameters
NameDescription
requestChangeParametersRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Google.LongRunning.Operation<Entitlement, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
ChangeParametersRequest request = new ChangeParametersRequest
{
    Name = "",
    Parameters = { new Parameter(), },
    RequestId = "",
    PurchaseOrderId = "",
};
// Make the request
Operation<Entitlement, OperationMetadata> response = await cloudChannelServiceClient.ChangeParametersAsync(request);

// Poll until the returned long-running operation is complete
Operation<Entitlement, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Entitlement result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Entitlement, OperationMetadata> retrievedResponse = await cloudChannelServiceClient.PollOnceChangeParametersAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Entitlement retrievedResult = retrievedResponse.Result;
}

ChangeRenewalSettings(ChangeRenewalSettingsRequest, CallSettings)

public virtual Operation<Entitlement, OperationMetadata> ChangeRenewalSettings(ChangeRenewalSettingsRequest request, CallSettings callSettings = null)

Updates the renewal settings for an existing customer entitlement.

An entitlement update is a long-running operation and results in updates to the entitlement as a result of fulfillment.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: Entitlement resource not found.
  • NOT_COMMITMENT_PLAN: Renewal Settings are only applicable for a commitment plan. Can't enable or disable renewal for non-commitment plans.
  • INTERNAL: Any non user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Long Running Operation ID.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].

Parameters
NameDescription
requestChangeRenewalSettingsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Google.LongRunning.Operation<Entitlement, OperationMetadata>

The RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.Create();
// Initialize request argument(s)
ChangeRenewalSettingsRequest request = new ChangeRenewalSettingsRequest
{
    Name = "",
    RenewalSettings = new RenewalSettings(),
    RequestId = "",
};
// Make the request
Operation<Entitlement, OperationMetadata> response = cloudChannelServiceClient.ChangeRenewalSettings(request);

// Poll until the returned long-running operation is complete
Operation<Entitlement, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Entitlement result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Entitlement, OperationMetadata> retrievedResponse = cloudChannelServiceClient.PollOnceChangeRenewalSettings(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Entitlement retrievedResult = retrievedResponse.Result;
}

ChangeRenewalSettingsAsync(ChangeRenewalSettingsRequest, CallSettings)

public virtual Task<Operation<Entitlement, OperationMetadata>> ChangeRenewalSettingsAsync(ChangeRenewalSettingsRequest request, CallSettings callSettings = null)

Updates the renewal settings for an existing customer entitlement.

An entitlement update is a long-running operation and results in updates to the entitlement as a result of fulfillment.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: Entitlement resource not found.
  • NOT_COMMITMENT_PLAN: Renewal Settings are only applicable for a commitment plan. Can't enable or disable renewal for non-commitment plans.
  • INTERNAL: Any non user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Long Running Operation ID.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].

Parameters
NameDescription
requestChangeRenewalSettingsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Google.LongRunning.Operation<Entitlement, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
ChangeRenewalSettingsRequest request = new ChangeRenewalSettingsRequest
{
    Name = "",
    RenewalSettings = new RenewalSettings(),
    RequestId = "",
};
// Make the request
Operation<Entitlement, OperationMetadata> response = await cloudChannelServiceClient.ChangeRenewalSettingsAsync(request);

// Poll until the returned long-running operation is complete
Operation<Entitlement, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Entitlement result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Entitlement, OperationMetadata> retrievedResponse = await cloudChannelServiceClient.PollOnceChangeRenewalSettingsAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Entitlement retrievedResult = retrievedResponse.Result;
}

ChangeRenewalSettingsAsync(ChangeRenewalSettingsRequest, CancellationToken)

public virtual Task<Operation<Entitlement, OperationMetadata>> ChangeRenewalSettingsAsync(ChangeRenewalSettingsRequest request, CancellationToken cancellationToken)

Updates the renewal settings for an existing customer entitlement.

An entitlement update is a long-running operation and results in updates to the entitlement as a result of fulfillment.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: Entitlement resource not found.
  • NOT_COMMITMENT_PLAN: Renewal Settings are only applicable for a commitment plan. Can't enable or disable renewal for non-commitment plans.
  • INTERNAL: Any non user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Long Running Operation ID.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].

Parameters
NameDescription
requestChangeRenewalSettingsRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Google.LongRunning.Operation<Entitlement, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
ChangeRenewalSettingsRequest request = new ChangeRenewalSettingsRequest
{
    Name = "",
    RenewalSettings = new RenewalSettings(),
    RequestId = "",
};
// Make the request
Operation<Entitlement, OperationMetadata> response = await cloudChannelServiceClient.ChangeRenewalSettingsAsync(request);

// Poll until the returned long-running operation is complete
Operation<Entitlement, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Entitlement result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Entitlement, OperationMetadata> retrievedResponse = await cloudChannelServiceClient.PollOnceChangeRenewalSettingsAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Entitlement retrievedResult = retrievedResponse.Result;
}

CheckCloudIdentityAccountsExist(CheckCloudIdentityAccountsExistRequest, CallSettings)

public virtual CheckCloudIdentityAccountsExistResponse CheckCloudIdentityAccountsExist(CheckCloudIdentityAccountsExistRequest request, CallSettings callSettings = null)

Confirms the existence of Cloud Identity accounts, based on the domain and whether the Cloud Identity accounts are owned by the reseller.

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • INVALID_VALUE: Invalid domain value in the request.

Return Value: List of [CloudIdentityCustomerAccount][google.cloud.channel.v1.CloudIdentityCustomerAccount] resources for the domain. List may be empty.

Note: in the v1alpha1 version of the API, a NOT_FOUND error is returned if no [CloudIdentityCustomerAccount][google.cloud.channel.v1.CloudIdentityCustomerAccount] resources match the domain.

Parameters
NameDescription
requestCheckCloudIdentityAccountsExistRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
CheckCloudIdentityAccountsExistResponse

The RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.Create();
// Initialize request argument(s)
CheckCloudIdentityAccountsExistRequest request = new CheckCloudIdentityAccountsExistRequest
{
    Parent = "",
    Domain = "",
};
// Make the request
CheckCloudIdentityAccountsExistResponse response = cloudChannelServiceClient.CheckCloudIdentityAccountsExist(request);

CheckCloudIdentityAccountsExistAsync(CheckCloudIdentityAccountsExistRequest, CallSettings)

public virtual Task<CheckCloudIdentityAccountsExistResponse> CheckCloudIdentityAccountsExistAsync(CheckCloudIdentityAccountsExistRequest request, CallSettings callSettings = null)

Confirms the existence of Cloud Identity accounts, based on the domain and whether the Cloud Identity accounts are owned by the reseller.

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • INVALID_VALUE: Invalid domain value in the request.

Return Value: List of [CloudIdentityCustomerAccount][google.cloud.channel.v1.CloudIdentityCustomerAccount] resources for the domain. List may be empty.

Note: in the v1alpha1 version of the API, a NOT_FOUND error is returned if no [CloudIdentityCustomerAccount][google.cloud.channel.v1.CloudIdentityCustomerAccount] resources match the domain.

Parameters
NameDescription
requestCheckCloudIdentityAccountsExistRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<CheckCloudIdentityAccountsExistResponse>

A Task containing the RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
CheckCloudIdentityAccountsExistRequest request = new CheckCloudIdentityAccountsExistRequest
{
    Parent = "",
    Domain = "",
};
// Make the request
CheckCloudIdentityAccountsExistResponse response = await cloudChannelServiceClient.CheckCloudIdentityAccountsExistAsync(request);

CheckCloudIdentityAccountsExistAsync(CheckCloudIdentityAccountsExistRequest, CancellationToken)

public virtual Task<CheckCloudIdentityAccountsExistResponse> CheckCloudIdentityAccountsExistAsync(CheckCloudIdentityAccountsExistRequest request, CancellationToken cancellationToken)

Confirms the existence of Cloud Identity accounts, based on the domain and whether the Cloud Identity accounts are owned by the reseller.

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • INVALID_VALUE: Invalid domain value in the request.

Return Value: List of [CloudIdentityCustomerAccount][google.cloud.channel.v1.CloudIdentityCustomerAccount] resources for the domain. List may be empty.

Note: in the v1alpha1 version of the API, a NOT_FOUND error is returned if no [CloudIdentityCustomerAccount][google.cloud.channel.v1.CloudIdentityCustomerAccount] resources match the domain.

Parameters
NameDescription
requestCheckCloudIdentityAccountsExistRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<CheckCloudIdentityAccountsExistResponse>

A Task containing the RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
CheckCloudIdentityAccountsExistRequest request = new CheckCloudIdentityAccountsExistRequest
{
    Parent = "",
    Domain = "",
};
// Make the request
CheckCloudIdentityAccountsExistResponse response = await cloudChannelServiceClient.CheckCloudIdentityAccountsExistAsync(request);

Create()

public static CloudChannelServiceClient Create()

Synchronously creates a CloudChannelServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use CloudChannelServiceClientBuilder.

Returns
TypeDescription
CloudChannelServiceClient

The created CloudChannelServiceClient.

CreateAsync(CancellationToken)

public static Task<CloudChannelServiceClient> CreateAsync(CancellationToken cancellationToken = default(CancellationToken))

Asynchronously creates a CloudChannelServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use CloudChannelServiceClientBuilder.

Parameter
NameDescription
cancellationTokenCancellationToken

The CancellationToken to use while creating the client.

Returns
TypeDescription
Task<CloudChannelServiceClient>

The task representing the created CloudChannelServiceClient.

public virtual ChannelPartnerLink CreateChannelPartnerLink(CreateChannelPartnerLinkRequest request, CallSettings callSettings = null)

Initiates a channel partner link between a distributor and a reseller or between resellers in an n-tier reseller channel. To accept the invite, the invited partner should follow the invite_link_uri provided in the response. If the link creation is accepted, a valid link is set up between the two involved parties. To call this method, you must be a distributor.

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • ALREADY_EXISTS: If the ChannelPartnerLink sent in the request already exists.
  • NOT_FOUND: If no Cloud Identity customer exists for domain provided.
  • INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Newly created [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource if successful, otherwise error is returned.

Parameters
NameDescription
requestCreateChannelPartnerLinkRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ChannelPartnerLink

The RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.Create();
// Initialize request argument(s)
CreateChannelPartnerLinkRequest request = new CreateChannelPartnerLinkRequest
{
    Parent = "",
    ChannelPartnerLink = new ChannelPartnerLink(),
};
// Make the request
ChannelPartnerLink response = cloudChannelServiceClient.CreateChannelPartnerLink(request);

CreateChannelPartnerLinkAsync(CreateChannelPartnerLinkRequest, CallSettings)

public virtual Task<ChannelPartnerLink> CreateChannelPartnerLinkAsync(CreateChannelPartnerLinkRequest request, CallSettings callSettings = null)

Initiates a channel partner link between a distributor and a reseller or between resellers in an n-tier reseller channel. To accept the invite, the invited partner should follow the invite_link_uri provided in the response. If the link creation is accepted, a valid link is set up between the two involved parties. To call this method, you must be a distributor.

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • ALREADY_EXISTS: If the ChannelPartnerLink sent in the request already exists.
  • NOT_FOUND: If no Cloud Identity customer exists for domain provided.
  • INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Newly created [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource if successful, otherwise error is returned.

Parameters
NameDescription
requestCreateChannelPartnerLinkRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<ChannelPartnerLink>

A Task containing the RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
CreateChannelPartnerLinkRequest request = new CreateChannelPartnerLinkRequest
{
    Parent = "",
    ChannelPartnerLink = new ChannelPartnerLink(),
};
// Make the request
ChannelPartnerLink response = await cloudChannelServiceClient.CreateChannelPartnerLinkAsync(request);

CreateChannelPartnerLinkAsync(CreateChannelPartnerLinkRequest, CancellationToken)

public virtual Task<ChannelPartnerLink> CreateChannelPartnerLinkAsync(CreateChannelPartnerLinkRequest request, CancellationToken cancellationToken)

Initiates a channel partner link between a distributor and a reseller or between resellers in an n-tier reseller channel. To accept the invite, the invited partner should follow the invite_link_uri provided in the response. If the link creation is accepted, a valid link is set up between the two involved parties. To call this method, you must be a distributor.

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • ALREADY_EXISTS: If the ChannelPartnerLink sent in the request already exists.
  • NOT_FOUND: If no Cloud Identity customer exists for domain provided.
  • INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Newly created [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource if successful, otherwise error is returned.

Parameters
NameDescription
requestCreateChannelPartnerLinkRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<ChannelPartnerLink>

A Task containing the RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
CreateChannelPartnerLinkRequest request = new CreateChannelPartnerLinkRequest
{
    Parent = "",
    ChannelPartnerLink = new ChannelPartnerLink(),
};
// Make the request
ChannelPartnerLink response = await cloudChannelServiceClient.CreateChannelPartnerLinkAsync(request);

CreateCustomer(CreateCustomerRequest, CallSettings)

public virtual Customer CreateCustomer(CreateCustomerRequest request, CallSettings callSettings = null)

Creates a new [Customer][google.cloud.channel.v1.Customer] resource under the reseller or distributor account.

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: It can happen in following scenarios -
  • Missing or invalid required parameters in the request.
  • Domain field value doesn't match the domain specified in primary email.

Return Value: If successful, the newly created [Customer][google.cloud.channel.v1.Customer] resource, otherwise returns an error.

Parameters
NameDescription
requestCreateCustomerRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Customer

The RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.Create();
// Initialize request argument(s)
CreateCustomerRequest request = new CreateCustomerRequest
{
    Parent = "",
    Customer = new Customer(),
};
// Make the request
Customer response = cloudChannelServiceClient.CreateCustomer(request);

CreateCustomerAsync(CreateCustomerRequest, CallSettings)

public virtual Task<Customer> CreateCustomerAsync(CreateCustomerRequest request, CallSettings callSettings = null)

Creates a new [Customer][google.cloud.channel.v1.Customer] resource under the reseller or distributor account.

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: It can happen in following scenarios -
  • Missing or invalid required parameters in the request.
  • Domain field value doesn't match the domain specified in primary email.

Return Value: If successful, the newly created [Customer][google.cloud.channel.v1.Customer] resource, otherwise returns an error.

Parameters
NameDescription
requestCreateCustomerRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Customer>

A Task containing the RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
CreateCustomerRequest request = new CreateCustomerRequest
{
    Parent = "",
    Customer = new Customer(),
};
// Make the request
Customer response = await cloudChannelServiceClient.CreateCustomerAsync(request);

CreateCustomerAsync(CreateCustomerRequest, CancellationToken)

public virtual Task<Customer> CreateCustomerAsync(CreateCustomerRequest request, CancellationToken cancellationToken)

Creates a new [Customer][google.cloud.channel.v1.Customer] resource under the reseller or distributor account.

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: It can happen in following scenarios -
  • Missing or invalid required parameters in the request.
  • Domain field value doesn't match the domain specified in primary email.

Return Value: If successful, the newly created [Customer][google.cloud.channel.v1.Customer] resource, otherwise returns an error.

Parameters
NameDescription
requestCreateCustomerRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Customer>

A Task containing the RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
CreateCustomerRequest request = new CreateCustomerRequest
{
    Parent = "",
    Customer = new Customer(),
};
// Make the request
Customer response = await cloudChannelServiceClient.CreateCustomerAsync(request);

CreateEntitlement(CreateEntitlementRequest, CallSettings)

public virtual Operation<Entitlement, OperationMetadata> CreateEntitlement(CreateEntitlementRequest request, CallSettings callSettings = null)

Creates an entitlement for a customer.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: It can happen in below scenarios -
  • Missing or invalid required parameters in the request.
  • Cannot purchase an entitlement if there is already an entitlement for customer, for a SKU from the same product family.
  • INVALID_VALUE: Offer passed in isn't valid. Make sure OfferId is valid. If it is valid, then contact Google Channel support for further troubleshooting.
  • NOT_FOUND: If the customer or offer resource is not found for the reseller.
  • ALREADY_EXISTS: This failure can happen in the following cases:
  • If the SKU has been already purchased for the customer.
  • If the customer's primary email already exists. In this case retry after changing the customer's primary contact email.
  • CONDITION_NOT_MET or FAILED_PRECONDITION: This failure can happen in the following cases:
  • Purchasing a SKU that requires domain verification and the domain has not been verified.
  • Purchasing an Add-On SKU like Vault or Drive without purchasing the pre-requisite SKU, such as Google Workspace Business Starter.
  • Applicable only for developer accounts: reseller and resold domain. Must meet the following domain naming requirements:
  • Domain names must start with goog-test.
  • Resold domain names must include the reseller domain.
  • INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel Support in this case.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel Support in this case.

Return Value: Long Running Operation ID.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].

Parameters
NameDescription
requestCreateEntitlementRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Google.LongRunning.Operation<Entitlement, OperationMetadata>

The RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.Create();
// Initialize request argument(s)
CreateEntitlementRequest request = new CreateEntitlementRequest
{
    ParentAsCustomerName = CustomerName.FromAccountCustomer("[ACCOUNT]", "[CUSTOMER]"),
    Entitlement = new Entitlement(),
    RequestId = "",
};
// Make the request
Operation<Entitlement, OperationMetadata> response = cloudChannelServiceClient.CreateEntitlement(request);

// Poll until the returned long-running operation is complete
Operation<Entitlement, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Entitlement result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Entitlement, OperationMetadata> retrievedResponse = cloudChannelServiceClient.PollOnceCreateEntitlement(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Entitlement retrievedResult = retrievedResponse.Result;
}

CreateEntitlementAsync(CreateEntitlementRequest, CallSettings)

public virtual Task<Operation<Entitlement, OperationMetadata>> CreateEntitlementAsync(CreateEntitlementRequest request, CallSettings callSettings = null)

Creates an entitlement for a customer.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: It can happen in below scenarios -
  • Missing or invalid required parameters in the request.
  • Cannot purchase an entitlement if there is already an entitlement for customer, for a SKU from the same product family.
  • INVALID_VALUE: Offer passed in isn't valid. Make sure OfferId is valid. If it is valid, then contact Google Channel support for further troubleshooting.
  • NOT_FOUND: If the customer or offer resource is not found for the reseller.
  • ALREADY_EXISTS: This failure can happen in the following cases:
  • If the SKU has been already purchased for the customer.
  • If the customer's primary email already exists. In this case retry after changing the customer's primary contact email.
  • CONDITION_NOT_MET or FAILED_PRECONDITION: This failure can happen in the following cases:
  • Purchasing a SKU that requires domain verification and the domain has not been verified.
  • Purchasing an Add-On SKU like Vault or Drive without purchasing the pre-requisite SKU, such as Google Workspace Business Starter.
  • Applicable only for developer accounts: reseller and resold domain. Must meet the following domain naming requirements:
  • Domain names must start with goog-test.
  • Resold domain names must include the reseller domain.
  • INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel Support in this case.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel Support in this case.

Return Value: Long Running Operation ID.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].

Parameters
NameDescription
requestCreateEntitlementRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Google.LongRunning.Operation<Entitlement, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
CreateEntitlementRequest request = new CreateEntitlementRequest
{
    ParentAsCustomerName = CustomerName.FromAccountCustomer("[ACCOUNT]", "[CUSTOMER]"),
    Entitlement = new Entitlement(),
    RequestId = "",
};
// Make the request
Operation<Entitlement, OperationMetadata> response = await cloudChannelServiceClient.CreateEntitlementAsync(request);

// Poll until the returned long-running operation is complete
Operation<Entitlement, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Entitlement result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Entitlement, OperationMetadata> retrievedResponse = await cloudChannelServiceClient.PollOnceCreateEntitlementAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Entitlement retrievedResult = retrievedResponse.Result;
}

CreateEntitlementAsync(CreateEntitlementRequest, CancellationToken)

public virtual Task<Operation<Entitlement, OperationMetadata>> CreateEntitlementAsync(CreateEntitlementRequest request, CancellationToken cancellationToken)

Creates an entitlement for a customer.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: It can happen in below scenarios -
  • Missing or invalid required parameters in the request.
  • Cannot purchase an entitlement if there is already an entitlement for customer, for a SKU from the same product family.
  • INVALID_VALUE: Offer passed in isn't valid. Make sure OfferId is valid. If it is valid, then contact Google Channel support for further troubleshooting.
  • NOT_FOUND: If the customer or offer resource is not found for the reseller.
  • ALREADY_EXISTS: This failure can happen in the following cases:
  • If the SKU has been already purchased for the customer.
  • If the customer's primary email already exists. In this case retry after changing the customer's primary contact email.
  • CONDITION_NOT_MET or FAILED_PRECONDITION: This failure can happen in the following cases:
  • Purchasing a SKU that requires domain verification and the domain has not been verified.
  • Purchasing an Add-On SKU like Vault or Drive without purchasing the pre-requisite SKU, such as Google Workspace Business Starter.
  • Applicable only for developer accounts: reseller and resold domain. Must meet the following domain naming requirements:
  • Domain names must start with goog-test.
  • Resold domain names must include the reseller domain.
  • INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel Support in this case.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel Support in this case.

Return Value: Long Running Operation ID.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].

Parameters
NameDescription
requestCreateEntitlementRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Google.LongRunning.Operation<Entitlement, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
CreateEntitlementRequest request = new CreateEntitlementRequest
{
    ParentAsCustomerName = CustomerName.FromAccountCustomer("[ACCOUNT]", "[CUSTOMER]"),
    Entitlement = new Entitlement(),
    RequestId = "",
};
// Make the request
Operation<Entitlement, OperationMetadata> response = await cloudChannelServiceClient.CreateEntitlementAsync(request);

// Poll until the returned long-running operation is complete
Operation<Entitlement, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Entitlement result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Entitlement, OperationMetadata> retrievedResponse = await cloudChannelServiceClient.PollOnceCreateEntitlementAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Entitlement retrievedResult = retrievedResponse.Result;
}

DeleteCustomer(CustomerName, CallSettings)

public virtual void DeleteCustomer(CustomerName name, CallSettings callSettings = null)

Deletes the given [Customer][google.cloud.channel.v1.Customer] permanently and irreversibly.

Possible Error Codes:

  • PERMISSION_DENIED: If the account making the request does not own this customer.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • FAILED_PRECONDITION: If the customer has existing entitlements.
  • NOT_FOUND: No [Customer][google.cloud.channel.v1.Customer] resource found for the name specified in the request.
Parameters
NameDescription
nameCustomerName

Required. The resource name of the customer to delete.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.Create();
// Initialize request argument(s)
CustomerName name = CustomerName.FromAccountCustomer("[ACCOUNT]", "[CUSTOMER]");
// Make the request
cloudChannelServiceClient.DeleteCustomer(name);

DeleteCustomer(DeleteCustomerRequest, CallSettings)

public virtual void DeleteCustomer(DeleteCustomerRequest request, CallSettings callSettings = null)

Deletes the given [Customer][google.cloud.channel.v1.Customer] permanently and irreversibly.

Possible Error Codes:

  • PERMISSION_DENIED: If the account making the request does not own this customer.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • FAILED_PRECONDITION: If the customer has existing entitlements.
  • NOT_FOUND: No [Customer][google.cloud.channel.v1.Customer] resource found for the name specified in the request.
Parameters
NameDescription
requestDeleteCustomerRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.Create();
// Initialize request argument(s)
DeleteCustomerRequest request = new DeleteCustomerRequest
{
    CustomerName = CustomerName.FromAccountCustomer("[ACCOUNT]", "[CUSTOMER]"),
};
// Make the request
cloudChannelServiceClient.DeleteCustomer(request);

DeleteCustomer(String, CallSettings)

public virtual void DeleteCustomer(string name, CallSettings callSettings = null)

Deletes the given [Customer][google.cloud.channel.v1.Customer] permanently and irreversibly.

Possible Error Codes:

  • PERMISSION_DENIED: If the account making the request does not own this customer.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • FAILED_PRECONDITION: If the customer has existing entitlements.
  • NOT_FOUND: No [Customer][google.cloud.channel.v1.Customer] resource found for the name specified in the request.
Parameters
NameDescription
nameString

Required. The resource name of the customer to delete.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.Create();
// Initialize request argument(s)
string name = "accounts/[ACCOUNT]/customers/[CUSTOMER]";
// Make the request
cloudChannelServiceClient.DeleteCustomer(name);

DeleteCustomerAsync(CustomerName, CallSettings)

public virtual Task DeleteCustomerAsync(CustomerName name, CallSettings callSettings = null)

Deletes the given [Customer][google.cloud.channel.v1.Customer] permanently and irreversibly.

Possible Error Codes:

  • PERMISSION_DENIED: If the account making the request does not own this customer.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • FAILED_PRECONDITION: If the customer has existing entitlements.
  • NOT_FOUND: No [Customer][google.cloud.channel.v1.Customer] resource found for the name specified in the request.
Parameters
NameDescription
nameCustomerName

Required. The resource name of the customer to delete.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
CustomerName name = CustomerName.FromAccountCustomer("[ACCOUNT]", "[CUSTOMER]");
// Make the request
await cloudChannelServiceClient.DeleteCustomerAsync(name);

DeleteCustomerAsync(CustomerName, CancellationToken)

public virtual Task DeleteCustomerAsync(CustomerName name, CancellationToken cancellationToken)

Deletes the given [Customer][google.cloud.channel.v1.Customer] permanently and irreversibly.

Possible Error Codes:

  • PERMISSION_DENIED: If the account making the request does not own this customer.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • FAILED_PRECONDITION: If the customer has existing entitlements.
  • NOT_FOUND: No [Customer][google.cloud.channel.v1.Customer] resource found for the name specified in the request.
Parameters
NameDescription
nameCustomerName

Required. The resource name of the customer to delete.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
CustomerName name = CustomerName.FromAccountCustomer("[ACCOUNT]", "[CUSTOMER]");
// Make the request
await cloudChannelServiceClient.DeleteCustomerAsync(name);

DeleteCustomerAsync(DeleteCustomerRequest, CallSettings)

public virtual Task DeleteCustomerAsync(DeleteCustomerRequest request, CallSettings callSettings = null)

Deletes the given [Customer][google.cloud.channel.v1.Customer] permanently and irreversibly.

Possible Error Codes:

  • PERMISSION_DENIED: If the account making the request does not own this customer.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • FAILED_PRECONDITION: If the customer has existing entitlements.
  • NOT_FOUND: No [Customer][google.cloud.channel.v1.Customer] resource found for the name specified in the request.
Parameters
NameDescription
requestDeleteCustomerRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteCustomerRequest request = new DeleteCustomerRequest
{
    CustomerName = CustomerName.FromAccountCustomer("[ACCOUNT]", "[CUSTOMER]"),
};
// Make the request
await cloudChannelServiceClient.DeleteCustomerAsync(request);

DeleteCustomerAsync(DeleteCustomerRequest, CancellationToken)

public virtual Task DeleteCustomerAsync(DeleteCustomerRequest request, CancellationToken cancellationToken)

Deletes the given [Customer][google.cloud.channel.v1.Customer] permanently and irreversibly.

Possible Error Codes:

  • PERMISSION_DENIED: If the account making the request does not own this customer.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • FAILED_PRECONDITION: If the customer has existing entitlements.
  • NOT_FOUND: No [Customer][google.cloud.channel.v1.Customer] resource found for the name specified in the request.
Parameters
NameDescription
requestDeleteCustomerRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteCustomerRequest request = new DeleteCustomerRequest
{
    CustomerName = CustomerName.FromAccountCustomer("[ACCOUNT]", "[CUSTOMER]"),
};
// Make the request
await cloudChannelServiceClient.DeleteCustomerAsync(request);

DeleteCustomerAsync(String, CallSettings)

public virtual Task DeleteCustomerAsync(string name, CallSettings callSettings = null)

Deletes the given [Customer][google.cloud.channel.v1.Customer] permanently and irreversibly.

Possible Error Codes:

  • PERMISSION_DENIED: If the account making the request does not own this customer.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • FAILED_PRECONDITION: If the customer has existing entitlements.
  • NOT_FOUND: No [Customer][google.cloud.channel.v1.Customer] resource found for the name specified in the request.
Parameters
NameDescription
nameString

Required. The resource name of the customer to delete.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "accounts/[ACCOUNT]/customers/[CUSTOMER]";
// Make the request
await cloudChannelServiceClient.DeleteCustomerAsync(name);

DeleteCustomerAsync(String, CancellationToken)

public virtual Task DeleteCustomerAsync(string name, CancellationToken cancellationToken)

Deletes the given [Customer][google.cloud.channel.v1.Customer] permanently and irreversibly.

Possible Error Codes:

  • PERMISSION_DENIED: If the account making the request does not own this customer.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • FAILED_PRECONDITION: If the customer has existing entitlements.
  • NOT_FOUND: No [Customer][google.cloud.channel.v1.Customer] resource found for the name specified in the request.
Parameters
NameDescription
nameString

Required. The resource name of the customer to delete.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "accounts/[ACCOUNT]/customers/[CUSTOMER]";
// Make the request
await cloudChannelServiceClient.DeleteCustomerAsync(name);
public virtual ChannelPartnerLink GetChannelPartnerLink(GetChannelPartnerLinkRequest request, CallSettings callSettings = null)

Returns a requested [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource. To call this method, you must be a distributor.

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: ChannelPartnerLink resource not found. Results due invalid channel partner link name.

Return Value: [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource if found, otherwise returns an error.

Parameters
NameDescription
requestGetChannelPartnerLinkRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ChannelPartnerLink

The RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.Create();
// Initialize request argument(s)
GetChannelPartnerLinkRequest request = new GetChannelPartnerLinkRequest
{
    Name = "",
    View = ChannelPartnerLinkView.Unspecified,
};
// Make the request
ChannelPartnerLink response = cloudChannelServiceClient.GetChannelPartnerLink(request);

GetChannelPartnerLinkAsync(GetChannelPartnerLinkRequest, CallSettings)

public virtual Task<ChannelPartnerLink> GetChannelPartnerLinkAsync(GetChannelPartnerLinkRequest request, CallSettings callSettings = null)

Returns a requested [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource. To call this method, you must be a distributor.

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: ChannelPartnerLink resource not found. Results due invalid channel partner link name.

Return Value: [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource if found, otherwise returns an error.

Parameters
NameDescription
requestGetChannelPartnerLinkRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<ChannelPartnerLink>

A Task containing the RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
GetChannelPartnerLinkRequest request = new GetChannelPartnerLinkRequest
{
    Name = "",
    View = ChannelPartnerLinkView.Unspecified,
};
// Make the request
ChannelPartnerLink response = await cloudChannelServiceClient.GetChannelPartnerLinkAsync(request);

GetChannelPartnerLinkAsync(GetChannelPartnerLinkRequest, CancellationToken)

public virtual Task<ChannelPartnerLink> GetChannelPartnerLinkAsync(GetChannelPartnerLinkRequest request, CancellationToken cancellationToken)

Returns a requested [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource. To call this method, you must be a distributor.

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: ChannelPartnerLink resource not found. Results due invalid channel partner link name.

Return Value: [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource if found, otherwise returns an error.

Parameters
NameDescription
requestGetChannelPartnerLinkRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<ChannelPartnerLink>

A Task containing the RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
GetChannelPartnerLinkRequest request = new GetChannelPartnerLinkRequest
{
    Name = "",
    View = ChannelPartnerLinkView.Unspecified,
};
// Make the request
ChannelPartnerLink response = await cloudChannelServiceClient.GetChannelPartnerLinkAsync(request);

GetCustomer(CustomerName, CallSettings)

public virtual Customer GetCustomer(CustomerName name, CallSettings callSettings = null)

Returns a requested [Customer][google.cloud.channel.v1.Customer] resource.

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: If the customer resource doesn't exist. Usually the result of an invalid name parameter.

Return Value: [Customer][google.cloud.channel.v1.Customer] resource if found, error otherwise.

Parameters
NameDescription
nameCustomerName

Required. The resource name of the customer to retrieve. The name takes the format: accounts/{account_id}/customers/{customer_id}

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Customer

The RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.Create();
// Initialize request argument(s)
CustomerName name = CustomerName.FromAccountCustomer("[ACCOUNT]", "[CUSTOMER]");
// Make the request
Customer response = cloudChannelServiceClient.GetCustomer(name);

GetCustomer(GetCustomerRequest, CallSettings)

public virtual Customer GetCustomer(GetCustomerRequest request, CallSettings callSettings = null)

Returns a requested [Customer][google.cloud.channel.v1.Customer] resource.

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: If the customer resource doesn't exist. Usually the result of an invalid name parameter.

Return Value: [Customer][google.cloud.channel.v1.Customer] resource if found, error otherwise.

Parameters
NameDescription
requestGetCustomerRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Customer

The RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.Create();
// Initialize request argument(s)
GetCustomerRequest request = new GetCustomerRequest
{
    CustomerName = CustomerName.FromAccountCustomer("[ACCOUNT]", "[CUSTOMER]"),
};
// Make the request
Customer response = cloudChannelServiceClient.GetCustomer(request);

GetCustomer(String, CallSettings)

public virtual Customer GetCustomer(string name, CallSettings callSettings = null)

Returns a requested [Customer][google.cloud.channel.v1.Customer] resource.

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: If the customer resource doesn't exist. Usually the result of an invalid name parameter.

Return Value: [Customer][google.cloud.channel.v1.Customer] resource if found, error otherwise.

Parameters
NameDescription
nameString

Required. The resource name of the customer to retrieve. The name takes the format: accounts/{account_id}/customers/{customer_id}

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Customer

The RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.Create();
// Initialize request argument(s)
string name = "accounts/[ACCOUNT]/customers/[CUSTOMER]";
// Make the request
Customer response = cloudChannelServiceClient.GetCustomer(name);

GetCustomerAsync(CustomerName, CallSettings)

public virtual Task<Customer> GetCustomerAsync(CustomerName name, CallSettings callSettings = null)

Returns a requested [Customer][google.cloud.channel.v1.Customer] resource.

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: If the customer resource doesn't exist. Usually the result of an invalid name parameter.

Return Value: [Customer][google.cloud.channel.v1.Customer] resource if found, error otherwise.

Parameters
NameDescription
nameCustomerName

Required. The resource name of the customer to retrieve. The name takes the format: accounts/{account_id}/customers/{customer_id}

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Customer>

A Task containing the RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
CustomerName name = CustomerName.FromAccountCustomer("[ACCOUNT]", "[CUSTOMER]");
// Make the request
Customer response = await cloudChannelServiceClient.GetCustomerAsync(name);

GetCustomerAsync(CustomerName, CancellationToken)

public virtual Task<Customer> GetCustomerAsync(CustomerName name, CancellationToken cancellationToken)

Returns a requested [Customer][google.cloud.channel.v1.Customer] resource.

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: If the customer resource doesn't exist. Usually the result of an invalid name parameter.

Return Value: [Customer][google.cloud.channel.v1.Customer] resource if found, error otherwise.

Parameters
NameDescription
nameCustomerName

Required. The resource name of the customer to retrieve. The name takes the format: accounts/{account_id}/customers/{customer_id}

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Customer>

A Task containing the RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
CustomerName name = CustomerName.FromAccountCustomer("[ACCOUNT]", "[CUSTOMER]");
// Make the request
Customer response = await cloudChannelServiceClient.GetCustomerAsync(name);

GetCustomerAsync(GetCustomerRequest, CallSettings)

public virtual Task<Customer> GetCustomerAsync(GetCustomerRequest request, CallSettings callSettings = null)

Returns a requested [Customer][google.cloud.channel.v1.Customer] resource.

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: If the customer resource doesn't exist. Usually the result of an invalid name parameter.

Return Value: [Customer][google.cloud.channel.v1.Customer] resource if found, error otherwise.

Parameters
NameDescription
requestGetCustomerRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Customer>

A Task containing the RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
GetCustomerRequest request = new GetCustomerRequest
{
    CustomerName = CustomerName.FromAccountCustomer("[ACCOUNT]", "[CUSTOMER]"),
};
// Make the request
Customer response = await cloudChannelServiceClient.GetCustomerAsync(request);

GetCustomerAsync(GetCustomerRequest, CancellationToken)

public virtual Task<Customer> GetCustomerAsync(GetCustomerRequest request, CancellationToken cancellationToken)

Returns a requested [Customer][google.cloud.channel.v1.Customer] resource.

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: If the customer resource doesn't exist. Usually the result of an invalid name parameter.

Return Value: [Customer][google.cloud.channel.v1.Customer] resource if found, error otherwise.

Parameters
NameDescription
requestGetCustomerRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Customer>

A Task containing the RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
GetCustomerRequest request = new GetCustomerRequest
{
    CustomerName = CustomerName.FromAccountCustomer("[ACCOUNT]", "[CUSTOMER]"),
};
// Make the request
Customer response = await cloudChannelServiceClient.GetCustomerAsync(request);

GetCustomerAsync(String, CallSettings)

public virtual Task<Customer> GetCustomerAsync(string name, CallSettings callSettings = null)

Returns a requested [Customer][google.cloud.channel.v1.Customer] resource.

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: If the customer resource doesn't exist. Usually the result of an invalid name parameter.

Return Value: [Customer][google.cloud.channel.v1.Customer] resource if found, error otherwise.

Parameters
NameDescription
nameString

Required. The resource name of the customer to retrieve. The name takes the format: accounts/{account_id}/customers/{customer_id}

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Customer>

A Task containing the RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "accounts/[ACCOUNT]/customers/[CUSTOMER]";
// Make the request
Customer response = await cloudChannelServiceClient.GetCustomerAsync(name);

GetCustomerAsync(String, CancellationToken)

public virtual Task<Customer> GetCustomerAsync(string name, CancellationToken cancellationToken)

Returns a requested [Customer][google.cloud.channel.v1.Customer] resource.

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: If the customer resource doesn't exist. Usually the result of an invalid name parameter.

Return Value: [Customer][google.cloud.channel.v1.Customer] resource if found, error otherwise.

Parameters
NameDescription
nameString

Required. The resource name of the customer to retrieve. The name takes the format: accounts/{account_id}/customers/{customer_id}

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Customer>

A Task containing the RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "accounts/[ACCOUNT]/customers/[CUSTOMER]";
// Make the request
Customer response = await cloudChannelServiceClient.GetCustomerAsync(name);

GetEntitlement(GetEntitlementRequest, CallSettings)

public virtual Entitlement GetEntitlement(GetEntitlementRequest request, CallSettings callSettings = null)

Returns a requested [Entitlement][google.cloud.channel.v1.Entitlement] resource.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: If the entitlement is not found for the customer.

Return Value: If found, the requested [Entitlement][google.cloud.channel.v1.Entitlement] resource, otherwise returns an error.

Parameters
NameDescription
requestGetEntitlementRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Entitlement

The RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.Create();
// Initialize request argument(s)
GetEntitlementRequest request = new GetEntitlementRequest
{
    EntitlementName = EntitlementName.FromAccountCustomerEntitlement("[ACCOUNT]", "[CUSTOMER]", "[ENTITLEMENT]"),
};
// Make the request
Entitlement response = cloudChannelServiceClient.GetEntitlement(request);

GetEntitlementAsync(GetEntitlementRequest, CallSettings)

public virtual Task<Entitlement> GetEntitlementAsync(GetEntitlementRequest request, CallSettings callSettings = null)

Returns a requested [Entitlement][google.cloud.channel.v1.Entitlement] resource.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: If the entitlement is not found for the customer.

Return Value: If found, the requested [Entitlement][google.cloud.channel.v1.Entitlement] resource, otherwise returns an error.

Parameters
NameDescription
requestGetEntitlementRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Entitlement>

A Task containing the RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
GetEntitlementRequest request = new GetEntitlementRequest
{
    EntitlementName = EntitlementName.FromAccountCustomerEntitlement("[ACCOUNT]", "[CUSTOMER]", "[ENTITLEMENT]"),
};
// Make the request
Entitlement response = await cloudChannelServiceClient.GetEntitlementAsync(request);

GetEntitlementAsync(GetEntitlementRequest, CancellationToken)

public virtual Task<Entitlement> GetEntitlementAsync(GetEntitlementRequest request, CancellationToken cancellationToken)

Returns a requested [Entitlement][google.cloud.channel.v1.Entitlement] resource.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: If the entitlement is not found for the customer.

Return Value: If found, the requested [Entitlement][google.cloud.channel.v1.Entitlement] resource, otherwise returns an error.

Parameters
NameDescription
requestGetEntitlementRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Entitlement>

A Task containing the RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
GetEntitlementRequest request = new GetEntitlementRequest
{
    EntitlementName = EntitlementName.FromAccountCustomerEntitlement("[ACCOUNT]", "[CUSTOMER]", "[ENTITLEMENT]"),
};
// Make the request
Entitlement response = await cloudChannelServiceClient.GetEntitlementAsync(request);
public virtual PagedEnumerable<ListChannelPartnerLinksResponse, ChannelPartnerLink> ListChannelPartnerLinks(ListChannelPartnerLinksRequest request, CallSettings callSettings = null)

List [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink]s belonging to a distributor. To call this method, you must be a distributor.

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.

Return Value: If successful, returns the list of [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resources for the distributor account, otherwise returns an error.

Parameters
NameDescription
requestListChannelPartnerLinksRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListChannelPartnerLinksResponse, ChannelPartnerLink>

A pageable sequence of ChannelPartnerLink resources.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.Create();
// Initialize request argument(s)
ListChannelPartnerLinksRequest request = new ListChannelPartnerLinksRequest
{
    Parent = "",
    View = ChannelPartnerLinkView.Unspecified,
};
// Make the request
PagedEnumerable<ListChannelPartnerLinksResponse, ChannelPartnerLink> response = cloudChannelServiceClient.ListChannelPartnerLinks(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (ChannelPartnerLink item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListChannelPartnerLinksResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ChannelPartnerLink item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<ChannelPartnerLink> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (ChannelPartnerLink item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListChannelPartnerLinksAsync(ListChannelPartnerLinksRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListChannelPartnerLinksResponse, ChannelPartnerLink> ListChannelPartnerLinksAsync(ListChannelPartnerLinksRequest request, CallSettings callSettings = null)

List [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink]s belonging to a distributor. To call this method, you must be a distributor.

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.

Return Value: If successful, returns the list of [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resources for the distributor account, otherwise returns an error.

Parameters
NameDescription
requestListChannelPartnerLinksRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListChannelPartnerLinksResponse, ChannelPartnerLink>

A pageable asynchronous sequence of ChannelPartnerLink resources.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
ListChannelPartnerLinksRequest request = new ListChannelPartnerLinksRequest
{
    Parent = "",
    View = ChannelPartnerLinkView.Unspecified,
};
// Make the request
PagedAsyncEnumerable<ListChannelPartnerLinksResponse, ChannelPartnerLink> response = cloudChannelServiceClient.ListChannelPartnerLinksAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((ChannelPartnerLink item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListChannelPartnerLinksResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ChannelPartnerLink item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<ChannelPartnerLink> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (ChannelPartnerLink item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListCustomers(ListCustomersRequest, CallSettings)

public virtual PagedEnumerable<ListCustomersResponse, Customer> ListCustomers(ListCustomersRequest request, CallSettings callSettings = null)

List downstream [Customer][google.cloud.channel.v1.Customer]s.

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.

Return Value: List of [Customer][google.cloud.channel.v1.Customer]s pertaining to the reseller or empty list if there are none.

Parameters
NameDescription
requestListCustomersRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListCustomersResponse, Customer>

A pageable sequence of Customer resources.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.Create();
// Initialize request argument(s)
ListCustomersRequest request = new ListCustomersRequest { Parent = "", };
// Make the request
PagedEnumerable<ListCustomersResponse, Customer> response = cloudChannelServiceClient.ListCustomers(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (Customer item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListCustomersResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Customer item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Customer> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Customer item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListCustomersAsync(ListCustomersRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListCustomersResponse, Customer> ListCustomersAsync(ListCustomersRequest request, CallSettings callSettings = null)

List downstream [Customer][google.cloud.channel.v1.Customer]s.

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.

Return Value: List of [Customer][google.cloud.channel.v1.Customer]s pertaining to the reseller or empty list if there are none.

Parameters
NameDescription
requestListCustomersRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListCustomersResponse, Customer>

A pageable asynchronous sequence of Customer resources.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
ListCustomersRequest request = new ListCustomersRequest { Parent = "", };
// Make the request
PagedAsyncEnumerable<ListCustomersResponse, Customer> response = cloudChannelServiceClient.ListCustomersAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Customer item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListCustomersResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Customer item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Customer> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Customer item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListEntitlements(ListEntitlementsRequest, CallSettings)

public virtual PagedEnumerable<ListEntitlementsResponse, Entitlement> ListEntitlements(ListEntitlementsRequest request, CallSettings callSettings = null)

List [Entitlement][google.cloud.channel.v1.Entitlement]s belonging to a customer.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.

Return Value: List of [Entitlement][google.cloud.channel.v1.Entitlement]s belonging to the customer, or empty list if there are none.

Parameters
NameDescription
requestListEntitlementsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListEntitlementsResponse, Entitlement>

A pageable sequence of Entitlement resources.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.Create();
// Initialize request argument(s)
ListEntitlementsRequest request = new ListEntitlementsRequest
{
    ParentAsCustomerName = CustomerName.FromAccountCustomer("[ACCOUNT]", "[CUSTOMER]"),
};
// Make the request
PagedEnumerable<ListEntitlementsResponse, Entitlement> response = cloudChannelServiceClient.ListEntitlements(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (Entitlement item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListEntitlementsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Entitlement item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Entitlement> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Entitlement item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListEntitlementsAsync(ListEntitlementsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListEntitlementsResponse, Entitlement> ListEntitlementsAsync(ListEntitlementsRequest request, CallSettings callSettings = null)

List [Entitlement][google.cloud.channel.v1.Entitlement]s belonging to a customer.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.

Return Value: List of [Entitlement][google.cloud.channel.v1.Entitlement]s belonging to the customer, or empty list if there are none.

Parameters
NameDescription
requestListEntitlementsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListEntitlementsResponse, Entitlement>

A pageable asynchronous sequence of Entitlement resources.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
ListEntitlementsRequest request = new ListEntitlementsRequest
{
    ParentAsCustomerName = CustomerName.FromAccountCustomer("[ACCOUNT]", "[CUSTOMER]"),
};
// Make the request
PagedAsyncEnumerable<ListEntitlementsResponse, Entitlement> response = cloudChannelServiceClient.ListEntitlementsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Entitlement item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListEntitlementsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Entitlement item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Entitlement> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Entitlement item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListOffers(ListOffersRequest, CallSettings)

public virtual PagedEnumerable<ListOffersResponse, Offer> ListOffers(ListOffersRequest request, CallSettings callSettings = null)

Lists the Offers the reseller can sell.

Possible Error Codes:

  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
Parameters
NameDescription
requestListOffersRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListOffersResponse, Offer>

A pageable sequence of Offer resources.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.Create();
// Initialize request argument(s)
ListOffersRequest request = new ListOffersRequest
{
    Parent = "",
    Filter = "",
    LanguageCode = "",
};
// Make the request
PagedEnumerable<ListOffersResponse, Offer> response = cloudChannelServiceClient.ListOffers(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (Offer item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListOffersResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Offer item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Offer> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Offer item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListOffersAsync(ListOffersRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListOffersResponse, Offer> ListOffersAsync(ListOffersRequest request, CallSettings callSettings = null)

Lists the Offers the reseller can sell.

Possible Error Codes:

  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
Parameters
NameDescription
requestListOffersRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListOffersResponse, Offer>

A pageable asynchronous sequence of Offer resources.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
ListOffersRequest request = new ListOffersRequest
{
    Parent = "",
    Filter = "",
    LanguageCode = "",
};
// Make the request
PagedAsyncEnumerable<ListOffersResponse, Offer> response = cloudChannelServiceClient.ListOffersAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Offer item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListOffersResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Offer item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Offer> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Offer item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListProducts(ListProductsRequest, CallSettings)

public virtual PagedEnumerable<ListProductsResponse, Product> ListProducts(ListProductsRequest request, CallSettings callSettings = null)

Lists the Products the reseller is authorized to sell.

Possible Error Codes:

  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
Parameters
NameDescription
requestListProductsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListProductsResponse, Product>

A pageable sequence of Product resources.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.Create();
// Initialize request argument(s)
ListProductsRequest request = new ListProductsRequest
{
    Account = "",
    LanguageCode = "",
};
// Make the request
PagedEnumerable<ListProductsResponse, Product> response = cloudChannelServiceClient.ListProducts(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (Product item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListProductsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Product item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Product> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Product item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListProductsAsync(ListProductsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListProductsResponse, Product> ListProductsAsync(ListProductsRequest request, CallSettings callSettings = null)

Lists the Products the reseller is authorized to sell.

Possible Error Codes:

  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
Parameters
NameDescription
requestListProductsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListProductsResponse, Product>

A pageable asynchronous sequence of Product resources.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
ListProductsRequest request = new ListProductsRequest
{
    Account = "",
    LanguageCode = "",
};
// Make the request
PagedAsyncEnumerable<ListProductsResponse, Product> response = cloudChannelServiceClient.ListProductsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Product item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListProductsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Product item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Product> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Product item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListPurchasableOffers(ListPurchasableOffersRequest, CallSettings)

public virtual PagedEnumerable<ListPurchasableOffersResponse, PurchasableOffer> ListPurchasableOffers(ListPurchasableOffersRequest request, CallSettings callSettings = null)

Lists the Purchasable Offers for the following cases:

  • Offers that can be newly purchased for a customer
  • Offers that can be changed to, for an entitlement.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
Parameters
NameDescription
requestListPurchasableOffersRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListPurchasableOffersResponse, PurchasableOffer>

A pageable sequence of PurchasableOffer resources.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.Create();
// Initialize request argument(s)
ListPurchasableOffersRequest request = new ListPurchasableOffersRequest
{
    CustomerAsCustomerName = CustomerName.FromAccountCustomer("[ACCOUNT]", "[CUSTOMER]"),
    CreateEntitlementPurchase = new ListPurchasableOffersRequest.Types.CreateEntitlementPurchase(),
    ChangeOfferPurchase = new ListPurchasableOffersRequest.Types.ChangeOfferPurchase(),
    LanguageCode = "",
};
// Make the request
PagedEnumerable<ListPurchasableOffersResponse, PurchasableOffer> response = cloudChannelServiceClient.ListPurchasableOffers(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (PurchasableOffer item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListPurchasableOffersResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (PurchasableOffer item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<PurchasableOffer> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (PurchasableOffer item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListPurchasableOffersAsync(ListPurchasableOffersRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListPurchasableOffersResponse, PurchasableOffer> ListPurchasableOffersAsync(ListPurchasableOffersRequest request, CallSettings callSettings = null)

Lists the Purchasable Offers for the following cases:

  • Offers that can be newly purchased for a customer
  • Offers that can be changed to, for an entitlement.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
Parameters
NameDescription
requestListPurchasableOffersRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListPurchasableOffersResponse, PurchasableOffer>

A pageable asynchronous sequence of PurchasableOffer resources.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
ListPurchasableOffersRequest request = new ListPurchasableOffersRequest
{
    CustomerAsCustomerName = CustomerName.FromAccountCustomer("[ACCOUNT]", "[CUSTOMER]"),
    CreateEntitlementPurchase = new ListPurchasableOffersRequest.Types.CreateEntitlementPurchase(),
    ChangeOfferPurchase = new ListPurchasableOffersRequest.Types.ChangeOfferPurchase(),
    LanguageCode = "",
};
// Make the request
PagedAsyncEnumerable<ListPurchasableOffersResponse, PurchasableOffer> response = cloudChannelServiceClient.ListPurchasableOffersAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((PurchasableOffer item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListPurchasableOffersResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (PurchasableOffer item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<PurchasableOffer> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (PurchasableOffer item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListPurchasableSkus(ListPurchasableSkusRequest, CallSettings)

public virtual PagedEnumerable<ListPurchasableSkusResponse, PurchasableSku> ListPurchasableSkus(ListPurchasableSkusRequest request, CallSettings callSettings = null)

Lists the Purchasable SKUs for following cases:

  • SKUs that can be newly purchased for a customer
  • SKUs that can be upgraded/downgraded to, for an entitlement.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
Parameters
NameDescription
requestListPurchasableSkusRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListPurchasableSkusResponse, PurchasableSku>

A pageable sequence of PurchasableSku resources.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.Create();
// Initialize request argument(s)
ListPurchasableSkusRequest request = new ListPurchasableSkusRequest
{
    CustomerAsCustomerName = CustomerName.FromAccountCustomer("[ACCOUNT]", "[CUSTOMER]"),
    CreateEntitlementPurchase = new ListPurchasableSkusRequest.Types.CreateEntitlementPurchase(),
    ChangeOfferPurchase = new ListPurchasableSkusRequest.Types.ChangeOfferPurchase(),
    LanguageCode = "",
};
// Make the request
PagedEnumerable<ListPurchasableSkusResponse, PurchasableSku> response = cloudChannelServiceClient.ListPurchasableSkus(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (PurchasableSku item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListPurchasableSkusResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (PurchasableSku item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<PurchasableSku> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (PurchasableSku item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListPurchasableSkusAsync(ListPurchasableSkusRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListPurchasableSkusResponse, PurchasableSku> ListPurchasableSkusAsync(ListPurchasableSkusRequest request, CallSettings callSettings = null)

Lists the Purchasable SKUs for following cases:

  • SKUs that can be newly purchased for a customer
  • SKUs that can be upgraded/downgraded to, for an entitlement.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
Parameters
NameDescription
requestListPurchasableSkusRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListPurchasableSkusResponse, PurchasableSku>

A pageable asynchronous sequence of PurchasableSku resources.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
ListPurchasableSkusRequest request = new ListPurchasableSkusRequest
{
    CustomerAsCustomerName = CustomerName.FromAccountCustomer("[ACCOUNT]", "[CUSTOMER]"),
    CreateEntitlementPurchase = new ListPurchasableSkusRequest.Types.CreateEntitlementPurchase(),
    ChangeOfferPurchase = new ListPurchasableSkusRequest.Types.ChangeOfferPurchase(),
    LanguageCode = "",
};
// Make the request
PagedAsyncEnumerable<ListPurchasableSkusResponse, PurchasableSku> response = cloudChannelServiceClient.ListPurchasableSkusAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((PurchasableSku item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListPurchasableSkusResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (PurchasableSku item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<PurchasableSku> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (PurchasableSku item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListSkus(ListSkusRequest, CallSettings)

public virtual PagedEnumerable<ListSkusResponse, Sku> ListSkus(ListSkusRequest request, CallSettings callSettings = null)

Lists the SKUs for a product the reseller is authorized to sell.

Possible Error Codes:

  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
Parameters
NameDescription
requestListSkusRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListSkusResponse, Sku>

A pageable sequence of Sku resources.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.Create();
// Initialize request argument(s)
ListSkusRequest request = new ListSkusRequest
{
    ParentAsProductName = ProductName.FromProduct("[PRODUCT]"),
    Account = "",
    LanguageCode = "",
};
// Make the request
PagedEnumerable<ListSkusResponse, Sku> response = cloudChannelServiceClient.ListSkus(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (Sku item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListSkusResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Sku item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Sku> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Sku item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListSkusAsync(ListSkusRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListSkusResponse, Sku> ListSkusAsync(ListSkusRequest request, CallSettings callSettings = null)

Lists the SKUs for a product the reseller is authorized to sell.

Possible Error Codes:

  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
Parameters
NameDescription
requestListSkusRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListSkusResponse, Sku>

A pageable asynchronous sequence of Sku resources.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
ListSkusRequest request = new ListSkusRequest
{
    ParentAsProductName = ProductName.FromProduct("[PRODUCT]"),
    Account = "",
    LanguageCode = "",
};
// Make the request
PagedAsyncEnumerable<ListSkusResponse, Sku> response = cloudChannelServiceClient.ListSkusAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Sku item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListSkusResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Sku item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Sku> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Sku item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListSubscribers(ListSubscribersRequest, CallSettings)

public virtual PagedEnumerable<ListSubscribersResponse, string> ListSubscribers(ListSubscribersRequest request, CallSettings callSettings = null)

Lists service accounts with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account.

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being provided are different, or if the account is not a super admin.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: If the topic resource doesn't exist.
  • INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: List of service email addresses if successful, otherwise error is returned.

Parameters
NameDescription
requestListSubscribersRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListSubscribersResponse, String>

A pageable sequence of String resources.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.Create();
// Initialize request argument(s)
ListSubscribersRequest request = new ListSubscribersRequest { Account = "", };
// Make the request
PagedEnumerable<ListSubscribersResponse, string> response = cloudChannelServiceClient.ListSubscribers(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (string item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListSubscribersResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (string item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<string> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (string item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListSubscribersAsync(ListSubscribersRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListSubscribersResponse, string> ListSubscribersAsync(ListSubscribersRequest request, CallSettings callSettings = null)

Lists service accounts with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account.

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being provided are different, or if the account is not a super admin.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: If the topic resource doesn't exist.
  • INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: List of service email addresses if successful, otherwise error is returned.

Parameters
NameDescription
requestListSubscribersRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListSubscribersResponse, String>

A pageable asynchronous sequence of String resources.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
ListSubscribersRequest request = new ListSubscribersRequest { Account = "", };
// Make the request
PagedAsyncEnumerable<ListSubscribersResponse, string> response = cloudChannelServiceClient.ListSubscribersAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((string item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListSubscribersResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (string item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<string> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (string item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTransferableOffers(ListTransferableOffersRequest, CallSettings)

public virtual PagedEnumerable<ListTransferableOffersResponse, TransferableOffer> ListTransferableOffers(ListTransferableOffersRequest request, CallSettings callSettings = null)

List [TransferableOffer][google.cloud.channel.v1.TransferableOffer]s of a customer based on Cloud Identity ID or Customer Name in the request.

This method is used when a reseller gets the entitlement information of a customer that is not owned. The reseller should provide the customer's Cloud Identity ID or Customer Name.

Possible Error Codes:

  • PERMISSION_DENIED: Appears because of one of the following:
  • If the customer doesn't belong to the reseller and no auth token or invalid auth token is supplied.
  • If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.

Return Value: List of [TransferableOffer][google.cloud.channel.v1.TransferableOffer] for the given customer and SKU.

Parameters
NameDescription
requestListTransferableOffersRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListTransferableOffersResponse, TransferableOffer>

A pageable sequence of TransferableOffer resources.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.Create();
// Initialize request argument(s)
ListTransferableOffersRequest request = new ListTransferableOffersRequest
{
    Parent = "",
    CloudIdentityId = "",
    CustomerName = "",
    Sku = "",
    LanguageCode = "",
};
// Make the request
PagedEnumerable<ListTransferableOffersResponse, TransferableOffer> response = cloudChannelServiceClient.ListTransferableOffers(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (TransferableOffer item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListTransferableOffersResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TransferableOffer item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TransferableOffer> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TransferableOffer item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTransferableOffersAsync(ListTransferableOffersRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListTransferableOffersResponse, TransferableOffer> ListTransferableOffersAsync(ListTransferableOffersRequest request, CallSettings callSettings = null)

List [TransferableOffer][google.cloud.channel.v1.TransferableOffer]s of a customer based on Cloud Identity ID or Customer Name in the request.

This method is used when a reseller gets the entitlement information of a customer that is not owned. The reseller should provide the customer's Cloud Identity ID or Customer Name.

Possible Error Codes:

  • PERMISSION_DENIED: Appears because of one of the following:
  • If the customer doesn't belong to the reseller and no auth token or invalid auth token is supplied.
  • If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.

Return Value: List of [TransferableOffer][google.cloud.channel.v1.TransferableOffer] for the given customer and SKU.

Parameters
NameDescription
requestListTransferableOffersRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListTransferableOffersResponse, TransferableOffer>

A pageable asynchronous sequence of TransferableOffer resources.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
ListTransferableOffersRequest request = new ListTransferableOffersRequest
{
    Parent = "",
    CloudIdentityId = "",
    CustomerName = "",
    Sku = "",
    LanguageCode = "",
};
// Make the request
PagedAsyncEnumerable<ListTransferableOffersResponse, TransferableOffer> response = cloudChannelServiceClient.ListTransferableOffersAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((TransferableOffer item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListTransferableOffersResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TransferableOffer item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TransferableOffer> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TransferableOffer item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTransferableSkus(ListTransferableSkusRequest, CallSettings)

public virtual PagedEnumerable<ListTransferableSkusResponse, TransferableSku> ListTransferableSkus(ListTransferableSkusRequest request, CallSettings callSettings = null)

List [TransferableSku][google.cloud.channel.v1.TransferableSku]s of a customer based on Cloud Identity ID or Customer Name in the request.

This method is used when a reseller lists the entitlements information of a customer that is not owned. The reseller should provide the customer's Cloud Identity ID or Customer Name.

Possible Error Codes:

  • PERMISSION_DENIED: Appears because of one of the following -
  • The customer doesn't belong to the reseller and no auth token.
  • The supplied auth token is invalid.
  • The reseller account making the request and the queries reseller account are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.

Return Value: List of [TransferableSku][google.cloud.channel.v1.TransferableSku] for the given customer.

Parameters
NameDescription
requestListTransferableSkusRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListTransferableSkusResponse, TransferableSku>

A pageable sequence of TransferableSku resources.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.Create();
// Initialize request argument(s)
ListTransferableSkusRequest request = new ListTransferableSkusRequest
{
    Parent = "",
    CloudIdentityId = "",
    AuthToken = "",
    LanguageCode = "",
    CustomerName = "",
};
// Make the request
PagedEnumerable<ListTransferableSkusResponse, TransferableSku> response = cloudChannelServiceClient.ListTransferableSkus(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (TransferableSku item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListTransferableSkusResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TransferableSku item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TransferableSku> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TransferableSku item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTransferableSkusAsync(ListTransferableSkusRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListTransferableSkusResponse, TransferableSku> ListTransferableSkusAsync(ListTransferableSkusRequest request, CallSettings callSettings = null)

List [TransferableSku][google.cloud.channel.v1.TransferableSku]s of a customer based on Cloud Identity ID or Customer Name in the request.

This method is used when a reseller lists the entitlements information of a customer that is not owned. The reseller should provide the customer's Cloud Identity ID or Customer Name.

Possible Error Codes:

  • PERMISSION_DENIED: Appears because of one of the following -
  • The customer doesn't belong to the reseller and no auth token.
  • The supplied auth token is invalid.
  • The reseller account making the request and the queries reseller account are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.

Return Value: List of [TransferableSku][google.cloud.channel.v1.TransferableSku] for the given customer.

Parameters
NameDescription
requestListTransferableSkusRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListTransferableSkusResponse, TransferableSku>

A pageable asynchronous sequence of TransferableSku resources.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
ListTransferableSkusRequest request = new ListTransferableSkusRequest
{
    Parent = "",
    CloudIdentityId = "",
    AuthToken = "",
    LanguageCode = "",
    CustomerName = "",
};
// Make the request
PagedAsyncEnumerable<ListTransferableSkusResponse, TransferableSku> response = cloudChannelServiceClient.ListTransferableSkusAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((TransferableSku item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListTransferableSkusResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TransferableSku item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TransferableSku> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TransferableSku item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

PollOnceActivateEntitlement(String, CallSettings)

public virtual Operation<Entitlement, OperationMetadata> PollOnceActivateEntitlement(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of ActivateEntitlement .

Parameters
NameDescription
operationNameString

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Google.LongRunning.Operation<Entitlement, OperationMetadata>

The result of polling the operation.

PollOnceActivateEntitlementAsync(String, CallSettings)

public virtual Task<Operation<Entitlement, OperationMetadata>> PollOnceActivateEntitlementAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of ActivateEntitlement.

Parameters
NameDescription
operationNameString

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Google.LongRunning.Operation<Entitlement, OperationMetadata>>

A task representing the result of polling the operation.

PollOnceCancelEntitlement(String, CallSettings)

public virtual Operation<Empty, OperationMetadata> PollOnceCancelEntitlement(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of CancelEntitlement .

Parameters
NameDescription
operationNameString

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Google.LongRunning.Operation<Google.Protobuf.WellKnownTypes.Empty, OperationMetadata>

The result of polling the operation.

PollOnceCancelEntitlementAsync(String, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> PollOnceCancelEntitlementAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of CancelEntitlement.

Parameters
NameDescription
operationNameString

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Google.LongRunning.Operation<Google.Protobuf.WellKnownTypes.Empty, OperationMetadata>>

A task representing the result of polling the operation.

PollOnceChangeOffer(String, CallSettings)

public virtual Operation<Entitlement, OperationMetadata> PollOnceChangeOffer(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of ChangeOffer.

Parameters
NameDescription
operationNameString

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Google.LongRunning.Operation<Entitlement, OperationMetadata>

The result of polling the operation.

PollOnceChangeOfferAsync(String, CallSettings)

public virtual Task<Operation<Entitlement, OperationMetadata>> PollOnceChangeOfferAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of ChangeOffer.

Parameters
NameDescription
operationNameString

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Google.LongRunning.Operation<Entitlement, OperationMetadata>>

A task representing the result of polling the operation.

PollOnceChangeParameters(String, CallSettings)

public virtual Operation<Entitlement, OperationMetadata> PollOnceChangeParameters(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of ChangeParameters.

Parameters
NameDescription
operationNameString

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Google.LongRunning.Operation<Entitlement, OperationMetadata>

The result of polling the operation.

PollOnceChangeParametersAsync(String, CallSettings)

public virtual Task<Operation<Entitlement, OperationMetadata>> PollOnceChangeParametersAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of ChangeParameters.

Parameters
NameDescription
operationNameString

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Google.LongRunning.Operation<Entitlement, OperationMetadata>>

A task representing the result of polling the operation.

PollOnceChangeRenewalSettings(String, CallSettings)

public virtual Operation<Entitlement, OperationMetadata> PollOnceChangeRenewalSettings(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of ChangeRenewalSettings .

Parameters
NameDescription
operationNameString

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Google.LongRunning.Operation<Entitlement, OperationMetadata>

The result of polling the operation.

PollOnceChangeRenewalSettingsAsync(String, CallSettings)

public virtual Task<Operation<Entitlement, OperationMetadata>> PollOnceChangeRenewalSettingsAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of ChangeRenewalSettings.

Parameters
NameDescription
operationNameString

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Google.LongRunning.Operation<Entitlement, OperationMetadata>>

A task representing the result of polling the operation.

PollOnceCreateEntitlement(String, CallSettings)

public virtual Operation<Entitlement, OperationMetadata> PollOnceCreateEntitlement(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of CreateEntitlement .

Parameters
NameDescription
operationNameString

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Google.LongRunning.Operation<Entitlement, OperationMetadata>

The result of polling the operation.

PollOnceCreateEntitlementAsync(String, CallSettings)

public virtual Task<Operation<Entitlement, OperationMetadata>> PollOnceCreateEntitlementAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of CreateEntitlement.

Parameters
NameDescription
operationNameString

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Google.LongRunning.Operation<Entitlement, OperationMetadata>>

A task representing the result of polling the operation.

PollOnceProvisionCloudIdentity(String, CallSettings)

public virtual Operation<Customer, OperationMetadata> PollOnceProvisionCloudIdentity(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of ProvisionCloudIdentity.

Parameters
NameDescription
operationNameString

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Google.LongRunning.Operation<Customer, OperationMetadata>

The result of polling the operation.

PollOnceProvisionCloudIdentityAsync(String, CallSettings)

public virtual Task<Operation<Customer, OperationMetadata>> PollOnceProvisionCloudIdentityAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of ProvisionCloudIdentity.

Parameters
NameDescription
operationNameString

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Google.LongRunning.Operation<Customer, OperationMetadata>>

A task representing the result of polling the operation.

PollOnceStartPaidService(String, CallSettings)

public virtual Operation<Entitlement, OperationMetadata> PollOnceStartPaidService(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of StartPaidService.

Parameters
NameDescription
operationNameString

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Google.LongRunning.Operation<Entitlement, OperationMetadata>

The result of polling the operation.

PollOnceStartPaidServiceAsync(String, CallSettings)

public virtual Task<Operation<Entitlement, OperationMetadata>> PollOnceStartPaidServiceAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of StartPaidService.

Parameters
NameDescription
operationNameString

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Google.LongRunning.Operation<Entitlement, OperationMetadata>>

A task representing the result of polling the operation.

PollOnceSuspendEntitlement(String, CallSettings)

public virtual Operation<Entitlement, OperationMetadata> PollOnceSuspendEntitlement(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of SuspendEntitlement .

Parameters
NameDescription
operationNameString

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Google.LongRunning.Operation<Entitlement, OperationMetadata>

The result of polling the operation.

PollOnceSuspendEntitlementAsync(String, CallSettings)

public virtual Task<Operation<Entitlement, OperationMetadata>> PollOnceSuspendEntitlementAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of SuspendEntitlement.

Parameters
NameDescription
operationNameString

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Google.LongRunning.Operation<Entitlement, OperationMetadata>>

A task representing the result of polling the operation.

PollOnceTransferEntitlements(String, CallSettings)

public virtual Operation<TransferEntitlementsResponse, OperationMetadata> PollOnceTransferEntitlements(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of TransferEntitlements .

Parameters
NameDescription
operationNameString

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Google.LongRunning.Operation<TransferEntitlementsResponse, OperationMetadata>

The result of polling the operation.

PollOnceTransferEntitlementsAsync(String, CallSettings)

public virtual Task<Operation<TransferEntitlementsResponse, OperationMetadata>> PollOnceTransferEntitlementsAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of TransferEntitlements.

Parameters
NameDescription
operationNameString

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Google.LongRunning.Operation<TransferEntitlementsResponse, OperationMetadata>>

A task representing the result of polling the operation.

PollOnceTransferEntitlementsToGoogle(String, CallSettings)

public virtual Operation<Empty, OperationMetadata> PollOnceTransferEntitlementsToGoogle(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of TransferEntitlementsToGoogle.

Parameters
NameDescription
operationNameString

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Google.LongRunning.Operation<Google.Protobuf.WellKnownTypes.Empty, OperationMetadata>

The result of polling the operation.

PollOnceTransferEntitlementsToGoogleAsync(String, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> PollOnceTransferEntitlementsToGoogleAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of TransferEntitlementsToGoogle.

Parameters
NameDescription
operationNameString

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Google.LongRunning.Operation<Google.Protobuf.WellKnownTypes.Empty, OperationMetadata>>

A task representing the result of polling the operation.

ProvisionCloudIdentity(ProvisionCloudIdentityRequest, CallSettings)

public virtual Operation<Customer, OperationMetadata> ProvisionCloudIdentity(ProvisionCloudIdentityRequest request, CallSettings callSettings = null)

Creates a Cloud Identity for the given customer using the customer's information or the information provided here, if present.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: If the customer is not found for the reseller.
  • ALREADY_EXISTS: If the customer's primary email already exists. In this case, retry after changing the customer's primary contact email.
  • INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support in this case.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support in this case.

Return Value: Long Running Operation ID.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].

Parameters
NameDescription
requestProvisionCloudIdentityRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Google.LongRunning.Operation<Customer, OperationMetadata>

The RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.Create();
// Initialize request argument(s)
ProvisionCloudIdentityRequest request = new ProvisionCloudIdentityRequest
{
    CustomerAsCustomerName = CustomerName.FromAccountCustomer("[ACCOUNT]", "[CUSTOMER]"),
    CloudIdentityInfo = new CloudIdentityInfo(),
    User = new AdminUser(),
    ValidateOnly = false,
};
// Make the request
Operation<Customer, OperationMetadata> response = cloudChannelServiceClient.ProvisionCloudIdentity(request);

// Poll until the returned long-running operation is complete
Operation<Customer, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Customer result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Customer, OperationMetadata> retrievedResponse = cloudChannelServiceClient.PollOnceProvisionCloudIdentity(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Customer retrievedResult = retrievedResponse.Result;
}

ProvisionCloudIdentityAsync(ProvisionCloudIdentityRequest, CallSettings)

public virtual Task<Operation<Customer, OperationMetadata>> ProvisionCloudIdentityAsync(ProvisionCloudIdentityRequest request, CallSettings callSettings = null)

Creates a Cloud Identity for the given customer using the customer's information or the information provided here, if present.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: If the customer is not found for the reseller.
  • ALREADY_EXISTS: If the customer's primary email already exists. In this case, retry after changing the customer's primary contact email.
  • INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support in this case.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support in this case.

Return Value: Long Running Operation ID.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].

Parameters
NameDescription
requestProvisionCloudIdentityRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Google.LongRunning.Operation<Customer, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
ProvisionCloudIdentityRequest request = new ProvisionCloudIdentityRequest
{
    CustomerAsCustomerName = CustomerName.FromAccountCustomer("[ACCOUNT]", "[CUSTOMER]"),
    CloudIdentityInfo = new CloudIdentityInfo(),
    User = new AdminUser(),
    ValidateOnly = false,
};
// Make the request
Operation<Customer, OperationMetadata> response = await cloudChannelServiceClient.ProvisionCloudIdentityAsync(request);

// Poll until the returned long-running operation is complete
Operation<Customer, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Customer result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Customer, OperationMetadata> retrievedResponse = await cloudChannelServiceClient.PollOnceProvisionCloudIdentityAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Customer retrievedResult = retrievedResponse.Result;
}

ProvisionCloudIdentityAsync(ProvisionCloudIdentityRequest, CancellationToken)

public virtual Task<Operation<Customer, OperationMetadata>> ProvisionCloudIdentityAsync(ProvisionCloudIdentityRequest request, CancellationToken cancellationToken)

Creates a Cloud Identity for the given customer using the customer's information or the information provided here, if present.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: If the customer is not found for the reseller.
  • ALREADY_EXISTS: If the customer's primary email already exists. In this case, retry after changing the customer's primary contact email.
  • INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support in this case.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support in this case.

Return Value: Long Running Operation ID.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].

Parameters
NameDescription
requestProvisionCloudIdentityRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Google.LongRunning.Operation<Customer, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
ProvisionCloudIdentityRequest request = new ProvisionCloudIdentityRequest
{
    CustomerAsCustomerName = CustomerName.FromAccountCustomer("[ACCOUNT]", "[CUSTOMER]"),
    CloudIdentityInfo = new CloudIdentityInfo(),
    User = new AdminUser(),
    ValidateOnly = false,
};
// Make the request
Operation<Customer, OperationMetadata> response = await cloudChannelServiceClient.ProvisionCloudIdentityAsync(request);

// Poll until the returned long-running operation is complete
Operation<Customer, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Customer result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Customer, OperationMetadata> retrievedResponse = await cloudChannelServiceClient.PollOnceProvisionCloudIdentityAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Customer retrievedResult = retrievedResponse.Result;
}

RegisterSubscriber(RegisterSubscriberRequest, CallSettings)

public virtual RegisterSubscriberResponse RegisterSubscriber(RegisterSubscriberRequest request, CallSettings callSettings = null)

Registers a service account with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account. Once you create a subscriber, you will get the events as per [SubscriberEvent][google.cloud.channel.v1.SubscriberEvent]

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being provided are different, or if the impersonated user is not a super admin.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Topic name with service email address registered if successful, otherwise error is returned.

Parameters
NameDescription
requestRegisterSubscriberRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
RegisterSubscriberResponse

The RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.Create();
// Initialize request argument(s)
RegisterSubscriberRequest request = new RegisterSubscriberRequest
{
    Account = "",
    ServiceAccount = "",
};
// Make the request
RegisterSubscriberResponse response = cloudChannelServiceClient.RegisterSubscriber(request);

RegisterSubscriberAsync(RegisterSubscriberRequest, CallSettings)

public virtual Task<RegisterSubscriberResponse> RegisterSubscriberAsync(RegisterSubscriberRequest request, CallSettings callSettings = null)

Registers a service account with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account. Once you create a subscriber, you will get the events as per [SubscriberEvent][google.cloud.channel.v1.SubscriberEvent]

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being provided are different, or if the impersonated user is not a super admin.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Topic name with service email address registered if successful, otherwise error is returned.

Parameters
NameDescription
requestRegisterSubscriberRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<RegisterSubscriberResponse>

A Task containing the RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
RegisterSubscriberRequest request = new RegisterSubscriberRequest
{
    Account = "",
    ServiceAccount = "",
};
// Make the request
RegisterSubscriberResponse response = await cloudChannelServiceClient.RegisterSubscriberAsync(request);

RegisterSubscriberAsync(RegisterSubscriberRequest, CancellationToken)

public virtual Task<RegisterSubscriberResponse> RegisterSubscriberAsync(RegisterSubscriberRequest request, CancellationToken cancellationToken)

Registers a service account with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account. Once you create a subscriber, you will get the events as per [SubscriberEvent][google.cloud.channel.v1.SubscriberEvent]

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being provided are different, or if the impersonated user is not a super admin.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Topic name with service email address registered if successful, otherwise error is returned.

Parameters
NameDescription
requestRegisterSubscriberRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<RegisterSubscriberResponse>

A Task containing the RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
RegisterSubscriberRequest request = new RegisterSubscriberRequest
{
    Account = "",
    ServiceAccount = "",
};
// Make the request
RegisterSubscriberResponse response = await cloudChannelServiceClient.RegisterSubscriberAsync(request);

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
TypeDescription
Task

A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.

StartPaidService(StartPaidServiceRequest, CallSettings)

public virtual Operation<Entitlement, OperationMetadata> StartPaidService(StartPaidServiceRequest request, CallSettings callSettings = null)

Starts paid service for a trial entitlement.

Starts paid service for a trial entitlement immediately. This method is only applicable if a plan has already been set up for a trial entitlement but has some trial days remaining.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: Entitlement resource not found.
  • FAILED_PRECONDITION/NOT_IN_TRIAL: This method only works for entitlement on trial plans.
  • INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Long Running Operation ID.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].

Parameters
NameDescription
requestStartPaidServiceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Google.LongRunning.Operation<Entitlement, OperationMetadata>

The RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.Create();
// Initialize request argument(s)
StartPaidServiceRequest request = new StartPaidServiceRequest
{
    Name = "",
    RequestId = "",
};
// Make the request
Operation<Entitlement, OperationMetadata> response = cloudChannelServiceClient.StartPaidService(request);

// Poll until the returned long-running operation is complete
Operation<Entitlement, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Entitlement result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Entitlement, OperationMetadata> retrievedResponse = cloudChannelServiceClient.PollOnceStartPaidService(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Entitlement retrievedResult = retrievedResponse.Result;
}

StartPaidServiceAsync(StartPaidServiceRequest, CallSettings)

public virtual Task<Operation<Entitlement, OperationMetadata>> StartPaidServiceAsync(StartPaidServiceRequest request, CallSettings callSettings = null)

Starts paid service for a trial entitlement.

Starts paid service for a trial entitlement immediately. This method is only applicable if a plan has already been set up for a trial entitlement but has some trial days remaining.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: Entitlement resource not found.
  • FAILED_PRECONDITION/NOT_IN_TRIAL: This method only works for entitlement on trial plans.
  • INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Long Running Operation ID.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].

Parameters
NameDescription
requestStartPaidServiceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Google.LongRunning.Operation<Entitlement, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
StartPaidServiceRequest request = new StartPaidServiceRequest
{
    Name = "",
    RequestId = "",
};
// Make the request
Operation<Entitlement, OperationMetadata> response = await cloudChannelServiceClient.StartPaidServiceAsync(request);

// Poll until the returned long-running operation is complete
Operation<Entitlement, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Entitlement result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Entitlement, OperationMetadata> retrievedResponse = await cloudChannelServiceClient.PollOnceStartPaidServiceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Entitlement retrievedResult = retrievedResponse.Result;
}

StartPaidServiceAsync(StartPaidServiceRequest, CancellationToken)

public virtual Task<Operation<Entitlement, OperationMetadata>> StartPaidServiceAsync(StartPaidServiceRequest request, CancellationToken cancellationToken)

Starts paid service for a trial entitlement.

Starts paid service for a trial entitlement immediately. This method is only applicable if a plan has already been set up for a trial entitlement but has some trial days remaining.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: Entitlement resource not found.
  • FAILED_PRECONDITION/NOT_IN_TRIAL: This method only works for entitlement on trial plans.
  • INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Long Running Operation ID.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].

Parameters
NameDescription
requestStartPaidServiceRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Google.LongRunning.Operation<Entitlement, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
StartPaidServiceRequest request = new StartPaidServiceRequest
{
    Name = "",
    RequestId = "",
};
// Make the request
Operation<Entitlement, OperationMetadata> response = await cloudChannelServiceClient.StartPaidServiceAsync(request);

// Poll until the returned long-running operation is complete
Operation<Entitlement, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Entitlement result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Entitlement, OperationMetadata> retrievedResponse = await cloudChannelServiceClient.PollOnceStartPaidServiceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Entitlement retrievedResult = retrievedResponse.Result;
}

SuspendEntitlement(SuspendEntitlementRequest, CallSettings)

public virtual Operation<Entitlement, OperationMetadata> SuspendEntitlement(SuspendEntitlementRequest request, CallSettings callSettings = null)

Suspends a previously fulfilled entitlement. An entitlement suspension is a long-running operation.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: Entitlement resource not found.
  • NOT_ACTIVE: Entitlement is not active.
  • INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Long Running Operation ID.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].

Parameters
NameDescription
requestSuspendEntitlementRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Google.LongRunning.Operation<Entitlement, OperationMetadata>

The RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.Create();
// Initialize request argument(s)
SuspendEntitlementRequest request = new SuspendEntitlementRequest
{
    Name = "",
    RequestId = "",
};
// Make the request
Operation<Entitlement, OperationMetadata> response = cloudChannelServiceClient.SuspendEntitlement(request);

// Poll until the returned long-running operation is complete
Operation<Entitlement, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Entitlement result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Entitlement, OperationMetadata> retrievedResponse = cloudChannelServiceClient.PollOnceSuspendEntitlement(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Entitlement retrievedResult = retrievedResponse.Result;
}

SuspendEntitlementAsync(SuspendEntitlementRequest, CallSettings)

public virtual Task<Operation<Entitlement, OperationMetadata>> SuspendEntitlementAsync(SuspendEntitlementRequest request, CallSettings callSettings = null)

Suspends a previously fulfilled entitlement. An entitlement suspension is a long-running operation.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: Entitlement resource not found.
  • NOT_ACTIVE: Entitlement is not active.
  • INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Long Running Operation ID.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].

Parameters
NameDescription
requestSuspendEntitlementRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Google.LongRunning.Operation<Entitlement, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
SuspendEntitlementRequest request = new SuspendEntitlementRequest
{
    Name = "",
    RequestId = "",
};
// Make the request
Operation<Entitlement, OperationMetadata> response = await cloudChannelServiceClient.SuspendEntitlementAsync(request);

// Poll until the returned long-running operation is complete
Operation<Entitlement, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Entitlement result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Entitlement, OperationMetadata> retrievedResponse = await cloudChannelServiceClient.PollOnceSuspendEntitlementAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Entitlement retrievedResult = retrievedResponse.Result;
}

SuspendEntitlementAsync(SuspendEntitlementRequest, CancellationToken)

public virtual Task<Operation<Entitlement, OperationMetadata>> SuspendEntitlementAsync(SuspendEntitlementRequest request, CancellationToken cancellationToken)

Suspends a previously fulfilled entitlement. An entitlement suspension is a long-running operation.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: Entitlement resource not found.
  • NOT_ACTIVE: Entitlement is not active.
  • INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Long Running Operation ID.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].

Parameters
NameDescription
requestSuspendEntitlementRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Google.LongRunning.Operation<Entitlement, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
SuspendEntitlementRequest request = new SuspendEntitlementRequest
{
    Name = "",
    RequestId = "",
};
// Make the request
Operation<Entitlement, OperationMetadata> response = await cloudChannelServiceClient.SuspendEntitlementAsync(request);

// Poll until the returned long-running operation is complete
Operation<Entitlement, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Entitlement result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Entitlement, OperationMetadata> retrievedResponse = await cloudChannelServiceClient.PollOnceSuspendEntitlementAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Entitlement retrievedResult = retrievedResponse.Result;
}

TransferEntitlements(TransferEntitlementsRequest, CallSettings)

public virtual Operation<TransferEntitlementsResponse, OperationMetadata> TransferEntitlements(TransferEntitlementsRequest request, CallSettings callSettings = null)

Transfers customer entitlements to new reseller.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: If the customer or offer resource is not found for the reseller.
  • ALREADY_EXISTS: If the SKU has been already transferred for the customer.
  • CONDITION_NOT_MET or FAILED_PRECONDITION: This failure can happen in the following cases:
  • Transferring a SKU that requires domain verification and the domain has not been verified.
  • Transferring an Add-On SKU like Vault or Drive without transferring the pre-requisite SKU, such as G Suite Basic.
  • Applicable only for developer accounts: reseller and resold domain must follow the domain naming convention as follows:
  • Domain names must start with goog-test.
  • Resold domain names must include the reseller domain.
  • All transferring entitlements must be specified.
  • INTERNAL: Any non-user error related to a technical issue in the backend. Please contact Cloud Channel Support in this case.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. Please contact Cloud Channel Support in this case.

Return Value: Long Running Operation ID.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].

Parameters
NameDescription
requestTransferEntitlementsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Google.LongRunning.Operation<TransferEntitlementsResponse, OperationMetadata>

The RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.Create();
// Initialize request argument(s)
TransferEntitlementsRequest request = new TransferEntitlementsRequest
{
    Parent = "",
    Entitlements = { new Entitlement(), },
    AuthToken = "",
    RequestId = "",
};
// Make the request
Operation<TransferEntitlementsResponse, OperationMetadata> response = cloudChannelServiceClient.TransferEntitlements(request);

// Poll until the returned long-running operation is complete
Operation<TransferEntitlementsResponse, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
TransferEntitlementsResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<TransferEntitlementsResponse, OperationMetadata> retrievedResponse = cloudChannelServiceClient.PollOnceTransferEntitlements(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    TransferEntitlementsResponse retrievedResult = retrievedResponse.Result;
}

TransferEntitlementsAsync(TransferEntitlementsRequest, CallSettings)

public virtual Task<Operation<TransferEntitlementsResponse, OperationMetadata>> TransferEntitlementsAsync(TransferEntitlementsRequest request, CallSettings callSettings = null)

Transfers customer entitlements to new reseller.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: If the customer or offer resource is not found for the reseller.
  • ALREADY_EXISTS: If the SKU has been already transferred for the customer.
  • CONDITION_NOT_MET or FAILED_PRECONDITION: This failure can happen in the following cases:
  • Transferring a SKU that requires domain verification and the domain has not been verified.
  • Transferring an Add-On SKU like Vault or Drive without transferring the pre-requisite SKU, such as G Suite Basic.
  • Applicable only for developer accounts: reseller and resold domain must follow the domain naming convention as follows:
  • Domain names must start with goog-test.
  • Resold domain names must include the reseller domain.
  • All transferring entitlements must be specified.
  • INTERNAL: Any non-user error related to a technical issue in the backend. Please contact Cloud Channel Support in this case.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. Please contact Cloud Channel Support in this case.

Return Value: Long Running Operation ID.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].

Parameters
NameDescription
requestTransferEntitlementsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Google.LongRunning.Operation<TransferEntitlementsResponse, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
TransferEntitlementsRequest request = new TransferEntitlementsRequest
{
    Parent = "",
    Entitlements = { new Entitlement(), },
    AuthToken = "",
    RequestId = "",
};
// Make the request
Operation<TransferEntitlementsResponse, OperationMetadata> response = await cloudChannelServiceClient.TransferEntitlementsAsync(request);

// Poll until the returned long-running operation is complete
Operation<TransferEntitlementsResponse, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
TransferEntitlementsResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<TransferEntitlementsResponse, OperationMetadata> retrievedResponse = await cloudChannelServiceClient.PollOnceTransferEntitlementsAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    TransferEntitlementsResponse retrievedResult = retrievedResponse.Result;
}

TransferEntitlementsAsync(TransferEntitlementsRequest, CancellationToken)

public virtual Task<Operation<TransferEntitlementsResponse, OperationMetadata>> TransferEntitlementsAsync(TransferEntitlementsRequest request, CancellationToken cancellationToken)

Transfers customer entitlements to new reseller.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: If the customer or offer resource is not found for the reseller.
  • ALREADY_EXISTS: If the SKU has been already transferred for the customer.
  • CONDITION_NOT_MET or FAILED_PRECONDITION: This failure can happen in the following cases:
  • Transferring a SKU that requires domain verification and the domain has not been verified.
  • Transferring an Add-On SKU like Vault or Drive without transferring the pre-requisite SKU, such as G Suite Basic.
  • Applicable only for developer accounts: reseller and resold domain must follow the domain naming convention as follows:
  • Domain names must start with goog-test.
  • Resold domain names must include the reseller domain.
  • All transferring entitlements must be specified.
  • INTERNAL: Any non-user error related to a technical issue in the backend. Please contact Cloud Channel Support in this case.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. Please contact Cloud Channel Support in this case.

Return Value: Long Running Operation ID.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].

Parameters
NameDescription
requestTransferEntitlementsRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Google.LongRunning.Operation<TransferEntitlementsResponse, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
TransferEntitlementsRequest request = new TransferEntitlementsRequest
{
    Parent = "",
    Entitlements = { new Entitlement(), },
    AuthToken = "",
    RequestId = "",
};
// Make the request
Operation<TransferEntitlementsResponse, OperationMetadata> response = await cloudChannelServiceClient.TransferEntitlementsAsync(request);

// Poll until the returned long-running operation is complete
Operation<TransferEntitlementsResponse, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
TransferEntitlementsResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<TransferEntitlementsResponse, OperationMetadata> retrievedResponse = await cloudChannelServiceClient.PollOnceTransferEntitlementsAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    TransferEntitlementsResponse retrievedResult = retrievedResponse.Result;
}

TransferEntitlementsToGoogle(TransferEntitlementsToGoogleRequest, CallSettings)

public virtual Operation<Empty, OperationMetadata> TransferEntitlementsToGoogle(TransferEntitlementsToGoogleRequest request, CallSettings callSettings = null)

Transfers customer entitlements from current reseller to Google.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: If the customer or offer resource is not found for the reseller.
  • ALREADY_EXISTS: If the SKU has been already transferred for the customer.
  • CONDITION_NOT_MET or FAILED_PRECONDITION: This failure can happen in the following cases:
  • Transferring a SKU that requires domain verification and the domain has not been verified.
  • Transferring an Add-On SKU like Vault or Drive without purchasing the pre-requisite SKU, such as G Suite Basic.
  • Applicable only for developer accounts: reseller and resold domain must follow the domain naming convention as follows:
  • Domain names must start with goog-test.
  • Resold domain names must include the reseller domain.
  • INTERNAL: Any non-user error related to a technical issue in the backend. Please contact Cloud Channel Support in this case.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. Please contact Cloud Channel Support in this case.

Return Value: Long Running Operation ID.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The response will contain google.protobuf.Empty on success. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].

Parameters
NameDescription
requestTransferEntitlementsToGoogleRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Google.LongRunning.Operation<Google.Protobuf.WellKnownTypes.Empty, OperationMetadata>

The RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.Create();
// Initialize request argument(s)
TransferEntitlementsToGoogleRequest request = new TransferEntitlementsToGoogleRequest
{
    Parent = "",
    Entitlements = { new Entitlement(), },
    RequestId = "",
};
// Make the request
Operation<Empty, OperationMetadata> response = cloudChannelServiceClient.TransferEntitlementsToGoogle(request);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = cloudChannelServiceClient.PollOnceTransferEntitlementsToGoogle(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

TransferEntitlementsToGoogleAsync(TransferEntitlementsToGoogleRequest, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> TransferEntitlementsToGoogleAsync(TransferEntitlementsToGoogleRequest request, CallSettings callSettings = null)

Transfers customer entitlements from current reseller to Google.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: If the customer or offer resource is not found for the reseller.
  • ALREADY_EXISTS: If the SKU has been already transferred for the customer.
  • CONDITION_NOT_MET or FAILED_PRECONDITION: This failure can happen in the following cases:
  • Transferring a SKU that requires domain verification and the domain has not been verified.
  • Transferring an Add-On SKU like Vault or Drive without purchasing the pre-requisite SKU, such as G Suite Basic.
  • Applicable only for developer accounts: reseller and resold domain must follow the domain naming convention as follows:
  • Domain names must start with goog-test.
  • Resold domain names must include the reseller domain.
  • INTERNAL: Any non-user error related to a technical issue in the backend. Please contact Cloud Channel Support in this case.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. Please contact Cloud Channel Support in this case.

Return Value: Long Running Operation ID.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The response will contain google.protobuf.Empty on success. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].

Parameters
NameDescription
requestTransferEntitlementsToGoogleRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Google.LongRunning.Operation<Google.Protobuf.WellKnownTypes.Empty, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
TransferEntitlementsToGoogleRequest request = new TransferEntitlementsToGoogleRequest
{
    Parent = "",
    Entitlements = { new Entitlement(), },
    RequestId = "",
};
// Make the request
Operation<Empty, OperationMetadata> response = await cloudChannelServiceClient.TransferEntitlementsToGoogleAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await cloudChannelServiceClient.PollOnceTransferEntitlementsToGoogleAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

TransferEntitlementsToGoogleAsync(TransferEntitlementsToGoogleRequest, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> TransferEntitlementsToGoogleAsync(TransferEntitlementsToGoogleRequest request, CancellationToken cancellationToken)

Transfers customer entitlements from current reseller to Google.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: If the customer or offer resource is not found for the reseller.
  • ALREADY_EXISTS: If the SKU has been already transferred for the customer.
  • CONDITION_NOT_MET or FAILED_PRECONDITION: This failure can happen in the following cases:
  • Transferring a SKU that requires domain verification and the domain has not been verified.
  • Transferring an Add-On SKU like Vault or Drive without purchasing the pre-requisite SKU, such as G Suite Basic.
  • Applicable only for developer accounts: reseller and resold domain must follow the domain naming convention as follows:
  • Domain names must start with goog-test.
  • Resold domain names must include the reseller domain.
  • INTERNAL: Any non-user error related to a technical issue in the backend. Please contact Cloud Channel Support in this case.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. Please contact Cloud Channel Support in this case.

Return Value: Long Running Operation ID.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The response will contain google.protobuf.Empty on success. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].

Parameters
NameDescription
requestTransferEntitlementsToGoogleRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Google.LongRunning.Operation<Google.Protobuf.WellKnownTypes.Empty, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
TransferEntitlementsToGoogleRequest request = new TransferEntitlementsToGoogleRequest
{
    Parent = "",
    Entitlements = { new Entitlement(), },
    RequestId = "",
};
// Make the request
Operation<Empty, OperationMetadata> response = await cloudChannelServiceClient.TransferEntitlementsToGoogleAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await cloudChannelServiceClient.PollOnceTransferEntitlementsToGoogleAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

UnregisterSubscriber(UnregisterSubscriberRequest, CallSettings)

public virtual UnregisterSubscriberResponse UnregisterSubscriber(UnregisterSubscriberRequest request, CallSettings callSettings = null)

Unregisters a service account with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account. If there are no more service account left with sunbscriber privileges, the topic will be deleted. You can check this by calling ListSubscribers api.

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being provided are different, or if the impersonated user is not a super admin.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: If the topic resource doesn't exist.
  • INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Topic name from which service email address has been unregistered if successful, otherwise error is returned. If the service email was already not associated with the topic, the success response will be returned.

Parameters
NameDescription
requestUnregisterSubscriberRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
UnregisterSubscriberResponse

The RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.Create();
// Initialize request argument(s)
UnregisterSubscriberRequest request = new UnregisterSubscriberRequest
{
    Account = "",
    ServiceAccount = "",
};
// Make the request
UnregisterSubscriberResponse response = cloudChannelServiceClient.UnregisterSubscriber(request);

UnregisterSubscriberAsync(UnregisterSubscriberRequest, CallSettings)

public virtual Task<UnregisterSubscriberResponse> UnregisterSubscriberAsync(UnregisterSubscriberRequest request, CallSettings callSettings = null)

Unregisters a service account with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account. If there are no more service account left with sunbscriber privileges, the topic will be deleted. You can check this by calling ListSubscribers api.

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being provided are different, or if the impersonated user is not a super admin.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: If the topic resource doesn't exist.
  • INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Topic name from which service email address has been unregistered if successful, otherwise error is returned. If the service email was already not associated with the topic, the success response will be returned.

Parameters
NameDescription
requestUnregisterSubscriberRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<UnregisterSubscriberResponse>

A Task containing the RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
UnregisterSubscriberRequest request = new UnregisterSubscriberRequest
{
    Account = "",
    ServiceAccount = "",
};
// Make the request
UnregisterSubscriberResponse response = await cloudChannelServiceClient.UnregisterSubscriberAsync(request);

UnregisterSubscriberAsync(UnregisterSubscriberRequest, CancellationToken)

public virtual Task<UnregisterSubscriberResponse> UnregisterSubscriberAsync(UnregisterSubscriberRequest request, CancellationToken cancellationToken)

Unregisters a service account with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account. If there are no more service account left with sunbscriber privileges, the topic will be deleted. You can check this by calling ListSubscribers api.

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being provided are different, or if the impersonated user is not a super admin.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: If the topic resource doesn't exist.
  • INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Topic name from which service email address has been unregistered if successful, otherwise error is returned. If the service email was already not associated with the topic, the success response will be returned.

Parameters
NameDescription
requestUnregisterSubscriberRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<UnregisterSubscriberResponse>

A Task containing the RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
UnregisterSubscriberRequest request = new UnregisterSubscriberRequest
{
    Account = "",
    ServiceAccount = "",
};
// Make the request
UnregisterSubscriberResponse response = await cloudChannelServiceClient.UnregisterSubscriberAsync(request);
public virtual ChannelPartnerLink UpdateChannelPartnerLink(UpdateChannelPartnerLinkRequest request, CallSettings callSettings = null)

Updates a channel partner link. A distributor calls this method to change a link's status. For example, suspend a partner link. To call this method, you must be a distributor.

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: It can happen in following scenarios -
  • Missing or invalid required parameters in the request.
  • Updating link state from invited to active or suspended.
  • Sending 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. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: If successful, the updated [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource, otherwise returns an error.

Parameters
NameDescription
requestUpdateChannelPartnerLinkRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ChannelPartnerLink

The RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.Create();
// Initialize request argument(s)
UpdateChannelPartnerLinkRequest request = new UpdateChannelPartnerLinkRequest
{
    Name = "",
    ChannelPartnerLink = new ChannelPartnerLink(),
    UpdateMask = new FieldMask(),
};
// Make the request
ChannelPartnerLink response = cloudChannelServiceClient.UpdateChannelPartnerLink(request);

UpdateChannelPartnerLinkAsync(UpdateChannelPartnerLinkRequest, CallSettings)

public virtual Task<ChannelPartnerLink> UpdateChannelPartnerLinkAsync(UpdateChannelPartnerLinkRequest request, CallSettings callSettings = null)

Updates a channel partner link. A distributor calls this method to change a link's status. For example, suspend a partner link. To call this method, you must be a distributor.

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: It can happen in following scenarios -
  • Missing or invalid required parameters in the request.
  • Updating link state from invited to active or suspended.
  • Sending 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. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: If successful, the updated [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource, otherwise returns an error.

Parameters
NameDescription
requestUpdateChannelPartnerLinkRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<ChannelPartnerLink>

A Task containing the RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateChannelPartnerLinkRequest request = new UpdateChannelPartnerLinkRequest
{
    Name = "",
    ChannelPartnerLink = new ChannelPartnerLink(),
    UpdateMask = new FieldMask(),
};
// Make the request
ChannelPartnerLink response = await cloudChannelServiceClient.UpdateChannelPartnerLinkAsync(request);

UpdateChannelPartnerLinkAsync(UpdateChannelPartnerLinkRequest, CancellationToken)

public virtual Task<ChannelPartnerLink> UpdateChannelPartnerLinkAsync(UpdateChannelPartnerLinkRequest request, CancellationToken cancellationToken)

Updates a channel partner link. A distributor calls this method to change a link's status. For example, suspend a partner link. To call this method, you must be a distributor.

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: It can happen in following scenarios -
  • Missing or invalid required parameters in the request.
  • Updating link state from invited to active or suspended.
  • Sending 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. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: If successful, the updated [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource, otherwise returns an error.

Parameters
NameDescription
requestUpdateChannelPartnerLinkRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<ChannelPartnerLink>

A Task containing the RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateChannelPartnerLinkRequest request = new UpdateChannelPartnerLinkRequest
{
    Name = "",
    ChannelPartnerLink = new ChannelPartnerLink(),
    UpdateMask = new FieldMask(),
};
// Make the request
ChannelPartnerLink response = await cloudChannelServiceClient.UpdateChannelPartnerLinkAsync(request);

UpdateCustomer(UpdateCustomerRequest, CallSettings)

public virtual Customer UpdateCustomer(UpdateCustomerRequest request, CallSettings callSettings = null)

Updates an existing [Customer][google.cloud.channel.v1.Customer] resource belonging to the reseller or distributor.

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: No [Customer][google.cloud.channel.v1.Customer] resource found for the name specified in the request.

Return Value: If successful, the updated [Customer][google.cloud.channel.v1.Customer] resource, otherwise returns an error.

Parameters
NameDescription
requestUpdateCustomerRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Customer

The RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.Create();
// Initialize request argument(s)
UpdateCustomerRequest request = new UpdateCustomerRequest
{
    Customer = new Customer(),
    UpdateMask = new FieldMask(),
};
// Make the request
Customer response = cloudChannelServiceClient.UpdateCustomer(request);

UpdateCustomerAsync(UpdateCustomerRequest, CallSettings)

public virtual Task<Customer> UpdateCustomerAsync(UpdateCustomerRequest request, CallSettings callSettings = null)

Updates an existing [Customer][google.cloud.channel.v1.Customer] resource belonging to the reseller or distributor.

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: No [Customer][google.cloud.channel.v1.Customer] resource found for the name specified in the request.

Return Value: If successful, the updated [Customer][google.cloud.channel.v1.Customer] resource, otherwise returns an error.

Parameters
NameDescription
requestUpdateCustomerRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Customer>

A Task containing the RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateCustomerRequest request = new UpdateCustomerRequest
{
    Customer = new Customer(),
    UpdateMask = new FieldMask(),
};
// Make the request
Customer response = await cloudChannelServiceClient.UpdateCustomerAsync(request);

UpdateCustomerAsync(UpdateCustomerRequest, CancellationToken)

public virtual Task<Customer> UpdateCustomerAsync(UpdateCustomerRequest request, CancellationToken cancellationToken)

Updates an existing [Customer][google.cloud.channel.v1.Customer] resource belonging to the reseller or distributor.

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: No [Customer][google.cloud.channel.v1.Customer] resource found for the name specified in the request.

Return Value: If successful, the updated [Customer][google.cloud.channel.v1.Customer] resource, otherwise returns an error.

Parameters
NameDescription
requestUpdateCustomerRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Customer>

A Task containing the RPC response.

Example
// Create client
CloudChannelServiceClient cloudChannelServiceClient = await CloudChannelServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateCustomerRequest request = new UpdateCustomerRequest
{
    Customer = new Customer(),
    UpdateMask = new FieldMask(),
};
// Make the request
Customer response = await cloudChannelServiceClient.UpdateCustomerAsync(request);