Class ReservationServiceSettings (2.6.0)

Version 2.6.0

• 2.60.0 (latest)
• 2.59.0
• 2.58.0
• 2.57.0
• 2.56.0
• 2.55.0
• 2.54.0
• 2.53.0
• 2.52.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.6
• 2.3.1
• 2.2.7
• 2.1.4

public class ReservationServiceSettings extends ClientSettings<ReservationServiceSettings>

Settings class to configure an instance of ReservationServiceClient.

The default instance has everything set to sensible defaults:

• The default service address (bigqueryreservation.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 createReservation 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
 ReservationServiceSettings.Builder reservationServiceSettingsBuilder =
     ReservationServiceSettings.newBuilder();
 reservationServiceSettingsBuilder
     .createReservationSettings()
     .setRetrySettings(
         reservationServiceSettingsBuilder
             .createReservationSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 ReservationServiceSettings reservationServiceSettings =
     reservationServiceSettingsBuilder.build();
 

Inheritance

java.lang.Object > ClientSettings > ReservationServiceSettings

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(ReservationServiceStubSettings stub)

public static final ReservationServiceSettings create(ReservationServiceStubSettings stub)

Parameter

Name	Description
stub	ReservationServiceStubSettings

Returns

Type	Description
ReservationServiceSettings

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 ReservationServiceSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns

Type	Description
ReservationServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static ReservationServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter

Name	Description
clientContext	ClientContext

Returns

Type	Description
ReservationServiceSettings.Builder

newHttpJsonBuilder()

public static ReservationServiceSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns

Type	Description
ReservationServiceSettings.Builder

Constructors

ReservationServiceSettings(ReservationServiceSettings.Builder settingsBuilder)

protected ReservationServiceSettings(ReservationServiceSettings.Builder settingsBuilder)

Parameter

Name	Description
settingsBuilder	ReservationServiceSettings.Builder

Methods

createAssignmentSettings()

public UnaryCallSettings<CreateAssignmentRequest,Assignment> createAssignmentSettings()

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

Returns

Type	Description
UnaryCallSettings<CreateAssignmentRequest,Assignment>

createCapacityCommitmentSettings()

public UnaryCallSettings<CreateCapacityCommitmentRequest,CapacityCommitment> createCapacityCommitmentSettings()

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

Returns

Type	Description
UnaryCallSettings<CreateCapacityCommitmentRequest,CapacityCommitment>

createReservationSettings()

public UnaryCallSettings<CreateReservationRequest,Reservation> createReservationSettings()

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

Returns

Type	Description
UnaryCallSettings<CreateReservationRequest,Reservation>

deleteAssignmentSettings()

public UnaryCallSettings<DeleteAssignmentRequest,Empty> deleteAssignmentSettings()

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

Returns

Type	Description
UnaryCallSettings<DeleteAssignmentRequest,Empty>

deleteCapacityCommitmentSettings()

public UnaryCallSettings<DeleteCapacityCommitmentRequest,Empty> deleteCapacityCommitmentSettings()

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

Returns

Type	Description
UnaryCallSettings<DeleteCapacityCommitmentRequest,Empty>

deleteReservationSettings()

public UnaryCallSettings<DeleteReservationRequest,Empty> deleteReservationSettings()

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

Returns

Type	Description
UnaryCallSettings<DeleteReservationRequest,Empty>

getBiReservationSettings()

public UnaryCallSettings<GetBiReservationRequest,BiReservation> getBiReservationSettings()

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

Returns

Type	Description
UnaryCallSettings<GetBiReservationRequest,BiReservation>

getCapacityCommitmentSettings()

public UnaryCallSettings<GetCapacityCommitmentRequest,CapacityCommitment> getCapacityCommitmentSettings()

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

Returns

Type	Description
UnaryCallSettings<GetCapacityCommitmentRequest,CapacityCommitment>

getReservationSettings()

public UnaryCallSettings<GetReservationRequest,Reservation> getReservationSettings()

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

Returns

Type	Description
UnaryCallSettings<GetReservationRequest,Reservation>

listAssignmentsSettings()

public PagedCallSettings<ListAssignmentsRequest,ListAssignmentsResponse,ReservationServiceClient.ListAssignmentsPagedResponse> listAssignmentsSettings()

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

Returns

Type	Description
PagedCallSettings<ListAssignmentsRequest,ListAssignmentsResponse,ListAssignmentsPagedResponse>

listCapacityCommitmentsSettings()

public PagedCallSettings<ListCapacityCommitmentsRequest,ListCapacityCommitmentsResponse,ReservationServiceClient.ListCapacityCommitmentsPagedResponse> listCapacityCommitmentsSettings()

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

Returns

Type	Description
PagedCallSettings<ListCapacityCommitmentsRequest,ListCapacityCommitmentsResponse,ListCapacityCommitmentsPagedResponse>

listReservationsSettings()

public PagedCallSettings<ListReservationsRequest,ListReservationsResponse,ReservationServiceClient.ListReservationsPagedResponse> listReservationsSettings()

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

Returns

Type	Description
PagedCallSettings<ListReservationsRequest,ListReservationsResponse,ListReservationsPagedResponse>

mergeCapacityCommitmentsSettings()

public UnaryCallSettings<MergeCapacityCommitmentsRequest,CapacityCommitment> mergeCapacityCommitmentsSettings()

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

Returns

Type	Description
UnaryCallSettings<MergeCapacityCommitmentsRequest,CapacityCommitment>

moveAssignmentSettings()

public UnaryCallSettings<MoveAssignmentRequest,Assignment> moveAssignmentSettings()

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

Returns

Type	Description
UnaryCallSettings<MoveAssignmentRequest,Assignment>

searchAllAssignmentsSettings()

public PagedCallSettings<SearchAllAssignmentsRequest,SearchAllAssignmentsResponse,ReservationServiceClient.SearchAllAssignmentsPagedResponse> searchAllAssignmentsSettings()

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

Returns

Type	Description
PagedCallSettings<SearchAllAssignmentsRequest,SearchAllAssignmentsResponse,SearchAllAssignmentsPagedResponse>

searchAssignmentsSettings() (deprecated)

public PagedCallSettings<SearchAssignmentsRequest,SearchAssignmentsResponse,ReservationServiceClient.SearchAssignmentsPagedResponse> searchAssignmentsSettings()

Deprecated. This method is deprecated and will be removed in the next major version update.

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

Returns

Type	Description
PagedCallSettings<SearchAssignmentsRequest,SearchAssignmentsResponse,SearchAssignmentsPagedResponse>

splitCapacityCommitmentSettings()

public UnaryCallSettings<SplitCapacityCommitmentRequest,SplitCapacityCommitmentResponse> splitCapacityCommitmentSettings()

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

Returns

Type	Description
UnaryCallSettings<SplitCapacityCommitmentRequest,SplitCapacityCommitmentResponse>

toBuilder()

public ReservationServiceSettings.Builder toBuilder()

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

Returns

Type	Description
ReservationServiceSettings.Builder

Overrides

ClientSettings<SettingsT>.<B>toBuilder()

updateAssignmentSettings()

public UnaryCallSettings<UpdateAssignmentRequest,Assignment> updateAssignmentSettings()

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

Returns

Type	Description
UnaryCallSettings<UpdateAssignmentRequest,Assignment>

updateBiReservationSettings()

public UnaryCallSettings<UpdateBiReservationRequest,BiReservation> updateBiReservationSettings()

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

Returns

Type	Description
UnaryCallSettings<UpdateBiReservationRequest,BiReservation>

updateCapacityCommitmentSettings()

public UnaryCallSettings<UpdateCapacityCommitmentRequest,CapacityCommitment> updateCapacityCommitmentSettings()

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

Returns

Type	Description
UnaryCallSettings<UpdateCapacityCommitmentRequest,CapacityCommitment>

updateReservationSettings()

public UnaryCallSettings<UpdateReservationRequest,Reservation> updateReservationSettings()

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

Returns

Type	Description
UnaryCallSettings<UpdateReservationRequest,Reservation>