Class PagesSettings
- java.lang.Object
-
- com.google.api.gax.rpc.ClientSettings<PagesSettings>
-
- com.google.cloud.dialogflow.cx.v3beta1.PagesSettings
-
@BetaApi @Generated("by gapic-generator-java") public class PagesSettings extends com.google.api.gax.rpc.ClientSettings<PagesSettings>
Settings class to configure an instance ofPagesClient
.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 getPage 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 PagesSettings.Builder pagesSettingsBuilder = PagesSettings.newBuilder(); pagesSettingsBuilder .getPageSettings() .setRetrySettings( pagesSettingsBuilder .getPageSettings() .getRetrySettings() .toBuilder() .setTotalTimeout(Duration.ofSeconds(30)) .build()); PagesSettings pagesSettings = pagesSettingsBuilder.build();
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
PagesSettings.Builder
Builder for PagesSettings.
-
Constructor Summary
Constructors Modifier Constructor Description protected
PagesSettings(PagesSettings.Builder settingsBuilder)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static PagesSettings
create(PagesStubSettings stub)
com.google.api.gax.rpc.UnaryCallSettings<CreatePageRequest,Page>
createPageSettings()
Returns the object with the settings used for calls to createPage.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 gRPC ChannelProvider for this service.static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder
defaultHttpJsonTransportProviderBuilder()
Returns a builder for the default REST ChannelProvider for this service.static com.google.api.gax.rpc.TransportChannelProvider
defaultTransportChannelProvider()
com.google.api.gax.rpc.UnaryCallSettings<DeletePageRequest,com.google.protobuf.Empty>
deletePageSettings()
Returns the object with the settings used for calls to deletePage.static String
getDefaultEndpoint()
Returns the default service endpoint.static List<String>
getDefaultServiceScopes()
Returns the default service scopes.com.google.api.gax.rpc.UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>
getLocationSettings()
Returns the object with the settings used for calls to getLocation.com.google.api.gax.rpc.UnaryCallSettings<GetPageRequest,Page>
getPageSettings()
Returns the object with the settings used for calls to getPage.com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,PagesClient.ListLocationsPagedResponse>
listLocationsSettings()
Returns the object with the settings used for calls to listLocations.com.google.api.gax.rpc.PagedCallSettings<ListPagesRequest,ListPagesResponse,PagesClient.ListPagesPagedResponse>
listPagesSettings()
Returns the object with the settings used for calls to listPages.static PagesSettings.Builder
newBuilder()
Returns a new gRPC builder for this class.static PagesSettings.Builder
newBuilder(com.google.api.gax.rpc.ClientContext clientContext)
Returns a new builder for this class.static PagesSettings.Builder
newHttpJsonBuilder()
Returns a new REST builder for this class.PagesSettings.Builder
toBuilder()
Returns a builder containing all the values of this settings class.com.google.api.gax.rpc.UnaryCallSettings<UpdatePageRequest,Page>
updatePageSettings()
Returns the object with the settings used for calls to updatePage.-
Methods inherited from class com.google.api.gax.rpc.ClientSettings
getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getWatchdogCheckInterval, getWatchdogProvider, toString
-
-
-
-
Constructor Detail
-
PagesSettings
protected PagesSettings(PagesSettings.Builder settingsBuilder) throws IOException
- Throws:
IOException
-
-
Method Detail
-
listPagesSettings
public com.google.api.gax.rpc.PagedCallSettings<ListPagesRequest,ListPagesResponse,PagesClient.ListPagesPagedResponse> listPagesSettings()
Returns the object with the settings used for calls to listPages.
-
getPageSettings
public com.google.api.gax.rpc.UnaryCallSettings<GetPageRequest,Page> getPageSettings()
Returns the object with the settings used for calls to getPage.
-
createPageSettings
public com.google.api.gax.rpc.UnaryCallSettings<CreatePageRequest,Page> createPageSettings()
Returns the object with the settings used for calls to createPage.
-
updatePageSettings
public com.google.api.gax.rpc.UnaryCallSettings<UpdatePageRequest,Page> updatePageSettings()
Returns the object with the settings used for calls to updatePage.
-
deletePageSettings
public com.google.api.gax.rpc.UnaryCallSettings<DeletePageRequest,com.google.protobuf.Empty> deletePageSettings()
Returns the object with the settings used for calls to deletePage.
-
listLocationsSettings
public com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,PagesClient.ListLocationsPagedResponse> listLocationsSettings()
Returns the object with the settings used for calls to listLocations.
-
getLocationSettings
public com.google.api.gax.rpc.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 PagesSettings create(PagesStubSettings 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 gRPC ChannelProvider for this service.
-
defaultHttpJsonTransportProviderBuilder
@BetaApi public static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()
Returns a builder for the default REST ChannelProvider for this service.
-
defaultTransportChannelProvider
public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()
-
defaultApiClientHeaderProviderBuilder
@BetaApi("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 PagesSettings.Builder newBuilder()
Returns a new gRPC builder for this class.
-
newHttpJsonBuilder
@BetaApi public static PagesSettings.Builder newHttpJsonBuilder()
Returns a new REST builder for this class.
-
newBuilder
public static PagesSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)
Returns a new builder for this class.
-
toBuilder
public PagesSettings.Builder toBuilder()
Returns a builder containing all the values of this settings class.- Specified by:
toBuilder
in classcom.google.api.gax.rpc.ClientSettings<PagesSettings>
-
-