Cloud Channel v1 API - Class CloudChannelServiceClient (2.9.0)

public abstract class CloudChannelServiceClient

Reference documentation and code samples for the Cloud Channel v1 API class CloudChannelServiceClient.

CloudChannelService client wrapper, for convenient use.

Inheritance

object > CloudChannelServiceClient

Namespace

Google.Cloud.Channel.V1

Assembly

Google.Cloud.Channel.V1.dll

Remarks

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

Using this service:

  1. Resellers and distributors can manage a customer entity.
  2. Distributors can register an authorized reseller in their channel and provide them with delegated admin access.
  3. Resellers and distributors can manage customer entitlements.

CloudChannelService exposes the following resources:

  • [Customer][google.cloud.channel.v1.Customer]s: An entity-usually an enterprise-managed by a reseller or distributor.

  • [Entitlement][google.cloud.channel.v1.Entitlement]s: An entity that provides a customer with the means to use a service. Entitlements are created or updated as a result of a successful fulfillment.

  • [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink]s: 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
OperationsClient

CancelEntitlementOperationsClient

public virtual OperationsClient CancelEntitlementOperationsClient { get; }

The long-running operations client for CancelEntitlement.

Property Value
TypeDescription
OperationsClient

ChangeOfferOperationsClient

public virtual OperationsClient ChangeOfferOperationsClient { get; }

The long-running operations client for ChangeOffer.

Property Value
TypeDescription
OperationsClient

ChangeParametersOperationsClient

public virtual OperationsClient ChangeParametersOperationsClient { get; }

The long-running operations client for ChangeParameters.

Property Value
TypeDescription
OperationsClient

ChangeRenewalSettingsOperationsClient

public virtual OperationsClient ChangeRenewalSettingsOperationsClient { get; }

The long-running operations client for ChangeRenewalSettings.

Property Value
TypeDescription
OperationsClient

CreateEntitlementOperationsClient

public virtual OperationsClient CreateEntitlementOperationsClient { get; }

The long-running operations client for CreateEntitlement.

Property Value
TypeDescription
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
IReadOnlyListstring
Remarks

The default CloudChannelService scopes are:

GrpcClient

public virtual CloudChannelService.CloudChannelServiceClient GrpcClient { get; }

The underlying gRPC CloudChannelService client

Property Value
TypeDescription
CloudChannelServiceCloudChannelServiceClient

ProvisionCloudIdentityOperationsClient

public virtual OperationsClient ProvisionCloudIdentityOperationsClient { get; }

The long-running operations client for ProvisionCloudIdentity.

Property Value
TypeDescription
OperationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
TypeDescription
ServiceMetadata

StartPaidServiceOperationsClient

public virtual OperationsClient StartPaidServiceOperationsClient { get; }

The long-running operations client for StartPaidService.

Property Value
TypeDescription
OperationsClient

SuspendEntitlementOperationsClient

public virtual OperationsClient SuspendEntitlementOperationsClient { get; }

The long-running operations client for SuspendEntitlement.

Property Value
TypeDescription
OperationsClient

TransferEntitlementsOperationsClient

public virtual OperationsClient TransferEntitlementsOperationsClient { get; }

The long-running operations client for TransferEntitlements.

Property Value
TypeDescription
OperationsClient

TransferEntitlementsToGoogleOperationsClient

public virtual OperationsClient TransferEntitlementsToGoogleOperationsClient { get; }

The long-running operations client for TransferEntitlementsToGoogle.

Property Value
TypeDescription
OperationsClient

Methods

ActivateEntitlement(ActivateEntitlementRequest, CallSettings)

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

Activates a previously suspended entitlement. Entitlements suspended for pending ToS acceptance can't be activated using this method.

An entitlement activation is a long-running operation and it updates the state of the customer entitlement.

Possible error codes:

  • PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.
  • INVALID_ARGUMENT: Required request parameters are missing or invalid.
  • NOT_FOUND: Entitlement resource not found.
  • SUSPENSION_NOT_RESELLER_INITIATED: Can only activate reseller-initiated suspensions and entitlements that have accepted the TOS.
  • NOT_SUSPENDED: Can only activate suspended entitlements not in an ACTIVE state.
  • INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

Return value: The ID of a long-running operation.

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
OperationEntitlementOperationMetadata

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. Entitlements suspended for pending ToS acceptance can't be activated using this method.

An entitlement activation is a long-running operation and it updates the state of the customer entitlement.

Possible error codes:

  • PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.
  • INVALID_ARGUMENT: Required request parameters are missing or invalid.
  • NOT_FOUND: Entitlement resource not found.
  • SUSPENSION_NOT_RESELLER_INITIATED: Can only activate reseller-initiated suspensions and entitlements that have accepted the TOS.
  • NOT_SUSPENDED: Can only activate suspended entitlements not in an ACTIVE state.
  • INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

Return value: The ID of a long-running operation.

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
TaskOperationEntitlementOperationMetadata

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. Entitlements suspended for pending ToS acceptance can't be activated using this method.

An entitlement activation is a long-running operation and it updates the state of the customer entitlement.

Possible error codes:

  • PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.
  • INVALID_ARGUMENT: Required request parameters are missing or invalid.
  • NOT_FOUND: Entitlement resource not found.
  • SUSPENSION_NOT_RESELLER_INITIATED: Can only activate reseller-initiated suspensions and entitlements that have accepted the TOS.
  • NOT_SUSPENDED: Can only activate suspended entitlements not in an ACTIVE state.
  • INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

Return value: The ID of a long-running operation.

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
TaskOperationEntitlementOperationMetadata

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: The reseller account making the request is different from the reseller account in the API request.
  • FAILED_PRECONDITION: There are Google Cloud projects linked to the Google Cloud entitlement's Cloud Billing subaccount.
  • INVALID_ARGUMENT: Required request parameters are missing or invalid.
  • 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. Contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

Return value: The ID of a long-running operation.

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
OperationEmptyOperationMetadata

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: The reseller account making the request is different from the reseller account in the API request.
  • FAILED_PRECONDITION: There are Google Cloud projects linked to the Google Cloud entitlement's Cloud Billing subaccount.
  • INVALID_ARGUMENT: Required request parameters are missing or invalid.
  • 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. Contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

Return value: The ID of a long-running operation.

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
TaskOperationEmptyOperationMetadata

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: The reseller account making the request is different from the reseller account in the API request.
  • FAILED_PRECONDITION: There are Google Cloud projects linked to the Google Cloud entitlement's Cloud Billing subaccount.
  • INVALID_ARGUMENT: Required request parameters are missing or invalid.
  • 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. Contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

Return value: The ID of a long-running operation.

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
TaskOperationEmptyOperationMetadata

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 it updates the entitlement as a result of fulfillment.

Possible error codes:

  • PERMISSION_DENIED: The customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Required request parameters are missing or invalid.
  • NOT_FOUND: Offer or Entitlement resource not found.
  • INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

Return value: The ID of a long-running operation.

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
OperationEntitlementOperationMetadata

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 = "",
    BillingAccount = "",
};
// 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 it updates the entitlement as a result of fulfillment.

Possible error codes:

  • PERMISSION_DENIED: The customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Required request parameters are missing or invalid.
  • NOT_FOUND: Offer or Entitlement resource not found.
  • INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

Return value: The ID of a long-running operation.

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
TaskOperationEntitlementOperationMetadata

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 = "",
    BillingAccount = "",
};
// 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 it updates the entitlement as a result of fulfillment.

Possible error codes:

  • PERMISSION_DENIED: The customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Required request parameters are missing or invalid.
  • NOT_FOUND: Offer or Entitlement resource not found.
  • INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

Return value: The ID of a long-running operation.

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
TaskOperationEntitlementOperationMetadata

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 = "",
    BillingAccount = "",
};
// 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 update is a long-running operation and it updates the entitlement as a result of fulfillment.

Possible error codes:

  • PERMISSION_DENIED: The customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Required request parameters are missing or invalid. For example, the number of seats being changed is greater than the allowed number of max seats, 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. Contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

Return value: The ID of a long-running operation.

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
OperationEntitlementOperationMetadata

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 update is a long-running operation and it updates the entitlement as a result of fulfillment.

Possible error codes:

  • PERMISSION_DENIED: The customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Required request parameters are missing or invalid. For example, the number of seats being changed is greater than the allowed number of max seats, 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. Contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

Return value: The ID of a long-running operation.

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
TaskOperationEntitlementOperationMetadata

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 update is a long-running operation and it updates the entitlement as a result of fulfillment.

Possible error codes:

  • PERMISSION_DENIED: The customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Required request parameters are missing or invalid. For example, the number of seats being changed is greater than the allowed number of max seats, 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. Contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

Return value: The ID of a long-running operation.

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
TaskOperationEntitlementOperationMetadata

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 it updates the entitlement as a result of fulfillment.

Possible error codes:

  • PERMISSION_DENIED: The customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Required request parameters are missing or invalid.
  • NOT_FOUND: Entitlement resource not found.
  • NOT_COMMITMENT_PLAN: Renewal Settings are only applicable for a commitment plan. Can't enable or disable renewals for non-commitment plans.
  • INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

Return value: The ID of a long-running operation.

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
OperationEntitlementOperationMetadata

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)