Class JobsV1Beta3Settings (0.57.0) 

public class JobsV1Beta3Settings extends ClientSettings<JobsV1Beta3Settings>

Settings class to configure an instance of JobsV1Beta3Client.

The default instance has everything set to sensible defaults:

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


 // 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
 JobsV1Beta3Settings.Builder jobsV1Beta3SettingsBuilder = JobsV1Beta3Settings.newBuilder();
 jobsV1Beta3SettingsBuilder
     .createJobSettings()
     .setRetrySettings(
         jobsV1Beta3SettingsBuilder
             .createJobSettings()
             .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());
 JobsV1Beta3Settings jobsV1Beta3Settings = jobsV1Beta3SettingsBuilder.build();

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

Inheritance

java.lang.Object > ClientSettings > JobsV1Beta3Settings

Static Methods

create(JobsV1Beta3StubSettings stub)

public static final JobsV1Beta3Settings create(JobsV1Beta3StubSettings stub)
Parameter
Name Description
stub JobsV1Beta3StubSettings
Returns
Type Description
JobsV1Beta3Settings
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 JobsV1Beta3Settings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type Description
JobsV1Beta3Settings.Builder

newBuilder(ClientContext clientContext)

public static JobsV1Beta3Settings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
JobsV1Beta3Settings.Builder

newHttpJsonBuilder()

public static JobsV1Beta3Settings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
JobsV1Beta3Settings.Builder

Constructors

JobsV1Beta3Settings(JobsV1Beta3Settings.Builder settingsBuilder)

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

Methods

aggregatedListJobsSettings()

public PagedCallSettings<ListJobsRequest,ListJobsResponse,JobsV1Beta3Client.AggregatedListJobsPagedResponse> aggregatedListJobsSettings()

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

Returns
Type Description
PagedCallSettings<ListJobsRequest,ListJobsResponse,AggregatedListJobsPagedResponse>

checkActiveJobsSettings()

public UnaryCallSettings<CheckActiveJobsRequest,CheckActiveJobsResponse> checkActiveJobsSettings()

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

Returns
Type Description
UnaryCallSettings<CheckActiveJobsRequest,CheckActiveJobsResponse>

createJobSettings()

public UnaryCallSettings<CreateJobRequest,Job> createJobSettings()

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

Returns
Type Description
UnaryCallSettings<CreateJobRequest,Job>

getJobSettings()

public UnaryCallSettings<GetJobRequest,Job> getJobSettings()

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

Returns
Type Description
UnaryCallSettings<GetJobRequest,Job>

listJobsSettings()

public PagedCallSettings<ListJobsRequest,ListJobsResponse,JobsV1Beta3Client.ListJobsPagedResponse> listJobsSettings()

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

Returns
Type Description
PagedCallSettings<ListJobsRequest,ListJobsResponse,ListJobsPagedResponse>

snapshotJobSettings()

public UnaryCallSettings<SnapshotJobRequest,Snapshot> snapshotJobSettings()

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

Returns
Type Description
UnaryCallSettings<SnapshotJobRequest,Snapshot>

toBuilder()

public JobsV1Beta3Settings.Builder toBuilder()

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

Returns
Type Description
JobsV1Beta3Settings.Builder
Overrides

updateJobSettings()

public UnaryCallSettings<UpdateJobRequest,Job> updateJobSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateJobRequest,Job>