Class DocumentsStubSettings (4.3.1)

public class DocumentsStubSettings extends StubSettings<DocumentsStubSettings>

Settings class to configure an instance of DocumentsStub.

The default instance has everything set to sensible defaults:

  • The default service address (dialogflow.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 getDocument to 30 seconds:


 
DocumentsStubSettings.Builder documentsSettingsBuilder = DocumentsStubSettings.newBuilder();
 documentsSettingsBuilder
     
.getDocumentSettings()
     
.setRetrySettings(
         documentsSettingsBuilder
             
.getDocumentSettings()
             
.getRetrySettings()
             
.toBuilder()
             
.setTotalTimeout(Duration.ofSeconds(30))
             
.build());
 
DocumentsStubSettings documentsSettings = documentsSettingsBuilder.build();
 

Inheritance

java.lang.Object > StubSettings > DocumentsStubSettings

Constructors

DocumentsStubSettings(DocumentsStubSettings.Builder settingsBuilder)

protected DocumentsStubSettings(DocumentsStubSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderDocumentsStubSettings.Builder

Methods

createDocumentOperationSettings()

public OperationCallSettings<CreateDocumentRequest,Document,KnowledgeOperationMetadata> createDocumentOperationSettings()

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

Returns

createDocumentSettings()

public UnaryCallSettings<CreateDocumentRequest,Operation> createDocumentSettings()

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

Returns

createStub()

public DocumentsStub createStub()
Returns
TypeDescription
DocumentsStub
Exceptions
TypeDescription
IOException

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

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns

deleteDocumentOperationSettings()

public OperationCallSettings<DeleteDocumentRequest,Empty,KnowledgeOperationMetadata> deleteDocumentOperationSettings()

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

Returns

deleteDocumentSettings()

public UnaryCallSettings<DeleteDocumentRequest,Operation> deleteDocumentSettings()

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

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>

getDocumentSettings()

public UnaryCallSettings<GetDocumentRequest,Document> getDocumentSettings()

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

Returns

importDocumentsOperationSettings()

public OperationCallSettings<ImportDocumentsRequest,ImportDocumentsResponse,KnowledgeOperationMetadata> importDocumentsOperationSettings()

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

Returns

importDocumentsSettings()

public UnaryCallSettings<ImportDocumentsRequest,Operation> importDocumentsSettings()

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

Returns

listDocumentsSettings()

public PagedCallSettings<ListDocumentsRequest,ListDocumentsResponse,DocumentsClient.ListDocumentsPagedResponse> listDocumentsSettings()

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

Returns

newBuilder()

public static DocumentsStubSettings.Builder newBuilder()

Returns a new builder for this class.

Returns

newBuilder(ClientContext clientContext)

public static DocumentsStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns

reloadDocumentOperationSettings()

public OperationCallSettings<ReloadDocumentRequest,Document,KnowledgeOperationMetadata> reloadDocumentOperationSettings()

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

Returns

reloadDocumentSettings()

public UnaryCallSettings<ReloadDocumentRequest,Operation> reloadDocumentSettings()

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

Returns

toBuilder()

public DocumentsStubSettings.Builder toBuilder()

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

Returns Overrides

updateDocumentOperationSettings()

public OperationCallSettings<UpdateDocumentRequest,Document,KnowledgeOperationMetadata> updateDocumentOperationSettings()

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

Returns

updateDocumentSettings()

public UnaryCallSettings<UpdateDocumentRequest,Operation> updateDocumentSettings()

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

Returns