Class GrafeasStubSettings (2.74.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 RetrySettings of getOccurrence:

   
 // 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 
 () 
  
 . 
 setInitialRetryDelayDuration 
 ( 
 Duration 
 . 
 ofSeconds 
 ( 
 1 
 )) 
  
 . 
 setInitialRpcTimeoutDuration 
 ( 
 Duration 
 . 
 ofSeconds 
 ( 
 5 
 )) 
  
 . 
 setMaxAttempts 
 ( 
 5 
 ) 
  
 . 
 setMaxRetryDelayDuration 
 ( 
 Duration 
 . 
 ofSeconds 
 ( 
 30 
 )) 
  
 . 
 setMaxRpcTimeoutDuration 
 ( 
 Duration 
 . 
 ofSeconds 
 ( 
 60 
 )) 
  
 . 
 setRetryDelayMultiplier 
 ( 
 1.3 
 ) 
  
 . 
 setRpcTimeoutMultiplier 
 ( 
 1.5 
 ) 
  
 . 
 setTotalTimeoutDuration 
 ( 
 Duration 
 . 
 ofSeconds 
 ( 
 300 
 )) 
  
 . 
 build 
 ()); 
  
 GrafeasStubSettings 
  
 grafeasSettings 
  
 = 
  
 grafeasSettingsBuilder 
 . 
 build 
 (); 
  
 

Please refer to the Client Side Retry Guide for additional support in setting retries.

Inheritance

java.lang.Object > StubSettings > GrafeasStubSettings

Static Methods

defaultApiClientHeaderProviderBuilder()

  public 
  
 static 
  
 ApiClientHeaderProvider 
 . 
 Builder 
  
 defaultApiClientHeaderProviderBuilder 
 () 
 
Returns
Type
Description

defaultCredentialsProviderBuilder()

  public 
  
 static 
  
 GoogleCredentialsProvider 
 . 
 Builder 
  
 defaultCredentialsProviderBuilder 
 () 
 

Returns a builder for the default credentials for this service.

Returns
Type
Description

defaultExecutorProviderBuilder()

  public 
  
 static 
  
 InstantiatingExecutorProvider 
 . 
 Builder 
  
 defaultExecutorProviderBuilder 
 () 
 

Returns a builder for the default ExecutorProvider for this service.

Returns
Type
Description

defaultGrpcTransportProviderBuilder()

  public 
  
 static 
  
 InstantiatingGrpcChannelProvider 
 . 
 Builder 
  
 defaultGrpcTransportProviderBuilder 
 () 
 

Returns a builder for the default ChannelProvider for this service.

Returns
Type
Description

defaultTransportChannelProvider()

  public 
  
 static 
  
 TransportChannelProvider 
  
 defaultTransportChannelProvider 
 () 
 
Returns
Type
Description

getDefaultEndpoint()

  public 
  
 static 
  
 String 
  
 getDefaultEndpoint 
 () 
 

Returns the default service endpoint.

Returns
Type
Description

getDefaultMtlsEndpoint()

  public 
  
 static 
  
 String 
  
 getDefaultMtlsEndpoint 
 () 
 

Returns the default mTLS service endpoint.

Returns
Type
Description

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

newBuilder(ClientContext clientContext)

  public 
  
 static 
  
 GrafeasStubSettings 
 . 
 Builder 
  
 newBuilder 
 ( 
 ClientContext 
  
 clientContext 
 ) 
 

Returns a new builder for this class.

Parameter
Name
Description
clientContext
Returns
Type
Description

Constructors

GrafeasStubSettings(GrafeasStubSettings.Builder settingsBuilder)

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

Methods

batchCreateNotesSettings()

  public 
  
 UnaryCallSettings<BatchCreateNotesRequest 
 , 
 BatchCreateNotesResponse 
>  
 batchCreateNotesSettings 
 () 
 

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

batchCreateOccurrencesSettings()

  public 
  
 UnaryCallSettings<BatchCreateOccurrencesRequest 
 , 
 BatchCreateOccurrencesResponse 
>  
 batchCreateOccurrencesSettings 
 () 
 

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

createNoteSettings()

  public 
  
 UnaryCallSettings<CreateNoteRequest 
 , 
 Note 
>  
 createNoteSettings 
 () 
 

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

Returns
Type
Description

createOccurrenceSettings()

  public 
  
 UnaryCallSettings<CreateOccurrenceRequest 
 , 
 Occurrence 
>  
 createOccurrenceSettings 
 () 
 

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

Returns
Type
Description

createStub()

  public 
  
 GrafeasStub 
  
 createStub 
 () 
 
Returns
Type
Description
Exceptions
Type
Description

deleteNoteSettings()

  public 
  
 UnaryCallSettings<DeleteNoteRequest 
 , 
 Empty 
>  
 deleteNoteSettings 
 () 
 

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

Returns
Type
Description

deleteOccurrenceSettings()

  public 
  
 UnaryCallSettings<DeleteOccurrenceRequest 
 , 
 Empty 
>  
 deleteOccurrenceSettings 
 () 
 

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

Returns
Type
Description

getNoteSettings()

  public 
  
 UnaryCallSettings<GetNoteRequest 
 , 
 Note 
>  
 getNoteSettings 
 () 
 

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

Returns
Type
Description

getOccurrenceNoteSettings()

  public 
  
 UnaryCallSettings<GetOccurrenceNoteRequest 
 , 
 Note 
>  
 getOccurrenceNoteSettings 
 () 
 

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

Returns
Type
Description

getOccurrenceSettings()

  public 
  
 UnaryCallSettings<GetOccurrenceRequest 
 , 
 Occurrence 
>  
 getOccurrenceSettings 
 () 
 

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

Returns
Type
Description

getServiceName()

  public 
  
 String 
  
 getServiceName 
 () 
 

Returns the default service name.

Returns
Type
Description
Overrides

listNoteOccurrencesSettings()

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

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

listNotesSettings()

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

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

listOccurrencesSettings()

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

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

toBuilder()

  public 
  
 GrafeasStubSettings 
 . 
 Builder 
  
 toBuilder 
 () 
 

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

Returns
Type
Description
Overrides

updateNoteSettings()

  public 
  
 UnaryCallSettings<UpdateNoteRequest 
 , 
 Note 
>  
 updateNoteSettings 
 () 
 

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

Returns
Type
Description

updateOccurrenceSettings()

  public 
  
 UnaryCallSettings<UpdateOccurrenceRequest 
 , 
 Occurrence 
>  
 updateOccurrenceSettings 
 () 
 

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

Returns
Type
Description
Create a Mobile Website
View Site in Mobile | Classic
Share by: