Class CloudChannelServiceSettings (3.6.1)

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

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getWatchdogCheckInterval()

ClientSettings.getWatchdogProvider()

ClientSettings.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create(CloudChannelServiceStubSettings stub)

public static final CloudChannelServiceSettings create(CloudChannelServiceStubSettings stub)

Parameter

Name	Description
stub	`CloudChannelServiceStubSettings`

Returns

Type	Description
CloudChannelServiceSettings

Exceptions

Type	Description
IOException

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

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default 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

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns

Type	Description
List<String>

newBuilder()

public static CloudChannelServiceSettings.Builder newBuilder()

Returns a new builder for this class.

Returns

Type	Description
CloudChannelServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static CloudChannelServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter

Name	Description
clientContext	`ClientContext`

Returns

Type	Description
CloudChannelServiceSettings.Builder

Constructors

CloudChannelServiceSettings(CloudChannelServiceSettings.Builder settingsBuilder)

protected CloudChannelServiceSettings(CloudChannelServiceSettings.Builder settingsBuilder)

Parameter

Name	Description
settingsBuilder	`CloudChannelServiceSettings.Builder`

Methods

activateEntitlementOperationSettings()

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

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

Returns

Type	Description
OperationCallSettings<ActivateEntitlementRequest,Entitlement,OperationMetadata>

activateEntitlementSettings()

public UnaryCallSettings<ActivateEntitlementRequest,Operation> activateEntitlementSettings()

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

Returns

Type	Description
UnaryCallSettings<ActivateEntitlementRequest,Operation>

cancelEntitlementOperationSettings()

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

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

Returns

Type	Description
OperationCallSettings<CancelEntitlementRequest,Empty,OperationMetadata>

cancelEntitlementSettings()

public UnaryCallSettings<CancelEntitlementRequest,Operation> cancelEntitlementSettings()

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

Returns

Type	Description
UnaryCallSettings<CancelEntitlementRequest,Operation>

changeOfferOperationSettings()

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

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

Returns

Type	Description
OperationCallSettings<ChangeOfferRequest,Entitlement,OperationMetadata>

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.

Returns

Type	Description
OperationCallSettings<ChangeParametersRequest,Entitlement,OperationMetadata>

changeParametersSettings()

public UnaryCallSettings<ChangeParametersRequest,Operation> changeParametersSettings()

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

Returns

Type	Description
UnaryCallSettings<ChangeParametersRequest,Operation>

changeRenewalSettingsOperationSettings()

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

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

Returns

Type	Description
OperationCallSettings<ChangeRenewalSettingsRequest,Entitlement,OperationMetadata>

changeRenewalSettingsSettings()

public UnaryCallSettings<ChangeRenewalSettingsRequest,Operation> changeRenewalSettingsSettings()

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

Returns

Type	Description
UnaryCallSettings<ChangeRenewalSettingsRequest,Operation>

checkCloudIdentityAccountsExistSettings()

public UnaryCallSettings<CheckCloudIdentityAccountsExistRequest,CheckCloudIdentityAccountsExistResponse> checkCloudIdentityAccountsExistSettings()

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

Returns

Type	Description
UnaryCallSettings<CheckCloudIdentityAccountsExistRequest,CheckCloudIdentityAccountsExistResponse>

createChannelPartnerLinkSettings()

public UnaryCallSettings<CreateChannelPartnerLinkRequest,ChannelPartnerLink> createChannelPartnerLinkSettings()

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

Returns

Type	Description
UnaryCallSettings<CreateChannelPartnerLinkRequest,ChannelPartnerLink>

createChannelPartnerRepricingConfigSettings()

public UnaryCallSettings<CreateChannelPartnerRepricingConfigRequest,ChannelPartnerRepricingConfig> createChannelPartnerRepricingConfigSettings()

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

Returns

Type	Description
UnaryCallSettings<CreateChannelPartnerRepricingConfigRequest,ChannelPartnerRepricingConfig>

createCustomerRepricingConfigSettings()

public UnaryCallSettings<CreateCustomerRepricingConfigRequest,CustomerRepricingConfig> createCustomerRepricingConfigSettings()

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

Returns

Type	Description
UnaryCallSettings<CreateCustomerRepricingConfigRequest,CustomerRepricingConfig>

createCustomerSettings()

public UnaryCallSettings<CreateCustomerRequest,Customer> createCustomerSettings()

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

Returns

Type	Description
UnaryCallSettings<CreateCustomerRequest,Customer>

createEntitlementOperationSettings()

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

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

Returns

Type	Description
OperationCallSettings<CreateEntitlementRequest,Entitlement,OperationMetadata>

createEntitlementSettings()

public UnaryCallSettings<CreateEntitlementRequest,Operation> createEntitlementSettings()

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

Returns

Type	Description
UnaryCallSettings<CreateEntitlementRequest,Operation>

deleteChannelPartnerRepricingConfigSettings()

public UnaryCallSettings<DeleteChannelPartnerRepricingConfigRequest,Empty> deleteChannelPartnerRepricingConfigSettings()

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

Returns

Type	Description
UnaryCallSettings<DeleteChannelPartnerRepricingConfigRequest,Empty>

deleteCustomerRepricingConfigSettings()

public UnaryCallSettings<DeleteCustomerRepricingConfigRequest,Empty> deleteCustomerRepricingConfigSettings()

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

Returns

Type	Description
UnaryCallSettings<DeleteCustomerRepricingConfigRequest,Empty>

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.

Returns

Type	Description
UnaryCallSettings<GetChannelPartnerLinkRequest,ChannelPartnerLink>

getChannelPartnerRepricingConfigSettings()

public UnaryCallSettings<GetChannelPartnerRepricingConfigRequest,ChannelPartnerRepricingConfig> getChannelPartnerRepricingConfigSettings()

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

Returns

Type	Description
UnaryCallSettings<GetChannelPartnerRepricingConfigRequest,ChannelPartnerRepricingConfig>

getCustomerRepricingConfigSettings()

public UnaryCallSettings<GetCustomerRepricingConfigRequest,CustomerRepricingConfig> getCustomerRepricingConfigSettings()

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

Returns

Type	Description
UnaryCallSettings<GetCustomerRepricingConfigRequest,CustomerRepricingConfig>

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.

Returns

Type	Description
UnaryCallSettings<GetEntitlementRequest,Entitlement>

importCustomerSettings()

public UnaryCallSettings<ImportCustomerRequest,Customer> importCustomerSettings()

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

Returns

Type	Description
UnaryCallSettings<ImportCustomerRequest,Customer>

listChannelPartnerLinksSettings()

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

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

Returns

Type	Description
PagedCallSettings<ListChannelPartnerLinksRequest,ListChannelPartnerLinksResponse,ListChannelPartnerLinksPagedResponse>

listChannelPartnerRepricingConfigsSettings()

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

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

Returns

Type	Description
PagedCallSettings<ListChannelPartnerRepricingConfigsRequest,ListChannelPartnerRepricingConfigsResponse,ListChannelPartnerRepricingConfigsPagedResponse>

listCustomerRepricingConfigsSettings()

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

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

Returns

Type	Description
PagedCallSettings<ListCustomerRepricingConfigsRequest,ListCustomerRepricingConfigsResponse,ListCustomerRepricingConfigsPagedResponse>

listCustomersSettings()

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

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

Returns

Type	Description
PagedCallSettings<ListCustomersRequest,ListCustomersResponse,ListCustomersPagedResponse>

listEntitlementsSettings()

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

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

Returns

Type	Description
PagedCallSettings<ListEntitlementsRequest,ListEntitlementsResponse,ListEntitlementsPagedResponse>

listOffersSettings()

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

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

Returns

Type	Description
PagedCallSettings<ListOffersRequest,ListOffersResponse,ListOffersPagedResponse>

listProductsSettings()

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

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

Returns

Type	Description
PagedCallSettings<ListProductsRequest,ListProductsResponse,ListProductsPagedResponse>

listPurchasableOffersSettings()

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

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

Returns

Type	Description
PagedCallSettings<ListPurchasableOffersRequest,ListPurchasableOffersResponse,ListPurchasableOffersPagedResponse>

listPurchasableSkusSettings()

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

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

Returns

Type	Description
PagedCallSettings<ListPurchasableSkusRequest,ListPurchasableSkusResponse,ListPurchasableSkusPagedResponse>

listSkusSettings()

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

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

Returns

Type	Description
PagedCallSettings<ListSkusRequest,ListSkusResponse,ListSkusPagedResponse>

listSubscribersSettings()

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

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

Returns

Type	Description
PagedCallSettings<ListSubscribersRequest,ListSubscribersResponse,ListSubscribersPagedResponse>

listTransferableOffersSettings()

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

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

Returns

Type	Description
PagedCallSettings<ListTransferableOffersRequest,ListTransferableOffersResponse,ListTransferableOffersPagedResponse>

listTransferableSkusSettings()

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

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

Returns

Type	Description
PagedCallSettings<ListTransferableSkusRequest,ListTransferableSkusResponse,ListTransferableSkusPagedResponse>

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.

Returns

Type	Description
OperationCallSettings<ProvisionCloudIdentityRequest,Customer,OperationMetadata>

provisionCloudIdentitySettings()

public UnaryCallSettings<ProvisionCloudIdentityRequest,Operation> provisionCloudIdentitySettings()

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

Returns

Type	Description
UnaryCallSettings<ProvisionCloudIdentityRequest,Operation>

registerSubscriberSettings()

public UnaryCallSettings<RegisterSubscriberRequest,RegisterSubscriberResponse> registerSubscriberSettings()

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

Returns

Type	Description
UnaryCallSettings<RegisterSubscriberRequest,RegisterSubscriberResponse>

startPaidServiceOperationSettings()

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

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

Returns

Type	Description
OperationCallSettings<StartPaidServiceRequest,Entitlement,OperationMetadata>

startPaidServiceSettings()

public UnaryCallSettings<StartPaidServiceRequest,Operation> startPaidServiceSettings()

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

Returns

Type	Description
UnaryCallSettings<StartPaidServiceRequest,Operation>

suspendEntitlementOperationSettings()

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

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

Returns

Type	Description
OperationCallSettings<SuspendEntitlementRequest,Entitlement,OperationMetadata>

suspendEntitlementSettings()

public UnaryCallSettings<SuspendEntitlementRequest,Operation> suspendEntitlementSettings()

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

Returns

Type	Description
UnaryCallSettings<SuspendEntitlementRequest,Operation>

toBuilder()

public CloudChannelServiceSettings.Builder toBuilder()

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

Returns

Type	Description
CloudChannelServiceSettings.Builder

Overrides

ClientSettings<SettingsT>.<B>toBuilder()

transferEntitlementsOperationSettings()

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

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

Returns

Type	Description
OperationCallSettings<TransferEntitlementsRequest,TransferEntitlementsResponse,OperationMetadata>

transferEntitlementsSettings()

public UnaryCallSettings<TransferEntitlementsRequest,Operation> transferEntitlementsSettings()

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

Returns

Type	Description
UnaryCallSettings<TransferEntitlementsRequest,Operation>

transferEntitlementsToGoogleOperationSettings()

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

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

Returns

Type	Description
OperationCallSettings<TransferEntitlementsToGoogleRequest,Empty,OperationMetadata>

transferEntitlementsToGoogleSettings()

public UnaryCallSettings<TransferEntitlementsToGoogleRequest,Operation> transferEntitlementsToGoogleSettings()

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

Returns

Type	Description
UnaryCallSettings<TransferEntitlementsToGoogleRequest,Operation>

unregisterSubscriberSettings()

public UnaryCallSettings<UnregisterSubscriberRequest,UnregisterSubscriberResponse> unregisterSubscriberSettings()

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

Returns

Type	Description
UnaryCallSettings<UnregisterSubscriberRequest,UnregisterSubscriberResponse>

updateChannelPartnerLinkSettings()

public UnaryCallSettings<UpdateChannelPartnerLinkRequest,ChannelPartnerLink> updateChannelPartnerLinkSettings()

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

Returns

Type	Description
UnaryCallSettings<UpdateChannelPartnerLinkRequest,ChannelPartnerLink>

updateChannelPartnerRepricingConfigSettings()

public UnaryCallSettings<UpdateChannelPartnerRepricingConfigRequest,ChannelPartnerRepricingConfig> updateChannelPartnerRepricingConfigSettings()

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

Returns

Type	Description
UnaryCallSettings<UpdateChannelPartnerRepricingConfigRequest,ChannelPartnerRepricingConfig>

updateCustomerRepricingConfigSettings()

public UnaryCallSettings<UpdateCustomerRepricingConfigRequest,CustomerRepricingConfig> updateCustomerRepricingConfigSettings()

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

Returns

Type	Description
UnaryCallSettings<UpdateCustomerRepricingConfigRequest,CustomerRepricingConfig>

updateCustomerSettings()

public UnaryCallSettings<UpdateCustomerRequest,Customer> updateCustomerSettings()

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

Returns

Type	Description
UnaryCallSettings<UpdateCustomerRequest,Customer>