Class ReservationServiceStubSettings (2.10.0)

Stay organized with collections Save and categorize content based on your preferences.
public class ReservationServiceStubSettings extends StubSettings<ReservationServiceStubSettings>

Settings class to configure an instance of ReservationServiceStub.

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
 ReservationServiceStubSettings.Builder reservationServiceSettingsBuilder =
     ReservationServiceStubSettings.newBuilder();
 reservationServiceSettingsBuilder
     .createReservationSettings()
     .setRetrySettings(
         reservationServiceSettingsBuilder
             .createReservationSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 ReservationServiceStubSettings reservationServiceSettings =
     reservationServiceSettingsBuilder.build();
 

Inheritance

java.lang.Object > StubSettings > ReservationServiceStubSettings

Static Methods

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

defaultGrpcApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

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

Returns
TypeDescription
Builder

defaultHttpJsonApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()
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

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static ReservationServiceStubSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
TypeDescription
ReservationServiceStubSettings.Builder

newBuilder(ClientContext clientContext)

public static ReservationServiceStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
ReservationServiceStubSettings.Builder

newHttpJsonBuilder()

public static ReservationServiceStubSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
TypeDescription
ReservationServiceStubSettings.Builder

Constructors

ReservationServiceStubSettings(ReservationServiceStubSettings.Builder settingsBuilder)

protected ReservationServiceStubSettings(ReservationServiceStubSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderReservationServiceStubSettings.Builder

Methods

createAssignmentSettings()

public UnaryCallSettings<CreateAssignmentRequest,Assignment> createAssignmentSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateAssignmentRequest,Assignment>

createCapacityCommitmentSettings()

public UnaryCallSettings<CreateCapacityCommitmentRequest,CapacityCommitment> createCapacityCommitmentSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateCapacityCommitmentRequest,CapacityCommitment>

createReservationSettings()

public UnaryCallSettings<CreateReservationRequest,Reservation> createReservationSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateReservationRequest,Reservation>

createStub()

public ReservationServiceStub createStub()
Returns
TypeDescription
ReservationServiceStub
Exceptions
TypeDescription
IOException

deleteAssignmentSettings()

public UnaryCallSettings<DeleteAssignmentRequest,Empty> deleteAssignmentSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteAssignmentRequest,Empty>

deleteCapacityCommitmentSettings()

public UnaryCallSettings<DeleteCapacityCommitmentRequest,Empty> deleteCapacityCommitmentSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteCapacityCommitmentRequest,Empty>

deleteReservationSettings()

public UnaryCallSettings<DeleteReservationRequest,Empty> deleteReservationSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteReservationRequest,Empty>

getBiReservationSettings()

public UnaryCallSettings<GetBiReservationRequest,BiReservation> getBiReservationSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetBiReservationRequest,BiReservation>

getCapacityCommitmentSettings()

public UnaryCallSettings<GetCapacityCommitmentRequest,CapacityCommitment> getCapacityCommitmentSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetCapacityCommitmentRequest,CapacityCommitment>

getReservationSettings()

public UnaryCallSettings<GetReservationRequest,Reservation> getReservationSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetReservationRequest,Reservation>

listAssignmentsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListAssignmentsRequest,ListAssignmentsResponse,ListAssignmentsPagedResponse>

listCapacityCommitmentsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListCapacityCommitmentsRequest,ListCapacityCommitmentsResponse,ListCapacityCommitmentsPagedResponse>

listReservationsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListReservationsRequest,ListReservationsResponse,ListReservationsPagedResponse>

mergeCapacityCommitmentsSettings()

public UnaryCallSettings<MergeCapacityCommitmentsRequest,CapacityCommitment> mergeCapacityCommitmentsSettings()

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

Returns
TypeDescription
UnaryCallSettings<MergeCapacityCommitmentsRequest,CapacityCommitment>

moveAssignmentSettings()

public UnaryCallSettings<MoveAssignmentRequest,Assignment> moveAssignmentSettings()

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

Returns
TypeDescription
UnaryCallSettings<MoveAssignmentRequest,Assignment>

searchAllAssignmentsSettings()

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

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

Returns
TypeDescription
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
TypeDescription
PagedCallSettings<SearchAssignmentsRequest,SearchAssignmentsResponse,SearchAssignmentsPagedResponse>

splitCapacityCommitmentSettings()

public UnaryCallSettings<SplitCapacityCommitmentRequest,SplitCapacityCommitmentResponse> splitCapacityCommitmentSettings()

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

Returns
TypeDescription
UnaryCallSettings<SplitCapacityCommitmentRequest,SplitCapacityCommitmentResponse>

toBuilder()

public ReservationServiceStubSettings.Builder toBuilder()

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

Returns
TypeDescription
ReservationServiceStubSettings.Builder
Overrides

updateAssignmentSettings()

public UnaryCallSettings<UpdateAssignmentRequest,Assignment> updateAssignmentSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateAssignmentRequest,Assignment>

updateBiReservationSettings()

public UnaryCallSettings<UpdateBiReservationRequest,BiReservation> updateBiReservationSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateBiReservationRequest,BiReservation>

updateCapacityCommitmentSettings()

public UnaryCallSettings<UpdateCapacityCommitmentRequest,CapacityCommitment> updateCapacityCommitmentSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateCapacityCommitmentRequest,CapacityCommitment>

updateReservationSettings()

public UnaryCallSettings<UpdateReservationRequest,Reservation> updateReservationSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateReservationRequest,Reservation>