Class GrafeasSettings (2.1.3)

public class GrafeasSettings extends ClientSettings<GrafeasSettings>

Settings class to configure an instance of GrafeasClient.

The default instance has everything set to sensible defaults:

The default service address (containeranalysis.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 getOccurrence to 30 seconds:


 GrafeasSettings.Builder grafeasSettingsBuilder = GrafeasSettings.newBuilder();
 grafeasSettingsBuilder
     .getOccurrenceSettings()
     .setRetrySettings(
         grafeasSettingsBuilder
             .getOccurrenceSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 GrafeasSettings grafeasSettings = grafeasSettingsBuilder.build();

Inheritance

java.lang.Object > ClientSettings > GrafeasSettings

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getWatchdogCheckInterval()

ClientSettings.getWatchdogProvider()

ClientSettings.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)

Constructors

GrafeasSettings(GrafeasSettings.Builder settingsBuilder)

protected GrafeasSettings(GrafeasSettings.Builder settingsBuilder)

Parameter

Name	Description
settingsBuilder	`GrafeasSettings.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>

create(GrafeasStubSettings stub)

public static final GrafeasSettings create(GrafeasStubSettings stub)

Parameter

Name	Description
stub	`GrafeasStubSettings`

Returns

Type	Description
GrafeasSettings

Exceptions

Type	Description
IOException

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>

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

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>

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns

Type	Description
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns

Type	Description
List<String>

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>

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>

newBuilder()

public static GrafeasSettings.Builder newBuilder()

Returns a new builder for this class.

Returns

Type	Description
GrafeasSettings.Builder

newBuilder(ClientContext clientContext)

public static GrafeasSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter

Name	Description
clientContext	`ClientContext`

Returns

Type	Description
GrafeasSettings.Builder

toBuilder()

public GrafeasSettings.Builder toBuilder()

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

Returns

Type	Description
GrafeasSettings.Builder

Overrides

ClientSettings<SettingsT>.<B>toBuilder()

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>