Class DocumentsSettings (4.6.0)

public class DocumentsSettings extends ClientSettings<DocumentsSettings>

Settings class to configure an instance of DocumentsClient.

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:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 DocumentsSettings.Builder documentsSettingsBuilder = DocumentsSettings.newBuilder();
 documentsSettingsBuilder
     .getDocumentSettings()
     .setRetrySettings(
         documentsSettingsBuilder
             .getDocumentSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 DocumentsSettings documentsSettings = documentsSettingsBuilder.build();
 

Inheritance

java.lang.Object > ClientSettings > DocumentsSettings

Static Methods

create(DocumentsStubSettings stub)

public static final DocumentsSettings create(DocumentsStubSettings stub)
Parameter
Name Description
stub DocumentsStubSettings
Returns
Type Description
DocumentsSettings
Exceptions
Type Description
IOException

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

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
Type Description
List<String>

newBuilder()

public static DocumentsSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
Type Description
DocumentsSettings.Builder

newBuilder(ClientContext clientContext)

public static DocumentsSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
DocumentsSettings.Builder

Constructors

DocumentsSettings(DocumentsSettings.Builder settingsBuilder)

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

Methods

createDocumentOperationSettings()

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

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

Returns
Type Description
OperationCallSettings<CreateDocumentRequest,Document,KnowledgeOperationMetadata>

createDocumentSettings()

public UnaryCallSettings<CreateDocumentRequest,Operation> createDocumentSettings()

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

Returns
Type Description
UnaryCallSettings<CreateDocumentRequest,Operation>

deleteDocumentOperationSettings()

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

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

Returns
Type Description
OperationCallSettings<DeleteDocumentRequest,Empty,KnowledgeOperationMetadata>

deleteDocumentSettings()

public UnaryCallSettings<DeleteDocumentRequest,Operation> deleteDocumentSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteDocumentRequest,Operation>

exportDocumentOperationSettings()

public OperationCallSettings<ExportDocumentRequest,Document,KnowledgeOperationMetadata> exportDocumentOperationSettings()

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

Returns
Type Description
OperationCallSettings<ExportDocumentRequest,Document,KnowledgeOperationMetadata>

exportDocumentSettings()

public UnaryCallSettings<ExportDocumentRequest,Operation> exportDocumentSettings()

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

Returns
Type Description
UnaryCallSettings<ExportDocumentRequest,Operation>

getDocumentSettings()

public UnaryCallSettings<GetDocumentRequest,Document> getDocumentSettings()

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

Returns
Type Description
UnaryCallSettings<GetDocumentRequest,Document>

importDocumentsOperationSettings()

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

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

Returns
Type Description
OperationCallSettings<ImportDocumentsRequest,ImportDocumentsResponse,KnowledgeOperationMetadata>

importDocumentsSettings()

public UnaryCallSettings<ImportDocumentsRequest,Operation> importDocumentsSettings()

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

Returns
Type Description
UnaryCallSettings<ImportDocumentsRequest,Operation>

listDocumentsSettings()

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

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

Returns
Type Description
PagedCallSettings<ListDocumentsRequest,ListDocumentsResponse,ListDocumentsPagedResponse>

reloadDocumentOperationSettings()

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

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

Returns
Type Description
OperationCallSettings<ReloadDocumentRequest,Document,KnowledgeOperationMetadata>

reloadDocumentSettings()

public UnaryCallSettings<ReloadDocumentRequest,Operation> reloadDocumentSettings()

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

Returns
Type Description
UnaryCallSettings<ReloadDocumentRequest,Operation>

toBuilder()

public DocumentsSettings.Builder toBuilder()

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

Returns
Type Description
DocumentsSettings.Builder
Overrides

updateDocumentOperationSettings()

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

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

Returns
Type Description
OperationCallSettings<UpdateDocumentRequest,Document,KnowledgeOperationMetadata>

updateDocumentSettings()

public UnaryCallSettings<UpdateDocumentRequest,Operation> updateDocumentSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateDocumentRequest,Operation>