Class DocumentsStubSettings (4.49.0)
Version 4.49.0keyboard_arrow_down
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:
// 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
DocumentsStubSettings . Builder documentsSettingsBuilder = DocumentsStubSettings . newBuilder ();
documentsSettingsBuilder
. getDocumentSettings ()
. setRetrySettings (
documentsSettingsBuilder
. getDocumentSettings ()
. getRetrySettings ()
. toBuilder ()
. setTotalTimeout ( Duration . ofSeconds ( 30 ))
. build ());
DocumentsStubSettings documentsSettings = documentsSettingsBuilder . build ();
Static Methods
public static ApiClientHeaderProvider . Builder defaultApiClientHeaderProviderBuilder ()
defaultCredentialsProviderBuilder()
public static GoogleCredentialsProvider . Builder defaultCredentialsProviderBuilder ()
Returns a builder for the default credentials for this service.
defaultExecutorProviderBuilder()
public static InstantiatingExecutorProvider . Builder defaultExecutorProviderBuilder ()
Returns a builder for the default ExecutorProvider for this service.
public static ApiClientHeaderProvider . Builder defaultGrpcApiClientHeaderProviderBuilder ()
defaultGrpcTransportProviderBuilder()
public static InstantiatingGrpcChannelProvider . Builder defaultGrpcTransportProviderBuilder ()
Returns a builder for the default gRPC ChannelProvider for this service.
public static ApiClientHeaderProvider . Builder defaultHttpJsonApiClientHeaderProviderBuilder ()
defaultHttpJsonTransportProviderBuilder()
public static InstantiatingHttpJsonChannelProvider . Builder defaultHttpJsonTransportProviderBuilder ()
Beta
This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.
Returns a builder for the default REST ChannelProvider for this service.
defaultTransportChannelProvider()
public static TransportChannelProvider defaultTransportChannelProvider ()
getDefaultEndpoint()
public static String getDefaultEndpoint ()
Returns the default service endpoint.
Returns
Type Description
String
getDefaultMtlsEndpoint()
public static String getDefaultMtlsEndpoint ()
Returns the default mTLS service endpoint.
Returns
Type Description
String
getDefaultServiceScopes()
public static List<String> getDefaultServiceScopes ()
Returns the default service scopes.
newBuilder()
public static DocumentsStubSettings . Builder newBuilder ()
Returns a new gRPC builder for this class.
newBuilder(ClientContext clientContext)
public static DocumentsStubSettings . Builder newBuilder ( ClientContext clientContext )
Returns a new builder for this class.
newHttpJsonBuilder()
public static DocumentsStubSettings . Builder newHttpJsonBuilder ()
Returns a new REST builder for this class.
Constructors
DocumentsStubSettings(DocumentsStubSettings.Builder settingsBuilder)
protected DocumentsStubSettings ( DocumentsStubSettings . Builder settingsBuilder )
Methods
createDocumentOperationSettings()
public OperationCallSettings<CreateDocumentRequest , Document , KnowledgeOperationMetadata > createDocumentOperationSettings ()
Returns the object with the settings used for calls to createDocument.
createDocumentSettings()
public UnaryCallSettings<CreateDocumentRequest , Operation > createDocumentSettings ()
Returns the object with the settings used for calls to createDocument.
createStub()
public DocumentsStub createStub ()
deleteDocumentOperationSettings()
public OperationCallSettings<DeleteDocumentRequest , Empty , KnowledgeOperationMetadata > deleteDocumentOperationSettings ()
Returns the object with the settings used for calls to deleteDocument.
deleteDocumentSettings()
public UnaryCallSettings<DeleteDocumentRequest , Operation > deleteDocumentSettings ()
Returns the object with the settings used for calls to deleteDocument.
exportDocumentOperationSettings()
public OperationCallSettings<ExportDocumentRequest , Document , KnowledgeOperationMetadata > exportDocumentOperationSettings ()
Returns the object with the settings used for calls to exportDocument.
exportDocumentSettings()
public UnaryCallSettings<ExportDocumentRequest , Operation > exportDocumentSettings ()
Returns the object with the settings used for calls to exportDocument.
getDocumentSettings()
public UnaryCallSettings<GetDocumentRequest , Document > getDocumentSettings ()
Returns the object with the settings used for calls to getDocument.
getLocationSettings()
public UnaryCallSettings<GetLocationRequest , Location > getLocationSettings ()
Returns the object with the settings used for calls to getLocation.
Returns
Type Description
UnaryCallSettings <com.google.cloud.location.GetLocationRequest ,com.google.cloud.location.Location >
getServiceName()
public String getServiceName ()
Returns the default service name.
Returns
Type Description
String
Overrides
importDocumentsOperationSettings()
public OperationCallSettings<ImportDocumentsRequest , ImportDocumentsResponse , KnowledgeOperationMetadata > importDocumentsOperationSettings ()
Returns the object with the settings used for calls to importDocuments.
importDocumentsSettings()
public UnaryCallSettings<ImportDocumentsRequest , Operation > importDocumentsSettings ()
Returns the object with the settings used for calls to importDocuments.
listDocumentsSettings()
public PagedCallSettings<ListDocumentsRequest , ListDocumentsResponse , DocumentsClient . ListDocumentsPagedResponse > listDocumentsSettings ()
Returns the object with the settings used for calls to listDocuments.
listLocationsSettings()
public PagedCallSettings<ListLocationsRequest , ListLocationsResponse , DocumentsClient . ListLocationsPagedResponse > listLocationsSettings ()
Returns the object with the settings used for calls to listLocations.
reloadDocumentOperationSettings()
public OperationCallSettings<ReloadDocumentRequest , Document , KnowledgeOperationMetadata > reloadDocumentOperationSettings ()
Returns the object with the settings used for calls to reloadDocument.
reloadDocumentSettings()
public UnaryCallSettings<ReloadDocumentRequest , Operation > reloadDocumentSettings ()
Returns the object with the settings used for calls to reloadDocument.
toBuilder()
public DocumentsStubSettings . Builder toBuilder ()
Returns a builder containing all the values of this settings class.
Overrides
updateDocumentOperationSettings()
public OperationCallSettings<UpdateDocumentRequest , Document , KnowledgeOperationMetadata > updateDocumentOperationSettings ()
Returns the object with the settings used for calls to updateDocument.
updateDocumentSettings()
public UnaryCallSettings<UpdateDocumentRequest , Operation > updateDocumentSettings ()
Returns the object with the settings used for calls to updateDocument.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-11 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-11 UTC."],[],[]]
