Class GrafeasStubSettings (2.49.0) 

public class GrafeasStubSettings extends StubSettings<GrafeasStubSettings>

Settings class to configure an instance of GrafeasStub.

The default instance has everything set to sensible defaults:

  • 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 getOccurrence 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
 GrafeasStubSettings.Builder grafeasSettingsBuilder = GrafeasStubSettings.newBuilder();
 grafeasSettingsBuilder
     .getOccurrenceSettings()
     .setRetrySettings(
         grafeasSettingsBuilder
             .getOccurrenceSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 GrafeasStubSettings grafeasSettings = grafeasSettingsBuilder.build();

Inheritance

java.lang.Object > StubSettings > GrafeasStubSettings

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

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default 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 GrafeasStubSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
Type Description
GrafeasStubSettings.Builder

newBuilder(ClientContext clientContext)

public static GrafeasStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
GrafeasStubSettings.Builder

Constructors

GrafeasStubSettings(GrafeasStubSettings.Builder settingsBuilder)

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

Methods

batchCreateNotesSettings()

public UnaryCallSettings<BatchCreateNotesRequest,BatchCreateNotesResponse> batchCreateNotesSettings()

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

Returns
Type Description
UnaryCallSettings<BatchCreateNotesRequest,BatchCreateNotesResponse>

batchCreateOccurrencesSettings()

public UnaryCallSettings<BatchCreateOccurrencesRequest,BatchCreateOccurrencesResponse> batchCreateOccurrencesSettings()

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

Returns
Type Description
UnaryCallSettings<BatchCreateOccurrencesRequest,BatchCreateOccurrencesResponse>

createNoteSettings()

public UnaryCallSettings<CreateNoteRequest,Note> createNoteSettings()

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

Returns
Type Description
UnaryCallSettings<CreateNoteRequest,Note>

createOccurrenceSettings()

public UnaryCallSettings<CreateOccurrenceRequest,Occurrence> createOccurrenceSettings()

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

Returns
Type Description
UnaryCallSettings<CreateOccurrenceRequest,Occurrence>

createStub()

public GrafeasStub createStub()
Returns
Type Description
GrafeasStub
Exceptions
Type Description
IOException

deleteNoteSettings()

public UnaryCallSettings<DeleteNoteRequest,Empty> deleteNoteSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteNoteRequest,Empty>

deleteOccurrenceSettings()

public UnaryCallSettings<DeleteOccurrenceRequest,Empty> deleteOccurrenceSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteOccurrenceRequest,Empty>

getNoteSettings()

public UnaryCallSettings<GetNoteRequest,Note> getNoteSettings()

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

Returns
Type Description
UnaryCallSettings<GetNoteRequest,Note>

getOccurrenceNoteSettings()

public UnaryCallSettings<GetOccurrenceNoteRequest,Note> getOccurrenceNoteSettings()

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

Returns
Type Description
UnaryCallSettings<GetOccurrenceNoteRequest,Note>

getOccurrenceSettings()

public UnaryCallSettings<GetOccurrenceRequest,Occurrence> getOccurrenceSettings()

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

Returns
Type Description
UnaryCallSettings<GetOccurrenceRequest,Occurrence>

getServiceName()

public String getServiceName()

Returns the default service name.

Returns
Type Description
String
Overrides

listNoteOccurrencesSettings()

public PagedCallSettings<ListNoteOccurrencesRequest,ListNoteOccurrencesResponse,GrafeasClient.ListNoteOccurrencesPagedResponse> listNoteOccurrencesSettings()

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

Returns
Type Description
PagedCallSettings<ListNoteOccurrencesRequest,ListNoteOccurrencesResponse,ListNoteOccurrencesPagedResponse>

listNotesSettings()

public PagedCallSettings<ListNotesRequest,ListNotesResponse,GrafeasClient.ListNotesPagedResponse> listNotesSettings()

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

Returns
Type Description
PagedCallSettings<ListNotesRequest,ListNotesResponse,ListNotesPagedResponse>

listOccurrencesSettings()

public PagedCallSettings<ListOccurrencesRequest,ListOccurrencesResponse,GrafeasClient.ListOccurrencesPagedResponse> listOccurrencesSettings()

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

Returns
Type Description
PagedCallSettings<ListOccurrencesRequest,ListOccurrencesResponse,ListOccurrencesPagedResponse>

toBuilder()

public GrafeasStubSettings.Builder toBuilder()

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

Returns
Type Description
GrafeasStubSettings.Builder
Overrides

updateNoteSettings()

public UnaryCallSettings<UpdateNoteRequest,Note> updateNoteSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateNoteRequest,Note>

updateOccurrenceSettings()

public UnaryCallSettings<UpdateOccurrenceRequest,Occurrence> updateOccurrenceSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateOccurrenceRequest,Occurrence>