Class BudgetServiceSettings (2.3.4) 

public class BudgetServiceSettings extends ClientSettings<BudgetServiceSettings>

Settings class to configure an instance of BudgetServiceClient.

The default instance has everything set to sensible defaults:

  • The default service address (billingbudgets.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 createBudget to 30 seconds:


 // 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
 BudgetServiceSettings.Builder budgetServiceSettingsBuilder = BudgetServiceSettings.newBuilder();
 budgetServiceSettingsBuilder
     .createBudgetSettings()
     .setRetrySettings(
         budgetServiceSettingsBuilder.createBudgetSettings().getRetrySettings().toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 BudgetServiceSettings budgetServiceSettings = budgetServiceSettingsBuilder.build();

Inheritance

java.lang.Object > ClientSettings > BudgetServiceSettings

Static Methods

create(BudgetServiceStubSettings stub)

public static final BudgetServiceSettings create(BudgetServiceStubSettings stub)
Parameter
NameDescription
stubBudgetServiceStubSettings
Returns
TypeDescription
BudgetServiceSettings
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 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 BudgetServiceSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
BudgetServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static BudgetServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
BudgetServiceSettings.Builder

Constructors

BudgetServiceSettings(BudgetServiceSettings.Builder settingsBuilder)

protected BudgetServiceSettings(BudgetServiceSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderBudgetServiceSettings.Builder

Methods

createBudgetSettings()

public UnaryCallSettings<CreateBudgetRequest,Budget> createBudgetSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateBudgetRequest,Budget>

deleteBudgetSettings()

public UnaryCallSettings<DeleteBudgetRequest,Empty> deleteBudgetSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteBudgetRequest,Empty>

getBudgetSettings()

public UnaryCallSettings<GetBudgetRequest,Budget> getBudgetSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetBudgetRequest,Budget>

listBudgetsSettings()

public PagedCallSettings<ListBudgetsRequest,ListBudgetsResponse,BudgetServiceClient.ListBudgetsPagedResponse> listBudgetsSettings()

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

Returns
TypeDescription
PagedCallSettings<ListBudgetsRequest,ListBudgetsResponse,ListBudgetsPagedResponse>

toBuilder()

public BudgetServiceSettings.Builder toBuilder()

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

Returns
TypeDescription
BudgetServiceSettings.Builder
Overrides

updateBudgetSettings()

public UnaryCallSettings<UpdateBudgetRequest,Budget> updateBudgetSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateBudgetRequest,Budget>