Class CatalogServiceSettings (2.2.1)

public class CatalogServiceSettings extends ClientSettings<CatalogServiceSettings>

Settings class to configure an instance of CatalogServiceClient.

The default instance has everything set to sensible defaults:

  • The default service address (retail.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 updateCatalog to 30 seconds:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 CatalogServiceSettings.Builder catalogServiceSettingsBuilder =
     CatalogServiceSettings.newBuilder();
 catalogServiceSettingsBuilder
     .updateCatalogSettings()
     .setRetrySettings(
         catalogServiceSettingsBuilder
             .updateCatalogSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 CatalogServiceSettings catalogServiceSettings = catalogServiceSettingsBuilder.build();
 

Inheritance

java.lang.Object > ClientSettings > CatalogServiceSettings

Static Methods

create(CatalogServiceStubSettings stub)

public static final CatalogServiceSettings create(CatalogServiceStubSettings stub)
Parameter
NameDescription
stubCatalogServiceStubSettings
Returns
TypeDescription
CatalogServiceSettings
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 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 CatalogServiceSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
CatalogServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static CatalogServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
CatalogServiceSettings.Builder

Constructors

CatalogServiceSettings(CatalogServiceSettings.Builder settingsBuilder)

protected CatalogServiceSettings(CatalogServiceSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderCatalogServiceSettings.Builder

Methods

getDefaultBranchSettings()

public UnaryCallSettings<GetDefaultBranchRequest,GetDefaultBranchResponse> getDefaultBranchSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetDefaultBranchRequest,GetDefaultBranchResponse>

listCatalogsSettings()

public PagedCallSettings<ListCatalogsRequest,ListCatalogsResponse,CatalogServiceClient.ListCatalogsPagedResponse> listCatalogsSettings()

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

Returns
TypeDescription
PagedCallSettings<ListCatalogsRequest,ListCatalogsResponse,ListCatalogsPagedResponse>

setDefaultBranchSettings()

public UnaryCallSettings<SetDefaultBranchRequest,Empty> setDefaultBranchSettings()

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

Returns
TypeDescription
UnaryCallSettings<SetDefaultBranchRequest,Empty>

toBuilder()

public CatalogServiceSettings.Builder toBuilder()

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

Returns
TypeDescription
CatalogServiceSettings.Builder
Overrides

updateCatalogSettings()

public UnaryCallSettings<UpdateCatalogRequest,Catalog> updateCatalogSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateCatalogRequest,Catalog>