Class CatalogServiceStubSettings (2.2.3)

public class CatalogServiceStubSettings extends StubSettings<CatalogServiceStubSettings>

Settings class to configure an instance of CatalogServiceStub.

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.
 CatalogServiceStubSettings.Builder catalogServiceSettingsBuilder =
     CatalogServiceStubSettings.newBuilder();
 catalogServiceSettingsBuilder
     .updateCatalogSettings()
     .setRetrySettings(
         catalogServiceSettingsBuilder
             .updateCatalogSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 CatalogServiceStubSettings catalogServiceSettings = catalogServiceSettingsBuilder.build();

Inheritance

java.lang.Object > StubSettings > CatalogServiceStubSettings

Inherited Members

StubSettings.getBackgroundExecutorProvider()

StubSettings.getClock()

StubSettings.getCredentialsProvider()

StubSettings.getEndpoint()

StubSettings.getExecutorProvider()

StubSettings.getHeaderProvider()

StubSettings.getInternalHeaderProvider()

StubSettings.getMtlsEndpoint()

StubSettings.getQuotaProjectId()

StubSettings.getStreamWatchdogCheckInterval()

StubSettings.getStreamWatchdogProvider()

StubSettings.getTracerFactory()

StubSettings.getTransportChannelProvider()

StubSettings.toBuilder()

StubSettings.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

Returns

Type	Description
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns

Type	Description
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns

Type	Description
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns

Type	Description
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()

Returns

Type	Description
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns

Type	Description
String

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

Returns

Type	Description
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns

Type	Description
List<String>

newBuilder()

public static CatalogServiceStubSettings.Builder newBuilder()

Returns a new builder for this class.

Returns

Type	Description
CatalogServiceStubSettings.Builder

newBuilder(ClientContext clientContext)

public static CatalogServiceStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter

Name	Description
clientContext	`ClientContext`

Returns

Type	Description
CatalogServiceStubSettings.Builder

Constructors

CatalogServiceStubSettings(CatalogServiceStubSettings.Builder settingsBuilder)

protected CatalogServiceStubSettings(CatalogServiceStubSettings.Builder settingsBuilder)

Parameter

Name	Description
settingsBuilder	`CatalogServiceStubSettings.Builder`

Methods

createStub()

public CatalogServiceStub createStub()

Returns

Type	Description
CatalogServiceStub

Exceptions

Type	Description
IOException

getDefaultBranchSettings()

public UnaryCallSettings<GetDefaultBranchRequest,GetDefaultBranchResponse> getDefaultBranchSettings()

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

Returns

Type	Description
UnaryCallSettings<GetDefaultBranchRequest,GetDefaultBranchResponse>

listCatalogsSettings()

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

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

Returns

Type	Description
PagedCallSettings<ListCatalogsRequest,ListCatalogsResponse,ListCatalogsPagedResponse>

setDefaultBranchSettings()

public UnaryCallSettings<SetDefaultBranchRequest,Empty> setDefaultBranchSettings()

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

Returns

Type	Description
UnaryCallSettings<SetDefaultBranchRequest,Empty>

toBuilder()

public CatalogServiceStubSettings.Builder toBuilder()

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

Returns

Type	Description
CatalogServiceStubSettings.Builder

Overrides

StubSettings<SettingsT>.toBuilder()

updateCatalogSettings()

public UnaryCallSettings<UpdateCatalogRequest,Catalog> updateCatalogSettings()

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

Returns

Type	Description
UnaryCallSettings<UpdateCatalogRequest,Catalog>