com.google.dataflow.v1beta3

Class JobsV1Beta3Settings

java.lang.Object

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

com.google.dataflow.v1beta3.JobsV1Beta3Settings

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

 // 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()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 JobsV1Beta3Settings jobsV1Beta3Settings = jobsV1Beta3SettingsBuilder.build();
 

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
com.google.api.gax.rpc.PagedCallSettings<ListJobsRequest,ListJobsResponse,JobsV1Beta3Client.AggregatedListJobsPagedResponse>	aggregatedListJobsSettings() Returns the object with the settings used for calls to aggregatedListJobs.
com.google.api.gax.rpc.UnaryCallSettings<CheckActiveJobsRequest,CheckActiveJobsResponse>	checkActiveJobsSettings() Returns the object with the settings used for calls to checkActiveJobs.
static JobsV1Beta3Settings	create(JobsV1Beta3StubSettings stub)
com.google.api.gax.rpc.UnaryCallSettings<CreateJobRequest,Job>	createJobSettings() Returns the object with the settings used for calls to createJob.
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()
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
com.google.api.gax.rpc.UnaryCallSettings<GetJobRequest,Job>	getJobSettings() Returns the object with the settings used for calls to getJob.
com.google.api.gax.rpc.PagedCallSettings<ListJobsRequest,ListJobsResponse,JobsV1Beta3Client.ListJobsPagedResponse>	listJobsSettings() Returns the object with the settings used for calls to listJobs.
static JobsV1Beta3Settings.Builder	newBuilder() Returns a new gRPC builder for this class.
static JobsV1Beta3Settings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
static JobsV1Beta3Settings.Builder	newHttpJsonBuilder() Returns a new REST builder for this class.
com.google.api.gax.rpc.UnaryCallSettings<SnapshotJobRequest,Snapshot>	snapshotJobSettings() Returns the object with the settings used for calls to snapshotJob.
JobsV1Beta3Settings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
com.google.api.gax.rpc.UnaryCallSettings<UpdateJobRequest,Job>	updateJobSettings() Returns the object with the settings used for calls to updateJob.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

JobsV1Beta3Settings

protected JobsV1Beta3Settings(JobsV1Beta3Settings.Builder settingsBuilder)
                       throws IOException

Throws:

IOException

Method Detail

createJobSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateJobRequest,Job> createJobSettings()

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

getJobSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetJobRequest,Job> getJobSettings()

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

updateJobSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateJobRequest,Job> updateJobSettings()

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

listJobsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListJobsRequest,ListJobsResponse,JobsV1Beta3Client.ListJobsPagedResponse> listJobsSettings()

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

aggregatedListJobsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListJobsRequest,ListJobsResponse,JobsV1Beta3Client.AggregatedListJobsPagedResponse> aggregatedListJobsSettings()

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

checkActiveJobsSettings

public com.google.api.gax.rpc.UnaryCallSettings<CheckActiveJobsRequest,CheckActiveJobsResponse> checkActiveJobsSettings()

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

snapshotJobSettings

public com.google.api.gax.rpc.UnaryCallSettings<SnapshotJobRequest,Snapshot> snapshotJobSettings()

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

create

public static final JobsV1Beta3Settings create(JobsV1Beta3StubSettings 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

public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static JobsV1Beta3Settings.Builder newBuilder()

Returns a new gRPC builder for this class.

newHttpJsonBuilder

public static JobsV1Beta3Settings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

newBuilder

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

Returns a new builder for this class.

toBuilder

public JobsV1Beta3Settings.Builder toBuilder()

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

Specified by:

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