com.google.cloud.gkehub.v1alpha2

Class GkeHubSettings

java.lang.Object

com.google.api.gax.rpc.ClientSettings<GkeHubSettings>

com.google.cloud.gkehub.v1alpha2.GkeHubSettings

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

Settings class to configure an instance of GkeHubClient.

The default instance has everything set to sensible defaults:

• The default service address (gkehub.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 getMembership 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
 GkeHubSettings.Builder gkeHubSettingsBuilder = GkeHubSettings.newBuilder();
 gkeHubSettingsBuilder
     .getMembershipSettings()
     .setRetrySettings(
         gkeHubSettingsBuilder.getMembershipSettings().getRetrySettings().toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 GkeHubSettings gkeHubSettings = gkeHubSettingsBuilder.build();
 

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static GkeHubSettings	create(GkeHubStubSettings stub)
com.google.api.gax.rpc.OperationCallSettings<CreateMembershipRequest,Membership,OperationMetadata>	createMembershipOperationSettings() Returns the object with the settings used for calls to createMembership.
com.google.api.gax.rpc.UnaryCallSettings<CreateMembershipRequest,com.google.longrunning.Operation>	createMembershipSettings() Returns the object with the settings used for calls to createMembership.
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 gRPC ChannelProvider for this service.
static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder	defaultHttpJsonTransportProviderBuilder() Returns a builder for the default REST ChannelProvider for this service.
static com.google.api.gax.rpc.TransportChannelProvider	defaultTransportChannelProvider()
com.google.api.gax.rpc.OperationCallSettings<DeleteMembershipRequest,com.google.protobuf.Empty,OperationMetadata>	deleteMembershipOperationSettings() Returns the object with the settings used for calls to deleteMembership.
com.google.api.gax.rpc.UnaryCallSettings<DeleteMembershipRequest,com.google.longrunning.Operation>	deleteMembershipSettings() Returns the object with the settings used for calls to deleteMembership.
com.google.api.gax.rpc.UnaryCallSettings<GenerateConnectManifestRequest,GenerateConnectManifestResponse>	generateConnectManifestSettings() Returns the object with the settings used for calls to generateConnectManifest.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
com.google.api.gax.rpc.UnaryCallSettings<GetMembershipRequest,Membership>	getMembershipSettings() Returns the object with the settings used for calls to getMembership.
com.google.api.gax.rpc.UnaryCallSettings<InitializeHubRequest,InitializeHubResponse>	initializeHubSettings() Returns the object with the settings used for calls to initializeHub.
com.google.api.gax.rpc.PagedCallSettings<ListMembershipsRequest,ListMembershipsResponse,GkeHubClient.ListMembershipsPagedResponse>	listMembershipsSettings() Returns the object with the settings used for calls to listMemberships.
static GkeHubSettings.Builder	newBuilder() Returns a new gRPC builder for this class.
static GkeHubSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
static GkeHubSettings.Builder	newHttpJsonBuilder() Returns a new REST builder for this class.
GkeHubSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
com.google.api.gax.rpc.OperationCallSettings<UpdateMembershipRequest,Membership,OperationMetadata>	updateMembershipOperationSettings() Returns the object with the settings used for calls to updateMembership.
com.google.api.gax.rpc.UnaryCallSettings<UpdateMembershipRequest,com.google.longrunning.Operation>	updateMembershipSettings() Returns the object with the settings used for calls to updateMembership.

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

getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getWatchdogCheckInterval, getWatchdogProvider, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

GkeHubSettings

protected GkeHubSettings(GkeHubSettings.Builder settingsBuilder)
                  throws IOException

Throws:

IOException

Method Detail

listMembershipsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListMembershipsRequest,ListMembershipsResponse,GkeHubClient.ListMembershipsPagedResponse> listMembershipsSettings()

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

getMembershipSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetMembershipRequest,Membership> getMembershipSettings()

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

createMembershipSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateMembershipRequest,com.google.longrunning.Operation> createMembershipSettings()

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

createMembershipOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<CreateMembershipRequest,Membership,OperationMetadata> createMembershipOperationSettings()

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

deleteMembershipSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteMembershipRequest,com.google.longrunning.Operation> deleteMembershipSettings()

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

deleteMembershipOperationSettings

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

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

updateMembershipSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateMembershipRequest,com.google.longrunning.Operation> updateMembershipSettings()

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

updateMembershipOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<UpdateMembershipRequest,Membership,OperationMetadata> updateMembershipOperationSettings()

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

generateConnectManifestSettings

public com.google.api.gax.rpc.UnaryCallSettings<GenerateConnectManifestRequest,GenerateConnectManifestResponse> generateConnectManifestSettings()

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

initializeHubSettings

public com.google.api.gax.rpc.UnaryCallSettings<InitializeHubRequest,InitializeHubResponse> initializeHubSettings()

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

create

public static final GkeHubSettings create(GkeHubStubSettings stub)
                                   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.

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 gRPC ChannelProvider for this service.

defaultHttpJsonTransportProviderBuilder

@BetaApi
public static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default REST 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 GkeHubSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

newHttpJsonBuilder

@BetaApi
public static GkeHubSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

newBuilder

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

Returns a new builder for this class.

toBuilder

public GkeHubSettings.Builder toBuilder()

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

Specified by:

toBuilder in class com.google.api.gax.rpc.ClientSettings<GkeHubSettings>