Class HubServiceSettings (1.1.1)

Version 1.1.1

• 1.54.0 (latest)
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.48.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.36.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.9
• 1.1.1
• 1.0.0
• 0.5.0

public class HubServiceSettings extends ClientSettings<HubServiceSettings>

Settings class to configure an instance of HubServiceClient.

The default instance has everything set to sensible defaults:

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

 HubServiceSettings.Builder hubServiceSettingsBuilder = HubServiceSettings.newBuilder();
 hubServiceSettingsBuilder
     .getHubSettings()
     .setRetrySettings(
         hubServiceSettingsBuilder
             .getHubSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 HubServiceSettings hubServiceSettings = hubServiceSettingsBuilder.build();
 

Inheritance

java.lang.Object > ClientSettings > HubServiceSettings

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getWatchdogCheckInterval()

ClientSettings.getWatchdogProvider()

ClientSettings.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

create(HubServiceStubSettings stub)

public static final HubServiceSettings create(HubServiceStubSettings stub)

Parameter

Name	Description
stub	HubServiceStubSettings

Returns

Type	Description
HubServiceSettings

Exceptions

Type	Description
IOException

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

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns

Type	Description
List<String>

newBuilder()

public static HubServiceSettings.Builder newBuilder()

Returns a new builder for this class.

Returns

Type	Description
HubServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static HubServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter

Name	Description
clientContext	ClientContext

Returns

Type	Description
HubServiceSettings.Builder

Constructors

HubServiceSettings(HubServiceSettings.Builder settingsBuilder)

protected HubServiceSettings(HubServiceSettings.Builder settingsBuilder)

Parameter

Name	Description
settingsBuilder	HubServiceSettings.Builder

Methods

createHubOperationSettings()

public OperationCallSettings<CreateHubRequest,Hub,OperationMetadata> createHubOperationSettings()

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

Returns

Type	Description
OperationCallSettings<CreateHubRequest,Hub,OperationMetadata>

createHubSettings()

public UnaryCallSettings<CreateHubRequest,Operation> createHubSettings()

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

Returns

Type	Description
UnaryCallSettings<CreateHubRequest,Operation>

createSpokeOperationSettings()

public OperationCallSettings<CreateSpokeRequest,Spoke,OperationMetadata> createSpokeOperationSettings()

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

Returns

Type	Description
OperationCallSettings<CreateSpokeRequest,Spoke,OperationMetadata>

createSpokeSettings()

public UnaryCallSettings<CreateSpokeRequest,Operation> createSpokeSettings()

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

Returns

Type	Description
UnaryCallSettings<CreateSpokeRequest,Operation>

deleteHubOperationSettings()

public OperationCallSettings<DeleteHubRequest,Empty,OperationMetadata> deleteHubOperationSettings()

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

Returns

Type	Description
OperationCallSettings<DeleteHubRequest,Empty,OperationMetadata>

deleteHubSettings()

public UnaryCallSettings<DeleteHubRequest,Operation> deleteHubSettings()

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

Returns

Type	Description
UnaryCallSettings<DeleteHubRequest,Operation>

deleteSpokeOperationSettings()

public OperationCallSettings<DeleteSpokeRequest,Empty,OperationMetadata> deleteSpokeOperationSettings()

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

Returns

Type	Description
OperationCallSettings<DeleteSpokeRequest,Empty,OperationMetadata>

deleteSpokeSettings()

public UnaryCallSettings<DeleteSpokeRequest,Operation> deleteSpokeSettings()

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

Returns

Type	Description
UnaryCallSettings<DeleteSpokeRequest,Operation>

getHubSettings()

public UnaryCallSettings<GetHubRequest,Hub> getHubSettings()

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

Returns

Type	Description
UnaryCallSettings<GetHubRequest,Hub>

getSpokeSettings()

public UnaryCallSettings<GetSpokeRequest,Spoke> getSpokeSettings()

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

Returns

Type	Description
UnaryCallSettings<GetSpokeRequest,Spoke>

listHubsSettings()

public PagedCallSettings<ListHubsRequest,ListHubsResponse,HubServiceClient.ListHubsPagedResponse> listHubsSettings()

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

Returns

Type	Description
PagedCallSettings<ListHubsRequest,ListHubsResponse,ListHubsPagedResponse>

listSpokesSettings()

public PagedCallSettings<ListSpokesRequest,ListSpokesResponse,HubServiceClient.ListSpokesPagedResponse> listSpokesSettings()

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

Returns

Type	Description
PagedCallSettings<ListSpokesRequest,ListSpokesResponse,ListSpokesPagedResponse>

toBuilder()

public HubServiceSettings.Builder toBuilder()

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

Returns

Type	Description
HubServiceSettings.Builder

Overrides

ClientSettings<SettingsT>.<B>toBuilder()

updateHubOperationSettings()

public OperationCallSettings<UpdateHubRequest,Hub,OperationMetadata> updateHubOperationSettings()

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

Returns

Type	Description
OperationCallSettings<UpdateHubRequest,Hub,OperationMetadata>

updateHubSettings()

public UnaryCallSettings<UpdateHubRequest,Operation> updateHubSettings()

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

Returns

Type	Description
UnaryCallSettings<UpdateHubRequest,Operation>

updateSpokeOperationSettings()

public OperationCallSettings<UpdateSpokeRequest,Spoke,OperationMetadata> updateSpokeOperationSettings()

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

Returns

Type	Description
OperationCallSettings<UpdateSpokeRequest,Spoke,OperationMetadata>

updateSpokeSettings()

public UnaryCallSettings<UpdateSpokeRequest,Operation> updateSpokeSettings()

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

Returns

Type	Description
UnaryCallSettings<UpdateSpokeRequest,Operation>