Class CloudChannelServiceStubSettings (3.62.0)

public class CloudChannelServiceStubSettings extends StubSettings<CloudChannelServiceStubSettings>

Settings class to configure an instance of CloudChannelServiceStub.

The default instance has everything set to sensible defaults:

  • The default service address (cloudchannel.googleapis.com) and default port (443) are used.
  • Credentials are acquired automatically through Application Default Credentials.
  • Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the RetrySettings of getCustomer:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 CloudChannelServiceStubSettings.Builder cloudChannelServiceSettingsBuilder =
     CloudChannelServiceStubSettings.newBuilder();
 cloudChannelServiceSettingsBuilder
     .getCustomerSettings()
     .setRetrySettings(
         cloudChannelServiceSettingsBuilder
             .getCustomerSettings()
             .getRetrySettings()
             .toBuilder()
             .setInitialRetryDelayDuration(Duration.ofSeconds(1))
             .setInitialRpcTimeoutDuration(Duration.ofSeconds(5))
             .setMaxAttempts(5)
             .setMaxRetryDelayDuration(Duration.ofSeconds(30))
             .setMaxRpcTimeoutDuration(Duration.ofSeconds(60))
             .setRetryDelayMultiplier(1.3)
             .setRpcTimeoutMultiplier(1.5)
             .setTotalTimeoutDuration(Duration.ofSeconds(300))
             .build());
 CloudChannelServiceStubSettings cloudChannelServiceSettings =
     cloudChannelServiceSettingsBuilder.build();
 

Please refer to the Client Side Retry Guide for additional support in setting retries.

To configure the RetrySettings of a Long Running Operation method, create an OperationTimedPollAlgorithm object and update the RPC's polling algorithm. For example, to configure the RetrySettings for provisionCloudIdentity:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 CloudChannelServiceStubSettings.Builder cloudChannelServiceSettingsBuilder =
     CloudChannelServiceStubSettings.newBuilder();
 TimedRetryAlgorithm timedRetryAlgorithm =
     OperationalTimedPollAlgorithm.create(
         RetrySettings.newBuilder()
             .setInitialRetryDelayDuration(Duration.ofMillis(500))
             .setRetryDelayMultiplier(1.5)
             .setMaxRetryDelayDuration(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 cloudChannelServiceSettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();
 

Inheritance

java.lang.Object > StubSettings > CloudChannelServiceStubSettings

Static Methods

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
Type Description
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
Type Description
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
Type Description
Builder

defaultGrpcApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder()
Returns
Type Description
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default gRPC ChannelProvider for this service.

Returns
Type Description
Builder

defaultHttpJsonApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()
Returns
Type Description
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default REST ChannelProvider for this service.

Returns
Type Description
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
Type Description
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
Type Description
String

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

Returns
Type Description
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
Type Description
List<String>

newBuilder()

public static CloudChannelServiceStubSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type Description
CloudChannelServiceStubSettings.Builder

newBuilder(ClientContext clientContext)

public static CloudChannelServiceStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
CloudChannelServiceStubSettings.Builder

newHttpJsonBuilder()

public static CloudChannelServiceStubSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
CloudChannelServiceStubSettings.Builder

Constructors

CloudChannelServiceStubSettings(CloudChannelServiceStubSettings.Builder settingsBuilder)

protected CloudChannelServiceStubSettings(CloudChannelServiceStubSettings.Builder settingsBuilder)
Parameter
Name Description
settingsBuilder CloudChannelServiceStubSettings.Builder

Methods

activateEntitlementOperationSettings()

public OperationCallSettings<ActivateEntitlementRequest,Entitlement,OperationMetadata> activateEntitlementOperationSettings()

Returns the object with the settings used for calls to activateEntitlement.

activateEntitlementSettings()

public UnaryCallSettings<ActivateEntitlementRequest,Operation> activateEntitlementSettings()

Returns the object with the settings used for calls to activateEntitlement.

cancelEntitlementOperationSettings()

public OperationCallSettings<CancelEntitlementRequest,Empty,OperationMetadata> cancelEntitlementOperationSettings()

Returns the object with the settings used for calls to cancelEntitlement.

cancelEntitlementSettings()

public UnaryCallSettings<CancelEntitlementRequest,Operation> cancelEntitlementSettings()

Returns the object with the settings used for calls to cancelEntitlement.

changeOfferOperationSettings()

public OperationCallSettings<ChangeOfferRequest,Entitlement,OperationMetadata> changeOfferOperationSettings()

Returns the object with the settings used for calls to changeOffer.

changeOfferSettings()

public UnaryCallSettings<ChangeOfferRequest,Operation> changeOfferSettings()

Returns the object with the settings used for calls to changeOffer.

Returns
Type Description
UnaryCallSettings<ChangeOfferRequest,Operation>

changeParametersOperationSettings()

public OperationCallSettings<ChangeParametersRequest,Entitlement,OperationMetadata> changeParametersOperationSettings()

Returns the object with the settings used for calls to changeParameters.

changeParametersSettings()

public UnaryCallSettings<ChangeParametersRequest,Operation> changeParametersSettings()

Returns the object with the settings used for calls to changeParameters.

changeRenewalSettingsOperationSettings()

public OperationCallSettings<ChangeRenewalSettingsRequest,Entitlement,OperationMetadata> changeRenewalSettingsOperationSettings()

Returns the object with the settings used for calls to changeRenewalSettings.

changeRenewalSettingsSettings()

public UnaryCallSettings<ChangeRenewalSettingsRequest,Operation> changeRenewalSettingsSettings()

Returns the object with the settings used for calls to changeRenewalSettings.

checkCloudIdentityAccountsExistSettings()

public UnaryCallSettings<CheckCloudIdentityAccountsExistRequest,CheckCloudIdentityAccountsExistResponse> checkCloudIdentityAccountsExistSettings()

Returns the object with the settings used for calls to checkCloudIdentityAccountsExist.

createChannelPartnerLinkSettings()

public UnaryCallSettings<CreateChannelPartnerLinkRequest,ChannelPartnerLink> createChannelPartnerLinkSettings()

Returns the object with the settings used for calls to createChannelPartnerLink.

createChannelPartnerRepricingConfigSettings()

public UnaryCallSettings<CreateChannelPartnerRepricingConfigRequest,ChannelPartnerRepricingConfig> createChannelPartnerRepricingConfigSettings()

Returns the object with the settings used for calls to createChannelPartnerRepricingConfig.

createCustomerRepricingConfigSettings()

public UnaryCallSettings<CreateCustomerRepricingConfigRequest,CustomerRepricingConfig> createCustomerRepricingConfigSettings()

Returns the object with the settings used for calls to createCustomerRepricingConfig.

createCustomerSettings()

public UnaryCallSettings<CreateCustomerRequest,Customer> createCustomerSettings()

Returns the object with the settings used for calls to createCustomer.

createEntitlementOperationSettings()

public OperationCallSettings<CreateEntitlementRequest,Entitlement,OperationMetadata> createEntitlementOperationSettings()

Returns the object with the settings used for calls to createEntitlement.

createEntitlementSettings()

public UnaryCallSettings<CreateEntitlementRequest,Operation> createEntitlementSettings()

Returns the object with the settings used for calls to createEntitlement.

createStub()

public CloudChannelServiceStub createStub()
Returns
Type Description
CloudChannelServiceStub
Exceptions
Type Description
IOException

deleteChannelPartnerRepricingConfigSettings()

public UnaryCallSettings<DeleteChannelPartnerRepricingConfigRequest,Empty> deleteChannelPartnerRepricingConfigSettings()

Returns the object with the settings used for calls to deleteChannelPartnerRepricingConfig.

deleteCustomerRepricingConfigSettings()

public UnaryCallSettings<DeleteCustomerRepricingConfigRequest,Empty> deleteCustomerRepricingConfigSettings()

Returns the object with the settings used for calls to deleteCustomerRepricingConfig.

deleteCustomerSettings()

public UnaryCallSettings<DeleteCustomerRequest,Empty> deleteCustomerSettings()

Returns the object with the settings used for calls to deleteCustomer.

Returns
Type Description
UnaryCallSettings<DeleteCustomerRequest,Empty>

getChannelPartnerLinkSettings()

public UnaryCallSettings<GetChannelPartnerLinkRequest,ChannelPartnerLink> getChannelPartnerLinkSettings()

Returns the object with the settings used for calls to getChannelPartnerLink.

getChannelPartnerRepricingConfigSettings()

public UnaryCallSettings<GetChannelPartnerRepricingConfigRequest,ChannelPartnerRepricingConfig> getChannelPartnerRepricingConfigSettings()

Returns the object with the settings used for calls to getChannelPartnerRepricingConfig.

getCustomerRepricingConfigSettings()

public UnaryCallSettings<GetCustomerRepricingConfigRequest,CustomerRepricingConfig> getCustomerRepricingConfigSettings()

Returns the object with the settings used for calls to getCustomerRepricingConfig.

getCustomerSettings()

public UnaryCallSettings<GetCustomerRequest,Customer> getCustomerSettings()

Returns the object with the settings used for calls to getCustomer.

Returns
Type Description
UnaryCallSettings<GetCustomerRequest,Customer>

getEntitlementSettings()

public UnaryCallSettings<GetEntitlementRequest,Entitlement> getEntitlementSettings()

Returns the object with the settings used for calls to getEntitlement.

getServiceName()

public String getServiceName()

Returns the default service name.

Returns
Type Description
String
Overrides

importCustomerSettings()

public UnaryCallSettings<ImportCustomerRequest,Customer> importCustomerSettings()

Returns the object with the settings used for calls to importCustomer.

listChannelPartnerLinksSettings()

public PagedCallSettings<ListChannelPartnerLinksRequest,ListChannelPartnerLinksResponse,CloudChannelServiceClient.ListChannelPartnerLinksPagedResponse> listChannelPartnerLinksSettings()

Returns the object with the settings used for calls to listChannelPartnerLinks.

listChannelPartnerRepricingConfigsSettings()

public PagedCallSettings<ListChannelPartnerRepricingConfigsRequest,ListChannelPartnerRepricingConfigsResponse,CloudChannelServiceClient.ListChannelPartnerRepricingConfigsPagedResponse> listChannelPartnerRepricingConfigsSettings()

Returns the object with the settings used for calls to listChannelPartnerRepricingConfigs.

listCustomerRepricingConfigsSettings()

public PagedCallSettings<ListCustomerRepricingConfigsRequest,ListCustomerRepricingConfigsResponse,CloudChannelServiceClient.ListCustomerRepricingConfigsPagedResponse> listCustomerRepricingConfigsSettings()

Returns the object with the settings used for calls to listCustomerRepricingConfigs.

listCustomersSettings()

public PagedCallSettings<ListCustomersRequest,ListCustomersResponse,CloudChannelServiceClient.ListCustomersPagedResponse> listCustomersSettings()

Returns the object with the settings used for calls to listCustomers.

listEntitlementChangesSettings()

public PagedCallSettings<ListEntitlementChangesRequest,ListEntitlementChangesResponse,CloudChannelServiceClient.ListEntitlementChangesPagedResponse> listEntitlementChangesSettings()

Returns the object with the settings used for calls to listEntitlementChanges.

listEntitlementsSettings()

public PagedCallSettings<ListEntitlementsRequest,ListEntitlementsResponse,CloudChannelServiceClient.ListEntitlementsPagedResponse> listEntitlementsSettings()

Returns the object with the settings used for calls to listEntitlements.

listOffersSettings()

public PagedCallSettings<ListOffersRequest,ListOffersResponse,CloudChannelServiceClient.ListOffersPagedResponse> listOffersSettings()

Returns the object with the settings used for calls to listOffers.

listProductsSettings()

public PagedCallSettings<ListProductsRequest,ListProductsResponse,CloudChannelServiceClient.ListProductsPagedResponse> listProductsSettings()

Returns the object with the settings used for calls to listProducts.

listPurchasableOffersSettings()

public PagedCallSettings<ListPurchasableOffersRequest,ListPurchasableOffersResponse,CloudChannelServiceClient.ListPurchasableOffersPagedResponse> listPurchasableOffersSettings()

Returns the object with the settings used for calls to listPurchasableOffers.

listPurchasableSkusSettings()

public PagedCallSettings<ListPurchasableSkusRequest,ListPurchasableSkusResponse,CloudChannelServiceClient.ListPurchasableSkusPagedResponse> listPurchasableSkusSettings()

Returns the object with the settings used for calls to listPurchasableSkus.

listSkuGroupBillableSkusSettings()

public PagedCallSettings<ListSkuGroupBillableSkusRequest,ListSkuGroupBillableSkusResponse,CloudChannelServiceClient.ListSkuGroupBillableSkusPagedResponse> listSkuGroupBillableSkusSettings()

Returns the object with the settings used for calls to listSkuGroupBillableSkus.

listSkuGroupsSettings()

public PagedCallSettings<ListSkuGroupsRequest,ListSkuGroupsResponse,CloudChannelServiceClient.ListSkuGroupsPagedResponse> listSkuGroupsSettings()

Returns the object with the settings used for calls to listSkuGroups.

listSkusSettings()

public PagedCallSettings<ListSkusRequest,ListSkusResponse,CloudChannelServiceClient.ListSkusPagedResponse> listSkusSettings()

Returns the object with the settings used for calls to listSkus.

listSubscribersSettings()

public PagedCallSettings<ListSubscribersRequest,ListSubscribersResponse,CloudChannelServiceClient.ListSubscribersPagedResponse> listSubscribersSettings()

Returns the object with the settings used for calls to listSubscribers.

listTransferableOffersSettings()

public PagedCallSettings<ListTransferableOffersRequest,ListTransferableOffersResponse,CloudChannelServiceClient.ListTransferableOffersPagedResponse> listTransferableOffersSettings()

Returns the object with the settings used for calls to listTransferableOffers.

listTransferableSkusSettings()

public PagedCallSettings<ListTransferableSkusRequest,ListTransferableSkusResponse,CloudChannelServiceClient.ListTransferableSkusPagedResponse> listTransferableSkusSettings()

Returns the object with the settings used for calls to listTransferableSkus.

lookupOfferSettings()

public UnaryCallSettings<LookupOfferRequest,Offer> lookupOfferSettings()

Returns the object with the settings used for calls to lookupOffer.

Returns
Type Description
UnaryCallSettings<LookupOfferRequest,Offer>

provisionCloudIdentityOperationSettings()

public OperationCallSettings<ProvisionCloudIdentityRequest,Customer,OperationMetadata> provisionCloudIdentityOperationSettings()

Returns the object with the settings used for calls to provisionCloudIdentity.

provisionCloudIdentitySettings()

public UnaryCallSettings<ProvisionCloudIdentityRequest,Operation> provisionCloudIdentitySettings()

Returns the object with the settings used for calls to provisionCloudIdentity.

queryEligibleBillingAccountsSettings()

public UnaryCallSettings<QueryEligibleBillingAccountsRequest,QueryEligibleBillingAccountsResponse> queryEligibleBillingAccountsSettings()

Returns the object with the settings used for calls to queryEligibleBillingAccounts.

registerSubscriberSettings()

public UnaryCallSettings<RegisterSubscriberRequest,RegisterSubscriberResponse> registerSubscriberSettings()

Returns the object with the settings used for calls to registerSubscriber.

startPaidServiceOperationSettings()

public OperationCallSettings<StartPaidServiceRequest,Entitlement,OperationMetadata> startPaidServiceOperationSettings()

Returns the object with the settings used for calls to startPaidService.

startPaidServiceSettings()

public UnaryCallSettings<StartPaidServiceRequest,Operation> startPaidServiceSettings()

Returns the object with the settings used for calls to startPaidService.

suspendEntitlementOperationSettings()

public OperationCallSettings<SuspendEntitlementRequest,Entitlement,OperationMetadata> suspendEntitlementOperationSettings()

Returns the object with the settings used for calls to suspendEntitlement.

suspendEntitlementSettings()

public UnaryCallSettings<SuspendEntitlementRequest,Operation> suspendEntitlementSettings()

Returns the object with the settings used for calls to suspendEntitlement.

toBuilder()

public CloudChannelServiceStubSettings.Builder toBuilder()

Returns a builder containing all the values of this settings class.

Returns
Type Description
CloudChannelServiceStubSettings.Builder
Overrides

transferEntitlementsOperationSettings()

public OperationCallSettings<TransferEntitlementsRequest,TransferEntitlementsResponse,OperationMetadata> transferEntitlementsOperationSettings()

Returns the object with the settings used for calls to transferEntitlements.

transferEntitlementsSettings()

public UnaryCallSettings<TransferEntitlementsRequest,Operation> transferEntitlementsSettings()

Returns the object with the settings used for calls to transferEntitlements.

transferEntitlementsToGoogleOperationSettings()

public OperationCallSettings<TransferEntitlementsToGoogleRequest,Empty,OperationMetadata> transferEntitlementsToGoogleOperationSettings()

Returns the object with the settings used for calls to transferEntitlementsToGoogle.

transferEntitlementsToGoogleSettings()

public UnaryCallSettings<TransferEntitlementsToGoogleRequest,Operation> transferEntitlementsToGoogleSettings()

Returns the object with the settings used for calls to transferEntitlementsToGoogle.

unregisterSubscriberSettings()

public UnaryCallSettings<UnregisterSubscriberRequest,UnregisterSubscriberResponse> unregisterSubscriberSettings()

Returns the object with the settings used for calls to unregisterSubscriber.

updateChannelPartnerLinkSettings()

public UnaryCallSettings<UpdateChannelPartnerLinkRequest,ChannelPartnerLink> updateChannelPartnerLinkSettings()

Returns the object with the settings used for calls to updateChannelPartnerLink.

updateChannelPartnerRepricingConfigSettings()

public UnaryCallSettings<UpdateChannelPartnerRepricingConfigRequest,ChannelPartnerRepricingConfig> updateChannelPartnerRepricingConfigSettings()

Returns the object with the settings used for calls to updateChannelPartnerRepricingConfig.

updateCustomerRepricingConfigSettings()

public UnaryCallSettings<UpdateCustomerRepricingConfigRequest,CustomerRepricingConfig> updateCustomerRepricingConfigSettings()

Returns the object with the settings used for calls to updateCustomerRepricingConfig.

updateCustomerSettings()

public UnaryCallSettings<UpdateCustomerRequest,Customer> updateCustomerSettings()

Returns the object with the settings used for calls to updateCustomer.