Class CloudBillingSettings (2.52.0) 

public class CloudBillingSettings extends ClientSettings<CloudBillingSettings>

Settings class to configure an instance of CloudBillingClient.

The default instance has everything set to sensible defaults:

  • The default service address (cloudbilling.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 getBillingAccount:


 // 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
 CloudBillingSettings.Builder cloudBillingSettingsBuilder = CloudBillingSettings.newBuilder();
 cloudBillingSettingsBuilder
     .getBillingAccountSettings()
     .setRetrySettings(
         cloudBillingSettingsBuilder
             .getBillingAccountSettings()
             .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());
 CloudBillingSettings cloudBillingSettings = cloudBillingSettingsBuilder.build();

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

Inheritance

java.lang.Object > ClientSettings > CloudBillingSettings

Static Methods

create(CloudBillingStubSettings stub)

public static final CloudBillingSettings create(CloudBillingStubSettings stub)
Parameter
Name Description
stub CloudBillingStubSettings
Returns
Type Description
CloudBillingSettings
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 gRPC ChannelProvider for this service.

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

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
Type Description
List<String>

newBuilder()

public static CloudBillingSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type Description
CloudBillingSettings.Builder

newBuilder(ClientContext clientContext)

public static CloudBillingSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
CloudBillingSettings.Builder

newHttpJsonBuilder()

public static CloudBillingSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
CloudBillingSettings.Builder

Constructors

CloudBillingSettings(CloudBillingSettings.Builder settingsBuilder)

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

Methods

createBillingAccountSettings()

public UnaryCallSettings<CreateBillingAccountRequest,BillingAccount> createBillingAccountSettings()

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

Returns
Type Description
UnaryCallSettings<CreateBillingAccountRequest,BillingAccount>

getBillingAccountSettings()

public UnaryCallSettings<GetBillingAccountRequest,BillingAccount> getBillingAccountSettings()

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

Returns
Type Description
UnaryCallSettings<GetBillingAccountRequest,BillingAccount>

getIamPolicySettings()

public UnaryCallSettings<GetIamPolicyRequest,Policy> getIamPolicySettings()

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

Returns
Type Description
UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>

getProjectBillingInfoSettings()

public UnaryCallSettings<GetProjectBillingInfoRequest,ProjectBillingInfo> getProjectBillingInfoSettings()

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

Returns
Type Description
UnaryCallSettings<GetProjectBillingInfoRequest,ProjectBillingInfo>

listBillingAccountsSettings()

public PagedCallSettings<ListBillingAccountsRequest,ListBillingAccountsResponse,CloudBillingClient.ListBillingAccountsPagedResponse> listBillingAccountsSettings()

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

Returns
Type Description
PagedCallSettings<ListBillingAccountsRequest,ListBillingAccountsResponse,ListBillingAccountsPagedResponse>

listProjectBillingInfoSettings()

public PagedCallSettings<ListProjectBillingInfoRequest,ListProjectBillingInfoResponse,CloudBillingClient.ListProjectBillingInfoPagedResponse> listProjectBillingInfoSettings()

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

Returns
Type Description
PagedCallSettings<ListProjectBillingInfoRequest,ListProjectBillingInfoResponse,ListProjectBillingInfoPagedResponse>

moveBillingAccountSettings()

public UnaryCallSettings<MoveBillingAccountRequest,BillingAccount> moveBillingAccountSettings()

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

Returns
Type Description
UnaryCallSettings<MoveBillingAccountRequest,BillingAccount>

setIamPolicySettings()

public UnaryCallSettings<SetIamPolicyRequest,Policy> setIamPolicySettings()

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

Returns
Type Description
UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>

testIamPermissionsSettings()

public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()

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

Returns
Type Description
UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>

toBuilder()

public CloudBillingSettings.Builder toBuilder()

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

Returns
Type Description
CloudBillingSettings.Builder
Overrides

updateBillingAccountSettings()

public UnaryCallSettings<UpdateBillingAccountRequest,BillingAccount> updateBillingAccountSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateBillingAccountRequest,BillingAccount>

updateProjectBillingInfoSettings()

public UnaryCallSettings<UpdateProjectBillingInfoRequest,ProjectBillingInfo> updateProjectBillingInfoSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateProjectBillingInfoRequest,ProjectBillingInfo>