Class JobsV1Beta3Settings

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 total timeout of createJob to 30 seconds:


 JobsV1Beta3Settings.Builder jobsV1Beta3SettingsBuilder = JobsV1Beta3Settings.newBuilder();
 jobsV1Beta3SettingsBuilder
     .createJobSettings()
     .setRetrySettings(
         jobsV1Beta3SettingsBuilder
             .createJobSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 JobsV1Beta3Settings jobsV1Beta3Settings = jobsV1Beta3SettingsBuilder.build();
 

Inheritance

java.lang.Object > ClientSettings > JobsV1Beta3Settings

Constructors

JobsV1Beta3Settings(JobsV1Beta3Settings.Builder settingsBuilder)

protected JobsV1Beta3Settings(JobsV1Beta3Settings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderJobsV1Beta3Settings.Builder

Methods

aggregatedListJobsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListJobsRequest,ListJobsResponse,AggregatedListJobsPagedResponse>

checkActiveJobsSettings()

public UnaryCallSettings<CheckActiveJobsRequest,CheckActiveJobsResponse> checkActiveJobsSettings()

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

Returns
TypeDescription
UnaryCallSettings<CheckActiveJobsRequest,CheckActiveJobsResponse>

create(JobsV1Beta3StubSettings stub)

public static final JobsV1Beta3Settings create(JobsV1Beta3StubSettings stub)
Parameter
NameDescription
stubJobsV1Beta3StubSettings
Returns
TypeDescription
JobsV1Beta3Settings
Exceptions
TypeDescription
IOException

createJobSettings()

public UnaryCallSettings<CreateJobRequest,Job> createJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateJobRequest,Job>

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>

getJobSettings()

public UnaryCallSettings<GetJobRequest,Job> getJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetJobRequest,Job>

listJobsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListJobsRequest,ListJobsResponse,ListJobsPagedResponse>

newBuilder()

public static JobsV1Beta3Settings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
JobsV1Beta3Settings.Builder

newBuilder(ClientContext clientContext)

public static JobsV1Beta3Settings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
JobsV1Beta3Settings.Builder

snapshotJobSettings()

public UnaryCallSettings<SnapshotJobRequest,Snapshot> snapshotJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<SnapshotJobRequest,Snapshot>

toBuilder()

public JobsV1Beta3Settings.Builder toBuilder()

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

Returns
TypeDescription
JobsV1Beta3Settings.Builder
Overrides

updateJobSettings()

public UnaryCallSettings<UpdateJobRequest,Job> updateJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateJobRequest,Job>