com.google.cloud.dialogflow.v2

Class DocumentsSettings

java.lang.Object

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

com.google.cloud.dialogflow.v2.DocumentsSettings

@Generated(value="by gapic-generator-java")
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 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
 DocumentsSettings.Builder documentsSettingsBuilder = DocumentsSettings.newBuilder();
 documentsSettingsBuilder
     .getDocumentSettings()
     .setRetrySettings(
         documentsSettingsBuilder.getDocumentSettings().getRetrySettings().toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 DocumentsSettings documentsSettings = documentsSettingsBuilder.build();
 

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static DocumentsSettings	create(DocumentsStubSettings stub)
OperationCallSettings<CreateDocumentRequest,Document,KnowledgeOperationMetadata>	createDocumentOperationSettings() Returns the object with the settings used for calls to createDocument.
UnaryCallSettings<CreateDocumentRequest,Operation>	createDocumentSettings() Returns the object with the settings used for calls to createDocument.
static ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder() Returns a builder for the default gRPC ChannelProvider for this service.
static InstantiatingHttpJsonChannelProvider.Builder	defaultHttpJsonTransportProviderBuilder() Returns a builder for the default REST ChannelProvider for this service.
static TransportChannelProvider	defaultTransportChannelProvider()
OperationCallSettings<DeleteDocumentRequest,Empty,KnowledgeOperationMetadata>	deleteDocumentOperationSettings() Returns the object with the settings used for calls to deleteDocument.
UnaryCallSettings<DeleteDocumentRequest,Operation>	deleteDocumentSettings() Returns the object with the settings used for calls to deleteDocument.
OperationCallSettings<ExportDocumentRequest,Document,KnowledgeOperationMetadata>	exportDocumentOperationSettings() Returns the object with the settings used for calls to exportDocument.
UnaryCallSettings<ExportDocumentRequest,Operation>	exportDocumentSettings() Returns the object with the settings used for calls to exportDocument.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
UnaryCallSettings<GetDocumentRequest,Document>	getDocumentSettings() Returns the object with the settings used for calls to getDocument.
UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>	getLocationSettings() Returns the object with the settings used for calls to getLocation.
OperationCallSettings<ImportDocumentsRequest,ImportDocumentsResponse,KnowledgeOperationMetadata>	importDocumentsOperationSettings() Returns the object with the settings used for calls to importDocuments.
UnaryCallSettings<ImportDocumentsRequest,Operation>	importDocumentsSettings() Returns the object with the settings used for calls to importDocuments.
PagedCallSettings<ListDocumentsRequest,ListDocumentsResponse,DocumentsClient.ListDocumentsPagedResponse>	listDocumentsSettings() Returns the object with the settings used for calls to listDocuments.
PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,DocumentsClient.ListLocationsPagedResponse>	listLocationsSettings() Returns the object with the settings used for calls to listLocations.
static DocumentsSettings.Builder	newBuilder() Returns a new gRPC builder for this class.
static DocumentsSettings.Builder	newBuilder(ClientContext clientContext) Returns a new builder for this class.
static DocumentsSettings.Builder	newHttpJsonBuilder() Returns a new REST builder for this class.
OperationCallSettings<ReloadDocumentRequest,Document,KnowledgeOperationMetadata>	reloadDocumentOperationSettings() Returns the object with the settings used for calls to reloadDocument.
UnaryCallSettings<ReloadDocumentRequest,Operation>	reloadDocumentSettings() Returns the object with the settings used for calls to reloadDocument.
DocumentsSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
OperationCallSettings<UpdateDocumentRequest,Document,KnowledgeOperationMetadata>	updateDocumentOperationSettings() Returns the object with the settings used for calls to updateDocument.
UnaryCallSettings<UpdateDocumentRequest,Operation>	updateDocumentSettings() Returns the object with the settings used for calls to updateDocument.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentsSettings

protected DocumentsSettings(DocumentsSettings.Builder settingsBuilder)
                     throws IOException

Throws:

IOException

Method Detail

listDocumentsSettings

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

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

getDocumentSettings

public UnaryCallSettings<GetDocumentRequest,Document> getDocumentSettings()

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

createDocumentSettings

public UnaryCallSettings<CreateDocumentRequest,Operation> createDocumentSettings()

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

createDocumentOperationSettings

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

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

importDocumentsSettings

public UnaryCallSettings<ImportDocumentsRequest,Operation> importDocumentsSettings()

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

importDocumentsOperationSettings

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

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

deleteDocumentSettings

public UnaryCallSettings<DeleteDocumentRequest,Operation> deleteDocumentSettings()

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

deleteDocumentOperationSettings

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

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

updateDocumentSettings

public UnaryCallSettings<UpdateDocumentRequest,Operation> updateDocumentSettings()

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

updateDocumentOperationSettings

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

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

reloadDocumentSettings

public UnaryCallSettings<ReloadDocumentRequest,Operation> reloadDocumentSettings()

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

reloadDocumentOperationSettings

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

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

exportDocumentSettings

public UnaryCallSettings<ExportDocumentRequest,Operation> exportDocumentSettings()

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

exportDocumentOperationSettings

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

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

listLocationsSettings

public PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,DocumentsClient.ListLocationsPagedResponse> listLocationsSettings()

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

getLocationSettings

public UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> getLocationSettings()

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

create

public static final DocumentsSettings create(DocumentsStubSettings stub)
                                      throws IOException

Throws:

IOException

defaultExecutorProviderBuilder

public static 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 GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultGrpcTransportProviderBuilder

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default gRPC ChannelProvider for this service.

defaultHttpJsonTransportProviderBuilder

@BetaApi
public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default REST ChannelProvider for this service.

defaultTransportChannelProvider

public static TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

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

newBuilder

public static DocumentsSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

newHttpJsonBuilder

@BetaApi
public static DocumentsSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

newBuilder

public static DocumentsSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public DocumentsSettings.Builder toBuilder()

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

Specified by:

toBuilder in class ClientSettings<DocumentsSettings>