com.google.cloud.networkconnectivity.v1alpha1.stub

Class HubServiceStubSettings

java.lang.Object

com.google.api.gax.rpc.StubSettings<HubServiceStubSettings>

com.google.cloud.networkconnectivity.v1alpha1.stub.HubServiceStubSettings

@BetaApi
 @Generated(value="by gapic-generator-java")
public class HubServiceStubSettings
extends com.google.api.gax.rpc.StubSettings<HubServiceStubSettings>

Settings class to configure an instance of HubServiceStub.

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:

 // 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
 HubServiceStubSettings.Builder hubServiceSettingsBuilder = HubServiceStubSettings.newBuilder();
 hubServiceSettingsBuilder
     .getHubSettings()
     .setRetrySettings(
         hubServiceSettingsBuilder
             .getHubSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 HubServiceStubSettings hubServiceSettings = hubServiceSettingsBuilder.build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HubServiceStubSettings.Builder Builder for HubServiceStubSettings.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HubServiceStubSettings(HubServiceStubSettings.Builder settingsBuilder)

Method Summary

Modifier and Type	Method and Description
com.google.api.gax.rpc.OperationCallSettings<CreateHubRequest,Hub,OperationMetadata>	createHubOperationSettings() Returns the object with the settings used for calls to createHub.
com.google.api.gax.rpc.UnaryCallSettings<CreateHubRequest,com.google.longrunning.Operation>	createHubSettings() Returns the object with the settings used for calls to createHub.
com.google.api.gax.rpc.OperationCallSettings<CreateSpokeRequest,Spoke,OperationMetadata>	createSpokeOperationSettings() Returns the object with the settings used for calls to createSpoke.
com.google.api.gax.rpc.UnaryCallSettings<CreateSpokeRequest,com.google.longrunning.Operation>	createSpokeSettings() Returns the object with the settings used for calls to createSpoke.
HubServiceStub	createStub()
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 ChannelProvider for this service.
static com.google.api.gax.rpc.TransportChannelProvider	defaultTransportChannelProvider()
com.google.api.gax.rpc.OperationCallSettings<DeleteHubRequest,com.google.protobuf.Empty,OperationMetadata>	deleteHubOperationSettings() Returns the object with the settings used for calls to deleteHub.
com.google.api.gax.rpc.UnaryCallSettings<DeleteHubRequest,com.google.longrunning.Operation>	deleteHubSettings() Returns the object with the settings used for calls to deleteHub.
com.google.api.gax.rpc.OperationCallSettings<DeleteSpokeRequest,com.google.protobuf.Empty,OperationMetadata>	deleteSpokeOperationSettings() Returns the object with the settings used for calls to deleteSpoke.
com.google.api.gax.rpc.UnaryCallSettings<DeleteSpokeRequest,com.google.longrunning.Operation>	deleteSpokeSettings() Returns the object with the settings used for calls to deleteSpoke.
static String	getDefaultEndpoint() Returns the default service endpoint.
static String	getDefaultMtlsEndpoint() Returns the default mTLS service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
com.google.api.gax.rpc.UnaryCallSettings<GetHubRequest,Hub>	getHubSettings() Returns the object with the settings used for calls to getHub.
com.google.api.gax.rpc.UnaryCallSettings<GetSpokeRequest,Spoke>	getSpokeSettings() Returns the object with the settings used for calls to getSpoke.
com.google.api.gax.rpc.PagedCallSettings<ListHubsRequest,ListHubsResponse,HubServiceClient.ListHubsPagedResponse>	listHubsSettings() Returns the object with the settings used for calls to listHubs.
com.google.api.gax.rpc.PagedCallSettings<ListSpokesRequest,ListSpokesResponse,HubServiceClient.ListSpokesPagedResponse>	listSpokesSettings() Returns the object with the settings used for calls to listSpokes.
static HubServiceStubSettings.Builder	newBuilder() Returns a new builder for this class.
static HubServiceStubSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
HubServiceStubSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
com.google.api.gax.rpc.OperationCallSettings<UpdateHubRequest,Hub,OperationMetadata>	updateHubOperationSettings() Returns the object with the settings used for calls to updateHub.
com.google.api.gax.rpc.UnaryCallSettings<UpdateHubRequest,com.google.longrunning.Operation>	updateHubSettings() Returns the object with the settings used for calls to updateHub.
com.google.api.gax.rpc.OperationCallSettings<UpdateSpokeRequest,Spoke,OperationMetadata>	updateSpokeOperationSettings() Returns the object with the settings used for calls to updateSpoke.
com.google.api.gax.rpc.UnaryCallSettings<UpdateSpokeRequest,com.google.longrunning.Operation>	updateSpokeSettings() Returns the object with the settings used for calls to updateSpoke.

Methods inherited from class com.google.api.gax.rpc.StubSettings

getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getMtlsEndpoint, getQuotaProjectId, getStreamWatchdogCheckInterval, getStreamWatchdogProvider, getTracerFactory, getTransportChannelProvider, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

HubServiceStubSettings

protected HubServiceStubSettings(HubServiceStubSettings.Builder settingsBuilder)
                          throws IOException

Throws:

IOException

Method Detail

listHubsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListHubsRequest,ListHubsResponse,HubServiceClient.ListHubsPagedResponse> listHubsSettings()

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

getHubSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetHubRequest,Hub> getHubSettings()

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

createHubSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateHubRequest,com.google.longrunning.Operation> createHubSettings()

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

createHubOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<CreateHubRequest,Hub,OperationMetadata> createHubOperationSettings()

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

updateHubSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateHubRequest,com.google.longrunning.Operation> updateHubSettings()

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

updateHubOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<UpdateHubRequest,Hub,OperationMetadata> updateHubOperationSettings()

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

deleteHubSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteHubRequest,com.google.longrunning.Operation> deleteHubSettings()

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

deleteHubOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<DeleteHubRequest,com.google.protobuf.Empty,OperationMetadata> deleteHubOperationSettings()

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

listSpokesSettings

public com.google.api.gax.rpc.PagedCallSettings<ListSpokesRequest,ListSpokesResponse,HubServiceClient.ListSpokesPagedResponse> listSpokesSettings()

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

getSpokeSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetSpokeRequest,Spoke> getSpokeSettings()

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

createSpokeSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateSpokeRequest,com.google.longrunning.Operation> createSpokeSettings()

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

createSpokeOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<CreateSpokeRequest,Spoke,OperationMetadata> createSpokeOperationSettings()

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

updateSpokeSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateSpokeRequest,com.google.longrunning.Operation> updateSpokeSettings()

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

updateSpokeOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<UpdateSpokeRequest,Spoke,OperationMetadata> updateSpokeOperationSettings()

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

deleteSpokeSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteSpokeRequest,com.google.longrunning.Operation> deleteSpokeSettings()

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

deleteSpokeOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<DeleteSpokeRequest,com.google.protobuf.Empty,OperationMetadata> deleteSpokeOperationSettings()

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

createStub

public HubServiceStub createStub()
                          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.

getDefaultMtlsEndpoint

public static String getDefaultMtlsEndpoint()

Returns the default mTLS 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 ChannelProvider for this service.

defaultTransportChannelProvider

public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

@BetaApi(value="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 HubServiceStubSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

public static HubServiceStubSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public HubServiceStubSettings.Builder toBuilder()

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

Specified by:

toBuilder in class com.google.api.gax.rpc.StubSettings<HubServiceStubSettings>