Class JobServiceStubSettings (2.7.0)

public class JobServiceStubSettings extends StubSettings<JobServiceStubSettings>

Settings class to configure an instance of JobServiceStub.

The default instance has everything set to sensible defaults:

  • The default service address (jobs.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
 JobServiceStubSettings.Builder jobServiceSettingsBuilder = JobServiceStubSettings.newBuilder();
 jobServiceSettingsBuilder
     .createJobSettings()
     .setRetrySettings(
         jobServiceSettingsBuilder.createJobSettings().getRetrySettings().toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 JobServiceStubSettings jobServiceSettings = jobServiceSettingsBuilder.build();
 

Inheritance

java.lang.Object > StubSettings > JobServiceStubSettings

Static Methods

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

defaultGrpcApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

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

Returns
TypeDescription
Builder

defaultHttpJsonApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

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

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static JobServiceStubSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns

newBuilder(ClientContext clientContext)

public static JobServiceStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns

newHttpJsonBuilder()

public static JobServiceStubSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns

Constructors

JobServiceStubSettings(JobServiceStubSettings.Builder settingsBuilder)

protected JobServiceStubSettings(JobServiceStubSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderJobServiceStubSettings.Builder

Methods

batchCreateJobsOperationSettings()

public OperationCallSettings<BatchCreateJobsRequest,BatchCreateJobsResponse,BatchOperationMetadata> batchCreateJobsOperationSettings()

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

Returns

batchCreateJobsSettings()

public UnaryCallSettings<BatchCreateJobsRequest,Operation> batchCreateJobsSettings()

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

Returns

batchDeleteJobsOperationSettings()

public OperationCallSettings<BatchDeleteJobsRequest,BatchDeleteJobsResponse,BatchOperationMetadata> batchDeleteJobsOperationSettings()

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

Returns

batchDeleteJobsSettings()

public UnaryCallSettings<BatchDeleteJobsRequest,Operation> batchDeleteJobsSettings()

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

Returns

batchUpdateJobsOperationSettings()

public OperationCallSettings<BatchUpdateJobsRequest,BatchUpdateJobsResponse,BatchOperationMetadata> batchUpdateJobsOperationSettings()

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

Returns

batchUpdateJobsSettings()

public UnaryCallSettings<BatchUpdateJobsRequest,Operation> batchUpdateJobsSettings()

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

Returns

createJobSettings()

public UnaryCallSettings<CreateJobRequest,Job> createJobSettings()

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

Returns

createStub()

public JobServiceStub createStub()
Returns
TypeDescription
JobServiceStub
Exceptions
TypeDescription
IOException

deleteJobSettings()

public UnaryCallSettings<DeleteJobRequest,Empty> deleteJobSettings()

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

Returns

getJobSettings()

public UnaryCallSettings<GetJobRequest,Job> getJobSettings()

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

Returns

listJobsSettings()

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

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

Returns

searchJobsForAlertSettings()

public UnaryCallSettings<SearchJobsRequest,SearchJobsResponse> searchJobsForAlertSettings()

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

Returns

searchJobsSettings()

public UnaryCallSettings<SearchJobsRequest,SearchJobsResponse> searchJobsSettings()

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

Returns

toBuilder()

public JobServiceStubSettings.Builder toBuilder()

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

Returns Overrides

updateJobSettings()

public UnaryCallSettings<UpdateJobRequest,Job> updateJobSettings()

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

Returns