Class CloudChannelServiceSettings (3.7.2)

public class CloudChannelServiceSettings extends ClientSettings<CloudChannelServiceSettings>

Settings class to configure an instance of CloudChannelServiceClient.

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 total timeout of getCustomer to 30 seconds:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 CloudChannelServiceSettings.Builder cloudChannelServiceSettingsBuilder =
     CloudChannelServiceSettings.newBuilder();
 cloudChannelServiceSettingsBuilder
     .getCustomerSettings()
     .setRetrySettings(
         cloudChannelServiceSettingsBuilder
             .getCustomerSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 CloudChannelServiceSettings cloudChannelServiceSettings =
     cloudChannelServiceSettingsBuilder.build();
 

Inheritance

java.lang.Object > ClientSettings > CloudChannelServiceSettings

Static Methods

create(CloudChannelServiceStubSettings stub)

public static final CloudChannelServiceSettings create(CloudChannelServiceStubSettings stub)
Parameter
NameDescription
stubCloudChannelServiceStubSettings
Returns
TypeDescription
CloudChannelServiceSettings
Exceptions
TypeDescription
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
TypeDescription
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
TypeDescription
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

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

Returns
TypeDescription
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

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

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static CloudChannelServiceSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
TypeDescription
CloudChannelServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static CloudChannelServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
CloudChannelServiceSettings.Builder

newHttpJsonBuilder()

public static CloudChannelServiceSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
TypeDescription
CloudChannelServiceSettings.Builder

Constructors

CloudChannelServiceSettings(CloudChannelServiceSettings.Builder settingsBuilder)

protected CloudChannelServiceSettings(CloudChannelServiceSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderCloudChannelServiceSettings.Builder

Methods

activateEntitlementOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<ActivateEntitlementRequest,Entitlement,OperationMetadata>

activateEntitlementSettings()

public UnaryCallSettings<ActivateEntitlementRequest,Operation> activateEntitlementSettings()

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

Returns
TypeDescription
UnaryCallSettings<ActivateEntitlementRequest,Operation>

cancelEntitlementOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<CancelEntitlementRequest,Empty,OperationMetadata>

cancelEntitlementSettings()

public UnaryCallSettings<CancelEntitlementRequest,Operation> cancelEntitlementSettings()

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

Returns
TypeDescription
UnaryCallSettings<CancelEntitlementRequest,Operation>

changeOfferOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<ChangeOfferRequest,Entitlement,OperationMetadata>

changeOfferSettings()

public UnaryCallSettings<ChangeOfferRequest,Operation> changeOfferSettings()

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

Returns
TypeDescription
UnaryCallSettings<ChangeOfferRequest,Operation>

changeParametersOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<ChangeParametersRequest,Entitlement,OperationMetadata>

changeParametersSettings()

public UnaryCallSettings<ChangeParametersRequest,Operation> changeParametersSettings()

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

Returns
TypeDescription
UnaryCallSettings<ChangeParametersRequest,Operation>

changeRenewalSettingsOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<ChangeRenewalSettingsRequest,Entitlement,OperationMetadata>

changeRenewalSettingsSettings()

public UnaryCallSettings<ChangeRenewalSettingsRequest,Operation> changeRenewalSettingsSettings()

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

Returns
TypeDescription
UnaryCallSettings<ChangeRenewalSettingsRequest,Operation>

checkCloudIdentityAccountsExistSettings()

public UnaryCallSettings<CheckCloudIdentityAccountsExistRequest,CheckCloudIdentityAccountsExistResponse> checkCloudIdentityAccountsExistSettings()

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

Returns
TypeDescription
UnaryCallSettings<CheckCloudIdentityAccountsExistRequest,CheckCloudIdentityAccountsExistResponse>

createChannelPartnerLinkSettings()

public UnaryCallSettings<CreateChannelPartnerLinkRequest,ChannelPartnerLink> createChannelPartnerLinkSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateChannelPartnerLinkRequest,ChannelPartnerLink>

createChannelPartnerRepricingConfigSettings()

public UnaryCallSettings<CreateChannelPartnerRepricingConfigRequest,ChannelPartnerRepricingConfig> createChannelPartnerRepricingConfigSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateChannelPartnerRepricingConfigRequest,ChannelPartnerRepricingConfig>

createCustomerRepricingConfigSettings()

public UnaryCallSettings<CreateCustomerRepricingConfigRequest,CustomerRepricingConfig> createCustomerRepricingConfigSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateCustomerRepricingConfigRequest,CustomerRepricingConfig>

createCustomerSettings()

public UnaryCallSettings<CreateCustomerRequest,Customer> createCustomerSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateCustomerRequest,Customer>

createEntitlementOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<CreateEntitlementRequest,Entitlement,OperationMetadata>

createEntitlementSettings()

public UnaryCallSettings<CreateEntitlementRequest,Operation> createEntitlementSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateEntitlementRequest,Operation>

deleteChannelPartnerRepricingConfigSettings()

public UnaryCallSettings<DeleteChannelPartnerRepricingConfigRequest,Empty> deleteChannelPartnerRepricingConfigSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteChannelPartnerRepricingConfigRequest,Empty>

deleteCustomerRepricingConfigSettings()

public UnaryCallSettings<DeleteCustomerRepricingConfigRequest,Empty> deleteCustomerRepricingConfigSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteCustomerRepricingConfigRequest,Empty>

deleteCustomerSettings()

public UnaryCallSettings<DeleteCustomerRequest,Empty> deleteCustomerSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteCustomerRequest,Empty>

getChannelPartnerLinkSettings()

public UnaryCallSettings<GetChannelPartnerLinkRequest,ChannelPartnerLink> getChannelPartnerLinkSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetChannelPartnerLinkRequest,ChannelPartnerLink>

getChannelPartnerRepricingConfigSettings()

public UnaryCallSettings<GetChannelPartnerRepricingConfigRequest,ChannelPartnerRepricingConfig> getChannelPartnerRepricingConfigSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetChannelPartnerRepricingConfigRequest,ChannelPartnerRepricingConfig>

getCustomerRepricingConfigSettings()

public UnaryCallSettings<GetCustomerRepricingConfigRequest,CustomerRepricingConfig> getCustomerRepricingConfigSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetCustomerRepricingConfigRequest,CustomerRepricingConfig>

getCustomerSettings()

public UnaryCallSettings<GetCustomerRequest,Customer> getCustomerSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetCustomerRequest,Customer>

getEntitlementSettings()

public UnaryCallSettings<GetEntitlementRequest,Entitlement> getEntitlementSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetEntitlementRequest,Entitlement>

importCustomerSettings()

public UnaryCallSettings<ImportCustomerRequest,Customer> importCustomerSettings()

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

Returns
TypeDescription
UnaryCallSettings<ImportCustomerRequest,Customer>

listChannelPartnerLinksSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListChannelPartnerLinksRequest,ListChannelPartnerLinksResponse,ListChannelPartnerLinksPagedResponse>

listChannelPartnerRepricingConfigsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListChannelPartnerRepricingConfigsRequest,ListChannelPartnerRepricingConfigsResponse,ListChannelPartnerRepricingConfigsPagedResponse>

listCustomerRepricingConfigsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListCustomerRepricingConfigsRequest,ListCustomerRepricingConfigsResponse,ListCustomerRepricingConfigsPagedResponse>

listCustomersSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListCustomersRequest,ListCustomersResponse,ListCustomersPagedResponse>

listEntitlementsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListEntitlementsRequest,ListEntitlementsResponse,ListEntitlementsPagedResponse>

listOffersSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListOffersRequest,ListOffersResponse,ListOffersPagedResponse>

listProductsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListProductsRequest,ListProductsResponse,ListProductsPagedResponse>

listPurchasableOffersSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListPurchasableOffersRequest,ListPurchasableOffersResponse,ListPurchasableOffersPagedResponse>

listPurchasableSkusSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListPurchasableSkusRequest,ListPurchasableSkusResponse,ListPurchasableSkusPagedResponse>

listSkusSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListSkusRequest,ListSkusResponse,ListSkusPagedResponse>

listSubscribersSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListSubscribersRequest,ListSubscribersResponse,ListSubscribersPagedResponse>

listTransferableOffersSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListTransferableOffersRequest,ListTransferableOffersResponse,ListTransferableOffersPagedResponse>

listTransferableSkusSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListTransferableSkusRequest,ListTransferableSkusResponse,ListTransferableSkusPagedResponse>

lookupOfferSettings()

public UnaryCallSettings<LookupOfferRequest,Offer> lookupOfferSettings()

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

Returns
TypeDescription
UnaryCallSettings<LookupOfferRequest,Offer>

provisionCloudIdentityOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<ProvisionCloudIdentityRequest,Customer,OperationMetadata>

provisionCloudIdentitySettings()

public UnaryCallSettings<ProvisionCloudIdentityRequest,Operation> provisionCloudIdentitySettings()

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

Returns
TypeDescription
UnaryCallSettings<ProvisionCloudIdentityRequest,Operation>

registerSubscriberSettings()

public UnaryCallSettings<RegisterSubscriberRequest,RegisterSubscriberResponse> registerSubscriberSettings()

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

Returns
TypeDescription
UnaryCallSettings<RegisterSubscriberRequest,RegisterSubscriberResponse>

startPaidServiceOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<StartPaidServiceRequest,Entitlement,OperationMetadata>

startPaidServiceSettings()

public UnaryCallSettings<StartPaidServiceRequest,Operation> startPaidServiceSettings()

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

Returns
TypeDescription
UnaryCallSettings<StartPaidServiceRequest,Operation>

suspendEntitlementOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<SuspendEntitlementRequest,Entitlement,OperationMetadata>

suspendEntitlementSettings()

public UnaryCallSettings<SuspendEntitlementRequest,Operation> suspendEntitlementSettings()

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

Returns
TypeDescription
UnaryCallSettings<SuspendEntitlementRequest,Operation>

toBuilder()

public CloudChannelServiceSettings.Builder toBuilder()

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

Returns
TypeDescription
CloudChannelServiceSettings.Builder
Overrides

transferEntitlementsOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<TransferEntitlementsRequest,TransferEntitlementsResponse,OperationMetadata>

transferEntitlementsSettings()

public UnaryCallSettings<TransferEntitlementsRequest,Operation> transferEntitlementsSettings()

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

Returns
TypeDescription
UnaryCallSettings<TransferEntitlementsRequest,Operation>

transferEntitlementsToGoogleOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<TransferEntitlementsToGoogleRequest,Empty,OperationMetadata>

transferEntitlementsToGoogleSettings()

public UnaryCallSettings<TransferEntitlementsToGoogleRequest,Operation> transferEntitlementsToGoogleSettings()

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

Returns
TypeDescription
UnaryCallSettings<TransferEntitlementsToGoogleRequest,Operation>

unregisterSubscriberSettings()

public UnaryCallSettings<UnregisterSubscriberRequest,UnregisterSubscriberResponse> unregisterSubscriberSettings()

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

Returns
TypeDescription
UnaryCallSettings<UnregisterSubscriberRequest,UnregisterSubscriberResponse>

updateChannelPartnerLinkSettings()

public UnaryCallSettings<UpdateChannelPartnerLinkRequest,ChannelPartnerLink> updateChannelPartnerLinkSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateChannelPartnerLinkRequest,ChannelPartnerLink>

updateChannelPartnerRepricingConfigSettings()

public UnaryCallSettings<UpdateChannelPartnerRepricingConfigRequest,ChannelPartnerRepricingConfig> updateChannelPartnerRepricingConfigSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateChannelPartnerRepricingConfigRequest,ChannelPartnerRepricingConfig>

updateCustomerRepricingConfigSettings()

public UnaryCallSettings<UpdateCustomerRepricingConfigRequest,CustomerRepricingConfig> updateCustomerRepricingConfigSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateCustomerRepricingConfigRequest,CustomerRepricingConfig>

updateCustomerSettings()

public UnaryCallSettings<UpdateCustomerRequest,Customer> updateCustomerSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateCustomerRequest,Customer>