com.google.cloud.bigquery.reservation.v1

Class ReservationServiceSettings

java.lang.Object

com.google.api.gax.rpc.ClientSettings<ReservationServiceSettings>

com.google.cloud.bigquery.reservation.v1.ReservationServiceSettings

@Generated(value="by gapic-generator-java")
public class ReservationServiceSettings
extends com.google.api.gax.rpc.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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReservationServiceSettings.Builder Builder for ReservationServiceSettings.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ReservationServiceSettings(ReservationServiceSettings.Builder settingsBuilder)

Method Summary

Modifier and Type	Method and Description
static ReservationServiceSettings	create(ReservationServiceStubSettings stub)
com.google.api.gax.rpc.UnaryCallSettings<CreateAssignmentRequest,Assignment>	createAssignmentSettings() Returns the object with the settings used for calls to createAssignment.
com.google.api.gax.rpc.UnaryCallSettings<CreateCapacityCommitmentRequest,CapacityCommitment>	createCapacityCommitmentSettings() Returns the object with the settings used for calls to createCapacityCommitment.
com.google.api.gax.rpc.UnaryCallSettings<CreateReservationRequest,Reservation>	createReservationSettings() Returns the object with the settings used for calls to createReservation.
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static com.google.api.gax.core.GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static com.google.api.gax.core.InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder() Returns a builder for the default gRPC ChannelProvider for this service.
static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder	defaultHttpJsonTransportProviderBuilder() Returns a builder for the default REST ChannelProvider for this service.
static com.google.api.gax.rpc.TransportChannelProvider	defaultTransportChannelProvider()
com.google.api.gax.rpc.UnaryCallSettings<DeleteAssignmentRequest,com.google.protobuf.Empty>	deleteAssignmentSettings() Returns the object with the settings used for calls to deleteAssignment.
com.google.api.gax.rpc.UnaryCallSettings<DeleteCapacityCommitmentRequest,com.google.protobuf.Empty>	deleteCapacityCommitmentSettings() Returns the object with the settings used for calls to deleteCapacityCommitment.
com.google.api.gax.rpc.UnaryCallSettings<DeleteReservationRequest,com.google.protobuf.Empty>	deleteReservationSettings() Returns the object with the settings used for calls to deleteReservation.
com.google.api.gax.rpc.UnaryCallSettings<GetBiReservationRequest,BiReservation>	getBiReservationSettings() Returns the object with the settings used for calls to getBiReservation.
com.google.api.gax.rpc.UnaryCallSettings<GetCapacityCommitmentRequest,CapacityCommitment>	getCapacityCommitmentSettings() Returns the object with the settings used for calls to getCapacityCommitment.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
com.google.api.gax.rpc.UnaryCallSettings<GetReservationRequest,Reservation>	getReservationSettings() Returns the object with the settings used for calls to getReservation.
com.google.api.gax.rpc.PagedCallSettings<ListAssignmentsRequest,ListAssignmentsResponse,ReservationServiceClient.ListAssignmentsPagedResponse>	listAssignmentsSettings() Returns the object with the settings used for calls to listAssignments.
com.google.api.gax.rpc.PagedCallSettings<ListCapacityCommitmentsRequest,ListCapacityCommitmentsResponse,ReservationServiceClient.ListCapacityCommitmentsPagedResponse>	listCapacityCommitmentsSettings() Returns the object with the settings used for calls to listCapacityCommitments.
com.google.api.gax.rpc.PagedCallSettings<ListReservationsRequest,ListReservationsResponse,ReservationServiceClient.ListReservationsPagedResponse>	listReservationsSettings() Returns the object with the settings used for calls to listReservations.
com.google.api.gax.rpc.UnaryCallSettings<MergeCapacityCommitmentsRequest,CapacityCommitment>	mergeCapacityCommitmentsSettings() Returns the object with the settings used for calls to mergeCapacityCommitments.
com.google.api.gax.rpc.UnaryCallSettings<MoveAssignmentRequest,Assignment>	moveAssignmentSettings() Returns the object with the settings used for calls to moveAssignment.
static ReservationServiceSettings.Builder	newBuilder() Returns a new gRPC builder for this class.
static ReservationServiceSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
static ReservationServiceSettings.Builder	newHttpJsonBuilder() Returns a new REST builder for this class.
com.google.api.gax.rpc.PagedCallSettings<SearchAllAssignmentsRequest,SearchAllAssignmentsResponse,ReservationServiceClient.SearchAllAssignmentsPagedResponse>	searchAllAssignmentsSettings() Returns the object with the settings used for calls to searchAllAssignments.
com.google.api.gax.rpc.PagedCallSettings<SearchAssignmentsRequest,SearchAssignmentsResponse,ReservationServiceClient.SearchAssignmentsPagedResponse>	searchAssignmentsSettings() Deprecated. This method is deprecated and will be removed in the next major version update.
com.google.api.gax.rpc.UnaryCallSettings<SplitCapacityCommitmentRequest,SplitCapacityCommitmentResponse>	splitCapacityCommitmentSettings() Returns the object with the settings used for calls to splitCapacityCommitment.
ReservationServiceSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
com.google.api.gax.rpc.UnaryCallSettings<UpdateAssignmentRequest,Assignment>	updateAssignmentSettings() Returns the object with the settings used for calls to updateAssignment.
com.google.api.gax.rpc.UnaryCallSettings<UpdateBiReservationRequest,BiReservation>	updateBiReservationSettings() Returns the object with the settings used for calls to updateBiReservation.
com.google.api.gax.rpc.UnaryCallSettings<UpdateCapacityCommitmentRequest,CapacityCommitment>	updateCapacityCommitmentSettings() Returns the object with the settings used for calls to updateCapacityCommitment.
com.google.api.gax.rpc.UnaryCallSettings<UpdateReservationRequest,Reservation>	updateReservationSettings() Returns the object with the settings used for calls to updateReservation.

Methods inherited from class com.google.api.gax.rpc.ClientSettings

getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getWatchdogCheckInterval, getWatchdogProvider, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ReservationServiceSettings

protected ReservationServiceSettings(ReservationServiceSettings.Builder settingsBuilder)
                              throws IOException

Throws:

IOException

Method Detail

createReservationSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateReservationRequest,Reservation> createReservationSettings()

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

listReservationsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListReservationsRequest,ListReservationsResponse,ReservationServiceClient.ListReservationsPagedResponse> listReservationsSettings()

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

getReservationSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetReservationRequest,Reservation> getReservationSettings()

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

deleteReservationSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteReservationRequest,com.google.protobuf.Empty> deleteReservationSettings()

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

updateReservationSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateReservationRequest,Reservation> updateReservationSettings()

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

createCapacityCommitmentSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateCapacityCommitmentRequest,CapacityCommitment> createCapacityCommitmentSettings()

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

listCapacityCommitmentsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListCapacityCommitmentsRequest,ListCapacityCommitmentsResponse,ReservationServiceClient.ListCapacityCommitmentsPagedResponse> listCapacityCommitmentsSettings()

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

getCapacityCommitmentSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetCapacityCommitmentRequest,CapacityCommitment> getCapacityCommitmentSettings()

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

deleteCapacityCommitmentSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteCapacityCommitmentRequest,com.google.protobuf.Empty> deleteCapacityCommitmentSettings()

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

updateCapacityCommitmentSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateCapacityCommitmentRequest,CapacityCommitment> updateCapacityCommitmentSettings()

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

splitCapacityCommitmentSettings

public com.google.api.gax.rpc.UnaryCallSettings<SplitCapacityCommitmentRequest,SplitCapacityCommitmentResponse> splitCapacityCommitmentSettings()

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

mergeCapacityCommitmentsSettings

public com.google.api.gax.rpc.UnaryCallSettings<MergeCapacityCommitmentsRequest,CapacityCommitment> mergeCapacityCommitmentsSettings()

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

createAssignmentSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateAssignmentRequest,Assignment> createAssignmentSettings()

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

listAssignmentsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListAssignmentsRequest,ListAssignmentsResponse,ReservationServiceClient.ListAssignmentsPagedResponse> listAssignmentsSettings()

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

deleteAssignmentSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteAssignmentRequest,com.google.protobuf.Empty> deleteAssignmentSettings()

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

searchAssignmentsSettings

@Deprecated
public com.google.api.gax.rpc.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.

searchAllAssignmentsSettings

public com.google.api.gax.rpc.PagedCallSettings<SearchAllAssignmentsRequest,SearchAllAssignmentsResponse,ReservationServiceClient.SearchAllAssignmentsPagedResponse> searchAllAssignmentsSettings()

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

moveAssignmentSettings

public com.google.api.gax.rpc.UnaryCallSettings<MoveAssignmentRequest,Assignment> moveAssignmentSettings()

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

updateAssignmentSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateAssignmentRequest,Assignment> updateAssignmentSettings()

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

getBiReservationSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetBiReservationRequest,BiReservation> getBiReservationSettings()

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

updateBiReservationSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateBiReservationRequest,BiReservation> updateBiReservationSettings()

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

create

public static final ReservationServiceSettings create(ReservationServiceStubSettings stub)
                                               throws IOException

Throws:

IOException

defaultExecutorProviderBuilder

public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

getDefaultEndpoint

public static String getDefaultEndpoint()

Returns the default service endpoint.

getDefaultServiceScopes

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

defaultCredentialsProviderBuilder

public static com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultGrpcTransportProviderBuilder

public static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

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

defaultHttpJsonTransportProviderBuilder

@BetaApi
public static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

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

defaultTransportChannelProvider

public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

@BetaApi(value="The surface for customizing headers is not stable yet and may change in the future.")
public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static ReservationServiceSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

newHttpJsonBuilder

@BetaApi
public static ReservationServiceSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

newBuilder

public static ReservationServiceSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public ReservationServiceSettings.Builder toBuilder()

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

Specified by:

toBuilder in class com.google.api.gax.rpc.ClientSettings<ReservationServiceSettings>