io.grafeas.v1

Class GrafeasSettings

java.lang.Object

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

io.grafeas.v1.GrafeasSettings

@Generated(value="by gapic-generator")
 @BetaApi
public class GrafeasSettings
extends com.google.api.gax.rpc.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().getRetrySettings().toBuilder()
     .setTotalTimeout(Duration.ofSeconds(30));
 GrafeasSettings grafeasSettings = grafeasSettingsBuilder.build();
 
 

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
com.google.api.gax.rpc.UnaryCallSettings<BatchCreateNotesRequest,BatchCreateNotesResponse>	batchCreateNotesSettings() Returns the object with the settings used for calls to batchCreateNotes.
com.google.api.gax.rpc.UnaryCallSettings<BatchCreateOccurrencesRequest,BatchCreateOccurrencesResponse>	batchCreateOccurrencesSettings() Returns the object with the settings used for calls to batchCreateOccurrences.
static GrafeasSettings	create(GrafeasStubSettings stub)
com.google.api.gax.rpc.UnaryCallSettings<CreateNoteRequest,Note>	createNoteSettings() Returns the object with the settings used for calls to createNote.
com.google.api.gax.rpc.UnaryCallSettings<CreateOccurrenceRequest,Occurrence>	createOccurrenceSettings() Returns the object with the settings used for calls to createOccurrence.
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 ChannelProvider for this service.
static com.google.api.gax.rpc.TransportChannelProvider	defaultTransportChannelProvider()
com.google.api.gax.rpc.UnaryCallSettings<DeleteNoteRequest,Empty>	deleteNoteSettings() Returns the object with the settings used for calls to deleteNote.
com.google.api.gax.rpc.UnaryCallSettings<DeleteOccurrenceRequest,Empty>	deleteOccurrenceSettings() Returns the object with the settings used for calls to deleteOccurrence.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
com.google.api.gax.rpc.UnaryCallSettings<GetNoteRequest,Note>	getNoteSettings() Returns the object with the settings used for calls to getNote.
com.google.api.gax.rpc.UnaryCallSettings<GetOccurrenceNoteRequest,Note>	getOccurrenceNoteSettings() Returns the object with the settings used for calls to getOccurrenceNote.
com.google.api.gax.rpc.UnaryCallSettings<GetOccurrenceRequest,Occurrence>	getOccurrenceSettings() Returns the object with the settings used for calls to getOccurrence.
com.google.api.gax.rpc.PagedCallSettings<ListNoteOccurrencesRequest,ListNoteOccurrencesResponse,GrafeasClient.ListNoteOccurrencesPagedResponse>	listNoteOccurrencesSettings() Returns the object with the settings used for calls to listNoteOccurrences.
com.google.api.gax.rpc.PagedCallSettings<ListNotesRequest,ListNotesResponse,GrafeasClient.ListNotesPagedResponse>	listNotesSettings() Returns the object with the settings used for calls to listNotes.
com.google.api.gax.rpc.PagedCallSettings<ListOccurrencesRequest,ListOccurrencesResponse,GrafeasClient.ListOccurrencesPagedResponse>	listOccurrencesSettings() Returns the object with the settings used for calls to listOccurrences.
static GrafeasSettings.Builder	newBuilder() Returns a new builder for this class.
static GrafeasSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
GrafeasSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
com.google.api.gax.rpc.UnaryCallSettings<UpdateNoteRequest,Note>	updateNoteSettings() Returns the object with the settings used for calls to updateNote.
com.google.api.gax.rpc.UnaryCallSettings<UpdateOccurrenceRequest,Occurrence>	updateOccurrenceSettings() Returns the object with the settings used for calls to updateOccurrence.

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

getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getHeaderProvider, getInternalHeaderProvider, getStubSettings, getTransportChannelProvider, getWatchdogCheckInterval, getWatchdogProvider, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

GrafeasSettings

protected GrafeasSettings(GrafeasSettings.Builder settingsBuilder)
                   throws IOException

Throws:

IOException

Method Detail

getOccurrenceSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetOccurrenceRequest,Occurrence> getOccurrenceSettings()

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

listOccurrencesSettings

public com.google.api.gax.rpc.PagedCallSettings<ListOccurrencesRequest,ListOccurrencesResponse,GrafeasClient.ListOccurrencesPagedResponse> listOccurrencesSettings()

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

deleteOccurrenceSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteOccurrenceRequest,Empty> deleteOccurrenceSettings()

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

createOccurrenceSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateOccurrenceRequest,Occurrence> createOccurrenceSettings()

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

batchCreateOccurrencesSettings

public com.google.api.gax.rpc.UnaryCallSettings<BatchCreateOccurrencesRequest,BatchCreateOccurrencesResponse> batchCreateOccurrencesSettings()

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

updateOccurrenceSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateOccurrenceRequest,Occurrence> updateOccurrenceSettings()

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

getOccurrenceNoteSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetOccurrenceNoteRequest,Note> getOccurrenceNoteSettings()

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

getNoteSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetNoteRequest,Note> getNoteSettings()

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

listNotesSettings

public com.google.api.gax.rpc.PagedCallSettings<ListNotesRequest,ListNotesResponse,GrafeasClient.ListNotesPagedResponse> listNotesSettings()

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

deleteNoteSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteNoteRequest,Empty> deleteNoteSettings()

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

createNoteSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateNoteRequest,Note> createNoteSettings()

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

batchCreateNotesSettings

public com.google.api.gax.rpc.UnaryCallSettings<BatchCreateNotesRequest,BatchCreateNotesResponse> batchCreateNotesSettings()

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

updateNoteSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateNoteRequest,Note> updateNoteSettings()

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

listNoteOccurrencesSettings

public com.google.api.gax.rpc.PagedCallSettings<ListNoteOccurrencesRequest,ListNoteOccurrencesResponse,GrafeasClient.ListNoteOccurrencesPagedResponse> listNoteOccurrencesSettings()

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

create

public static final GrafeasSettings create(GrafeasStubSettings 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 ChannelProvider for this service.

defaultTransportChannelProvider

public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

@BetaApi(value="The surface for customizing headers is not stable yet and may change in the future.")
public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static GrafeasSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

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

Returns a new builder for this class.

toBuilder

public GrafeasSettings.Builder toBuilder()

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

Specified by:

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