Class PagesSettings (0.14.1) 

public class PagesSettings extends ClientSettings<PagesSettings>

Settings class to configure an instance of PagesClient.

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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 PagesSettings.Builder pagesSettingsBuilder = PagesSettings.newBuilder();
 pagesSettingsBuilder
     .getPageSettings()
     .setRetrySettings(
         pagesSettingsBuilder
             .getPageSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 PagesSettings pagesSettings = pagesSettingsBuilder.build();

Inheritance

java.lang.Object > ClientSettings > PagesSettings

Static Methods

create(PagesStubSettings stub)

public static final PagesSettings create(PagesStubSettings stub)
Parameter
NameDescription
stubPagesStubSettings
Returns
TypeDescription
PagesSettings
Exceptions
TypeDescription
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
TypeDescription
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
TypeDescription
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

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

Returns
TypeDescription
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

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

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static PagesSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
TypeDescription
PagesSettings.Builder

newBuilder(ClientContext clientContext)

public static PagesSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
PagesSettings.Builder

newHttpJsonBuilder()

public static PagesSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
TypeDescription
PagesSettings.Builder

Constructors

PagesSettings(PagesSettings.Builder settingsBuilder)

protected PagesSettings(PagesSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderPagesSettings.Builder

Methods

createPageSettings()

public UnaryCallSettings<CreatePageRequest,Page> createPageSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreatePageRequest,Page>

deletePageSettings()

public UnaryCallSettings<DeletePageRequest,Empty> deletePageSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeletePageRequest,Empty>

getLocationSettings()

public UnaryCallSettings<GetLocationRequest,Location> getLocationSettings()

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

Returns
TypeDescription
UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

getPageSettings()

public UnaryCallSettings<GetPageRequest,Page> getPageSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetPageRequest,Page>

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,PagesClient.ListLocationsPagedResponse> listLocationsSettings()

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

Returns
TypeDescription
PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,ListLocationsPagedResponse>

listPagesSettings()

public PagedCallSettings<ListPagesRequest,ListPagesResponse,PagesClient.ListPagesPagedResponse> listPagesSettings()

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

Returns
TypeDescription
PagedCallSettings<ListPagesRequest,ListPagesResponse,ListPagesPagedResponse>

toBuilder()

public PagesSettings.Builder toBuilder()

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

Returns
TypeDescription
PagesSettings.Builder
Overrides

updatePageSettings()

public UnaryCallSettings<UpdatePageRequest,Page> updatePageSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdatePageRequest,Page>