com.google.cloud.dialogflow.v2beta1

Class DocumentsSettings

java.lang.Object

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

com.google.cloud.dialogflow.v2beta1.DocumentsSettings

@Generated(value="by gapic-generator")
 @BetaApi
public class DocumentsSettings
extends com.google.api.gax.rpc.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:

 
 DocumentsSettings.Builder documentsSettingsBuilder =
     DocumentsSettings.newBuilder();
 documentsSettingsBuilder.getDocumentSettings().getRetrySettings().toBuilder()
     .setTotalTimeout(Duration.ofSeconds(30));
 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)
com.google.api.gax.rpc.OperationCallSettings<CreateDocumentRequest,Document,KnowledgeOperationMetadata>	createDocumentOperationSettings() Returns the object with the settings used for calls to createDocument.
com.google.api.gax.rpc.UnaryCallSettings<CreateDocumentRequest,com.google.longrunning.Operation>	createDocumentSettings() Returns the object with the settings used for calls to createDocument.
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static com.google.api.gax.core.GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static com.google.api.gax.core.InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder() Returns a builder for the default ChannelProvider for this service.
static com.google.api.gax.rpc.TransportChannelProvider	defaultTransportChannelProvider()
com.google.api.gax.rpc.OperationCallSettings<DeleteDocumentRequest,Empty,KnowledgeOperationMetadata>	deleteDocumentOperationSettings() Returns the object with the settings used for calls to deleteDocument.
com.google.api.gax.rpc.UnaryCallSettings<DeleteDocumentRequest,com.google.longrunning.Operation>	deleteDocumentSettings() Returns the object with the settings used for calls to deleteDocument.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
com.google.api.gax.rpc.UnaryCallSettings<GetDocumentRequest,Document>	getDocumentSettings() Returns the object with the settings used for calls to getDocument.
com.google.api.gax.rpc.PagedCallSettings<ListDocumentsRequest,ListDocumentsResponse,DocumentsClient.ListDocumentsPagedResponse>	listDocumentsSettings() Returns the object with the settings used for calls to listDocuments.
static DocumentsSettings.Builder	newBuilder() Returns a new builder for this class.
static DocumentsSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
com.google.api.gax.rpc.UnaryCallSettings<ReloadDocumentRequest,com.google.longrunning.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.
com.google.api.gax.rpc.OperationCallSettings<UpdateDocumentRequest,Document,KnowledgeOperationMetadata>	updateDocumentOperationSettings() Returns the object with the settings used for calls to updateDocument.
com.google.api.gax.rpc.UnaryCallSettings<UpdateDocumentRequest,com.google.longrunning.Operation>	updateDocumentSettings() Returns the object with the settings used for calls to updateDocument.

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

getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getHeaderProvider, getInternalHeaderProvider, 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 com.google.api.gax.rpc.PagedCallSettings<ListDocumentsRequest,ListDocumentsResponse,DocumentsClient.ListDocumentsPagedResponse> listDocumentsSettings()

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

getDocumentSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetDocumentRequest,Document> getDocumentSettings()

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

createDocumentSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateDocumentRequest,com.google.longrunning.Operation> createDocumentSettings()

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

createDocumentOperationSettings

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public com.google.api.gax.rpc.OperationCallSettings<CreateDocumentRequest,Document,KnowledgeOperationMetadata> createDocumentOperationSettings()

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

deleteDocumentSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteDocumentRequest,com.google.longrunning.Operation> deleteDocumentSettings()

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

deleteDocumentOperationSettings

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public com.google.api.gax.rpc.OperationCallSettings<DeleteDocumentRequest,Empty,KnowledgeOperationMetadata> deleteDocumentOperationSettings()

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

updateDocumentSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateDocumentRequest,com.google.longrunning.Operation> updateDocumentSettings()

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

updateDocumentOperationSettings

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public com.google.api.gax.rpc.OperationCallSettings<UpdateDocumentRequest,Document,KnowledgeOperationMetadata> updateDocumentOperationSettings()

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

reloadDocumentSettings

public com.google.api.gax.rpc.UnaryCallSettings<ReloadDocumentRequest,com.google.longrunning.Operation> reloadDocumentSettings()

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

create

public static final DocumentsSettings create(DocumentsStubSettings stub)
                                      throws IOException

Throws:

IOException

defaultExecutorProviderBuilder

public static com.google.api.gax.core.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 com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultGrpcTransportProviderBuilder

public static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

defaultTransportChannelProvider

public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

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

newBuilder

public static DocumentsSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

public static DocumentsSettings.Builder newBuilder(com.google.api.gax.rpc.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 com.google.api.gax.rpc.ClientSettings<DocumentsSettings>