Class JobsStubSettings (0.34.0)

Version 0.34.0

• 0.52.0 (latest)
• 0.51.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.5
• 0.2.1
• 0.1.2

public class JobsStubSettings extends StubSettings<JobsStubSettings>

Settings class to configure an instance of JobsStub.

The default instance has everything set to sensible defaults:

• The default service address (run.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 getJob 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
 JobsStubSettings.Builder jobsSettingsBuilder = JobsStubSettings.newBuilder();
 jobsSettingsBuilder
     .getJobSettings()
     .setRetrySettings(
         jobsSettingsBuilder
             .getJobSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 JobsStubSettings jobsSettings = jobsSettingsBuilder.build();
 

Inheritance

java.lang.Object > StubSettings > JobsStubSettings

Inherited Members

StubSettings.getBackgroundExecutorProvider()

StubSettings.getClock()

StubSettings.getCredentialsProvider()

StubSettings.getEndpoint()

StubSettings.getExecutorProvider()

StubSettings.getGdchApiAudience()

StubSettings.getHeaderProvider()

StubSettings.getInternalHeaderProvider()

StubSettings.getMtlsEndpoint()

StubSettings.getQuotaProjectId()

StubSettings.getServiceName()

StubSettings.getStreamWatchdogCheckInterval()

StubSettings.getStreamWatchdogProvider()

StubSettings.getTracerFactory()

StubSettings.getTransportChannelProvider()

StubSettings.getUniverseDomain()

StubSettings.toBuilder()

StubSettings.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

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

defaultGrpcApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder()

Beta

The surface for customizing headers is not stable yet and may change in the future.

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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

defaultHttpJsonApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()

Beta

The surface for customizing headers is not stable yet and may change in the future.

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Returns
Type	Description
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Beta

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS 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 JobsStubSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type	Description
JobsStubSettings.Builder

newBuilder(ClientContext clientContext)

public static JobsStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
clientContext	ClientContext

Returns
Type	Description
JobsStubSettings.Builder

newHttpJsonBuilder()

public static JobsStubSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type	Description
JobsStubSettings.Builder

Constructors

JobsStubSettings(JobsStubSettings.Builder settingsBuilder)

protected JobsStubSettings(JobsStubSettings.Builder settingsBuilder)

Parameter
Name	Description
settingsBuilder	JobsStubSettings.Builder

Methods

createJobOperationSettings()

public OperationCallSettings<CreateJobRequest,Job,Job> createJobOperationSettings()

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

Returns
Type	Description
OperationCallSettings<CreateJobRequest,Job,Job>

createJobSettings()

public UnaryCallSettings<CreateJobRequest,Operation> createJobSettings()

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

Returns
Type	Description
UnaryCallSettings<CreateJobRequest,Operation>

createStub()

public JobsStub createStub()

Returns
Type	Description
JobsStub

Exceptions
Type	Description
IOException

deleteJobOperationSettings()

public OperationCallSettings<DeleteJobRequest,Job,Job> deleteJobOperationSettings()

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

Returns
Type	Description
OperationCallSettings<DeleteJobRequest,Job,Job>

deleteJobSettings()

public UnaryCallSettings<DeleteJobRequest,Operation> deleteJobSettings()

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

Returns
Type	Description
UnaryCallSettings<DeleteJobRequest,Operation>

getEndpoint()

public String getEndpoint()

Returns the endpoint set by the user or the the service's default endpoint.

Returns
Type	Description
String

Overrides

StubSettings<SettingsT>.getEndpoint()

getIamPolicySettings()

public UnaryCallSettings<GetIamPolicyRequest,Policy> getIamPolicySettings()

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

Returns
Type	Description
UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>

getJobSettings()

public UnaryCallSettings<GetJobRequest,Job> getJobSettings()

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

Returns
Type	Description
UnaryCallSettings<GetJobRequest,Job>

getServiceName()

public String getServiceName()

Returns the default service name.

Returns
Type	Description
String

Overrides

StubSettings<SettingsT>.getServiceName()

listJobsSettings()

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

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

Returns
Type	Description
PagedCallSettings<ListJobsRequest,ListJobsResponse,ListJobsPagedResponse>

runJobOperationSettings()

public OperationCallSettings<RunJobRequest,Execution,Execution> runJobOperationSettings()

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

Returns
Type	Description
OperationCallSettings<RunJobRequest,Execution,Execution>

runJobSettings()

public UnaryCallSettings<RunJobRequest,Operation> runJobSettings()

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

Returns
Type	Description
UnaryCallSettings<RunJobRequest,Operation>

setIamPolicySettings()

public UnaryCallSettings<SetIamPolicyRequest,Policy> setIamPolicySettings()

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

Returns
Type	Description
UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>

testIamPermissionsSettings()

public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()

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

Returns
Type	Description
UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>

toBuilder()

public JobsStubSettings.Builder toBuilder()

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

Returns
Type	Description
JobsStubSettings.Builder

Overrides

StubSettings<SettingsT>.toBuilder()

updateJobOperationSettings()

public OperationCallSettings<UpdateJobRequest,Job,Job> updateJobOperationSettings()

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

Returns
Type	Description
OperationCallSettings<UpdateJobRequest,Job,Job>

updateJobSettings()

public UnaryCallSettings<UpdateJobRequest,Operation> updateJobSettings()

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

Returns
Type	Description
UnaryCallSettings<UpdateJobRequest,Operation>