Class VpcAccessServiceSettings (2.1.10) 

public class VpcAccessServiceSettings extends ClientSettings<VpcAccessServiceSettings>

Settings class to configure an instance of VpcAccessServiceClient.

The default instance has everything set to sensible defaults:

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


 VpcAccessServiceSettings.Builder vpcAccessServiceSettingsBuilder =
     VpcAccessServiceSettings.newBuilder();
 vpcAccessServiceSettingsBuilder
     .getConnectorSettings()
     .setRetrySettings(
         vpcAccessServiceSettingsBuilder
             .getConnectorSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 VpcAccessServiceSettings vpcAccessServiceSettings = vpcAccessServiceSettingsBuilder.build();

Inheritance

java.lang.Object > ClientSettings > VpcAccessServiceSettings

Static Methods

create(VpcAccessServiceStubSettings stub)

public static final VpcAccessServiceSettings create(VpcAccessServiceStubSettings stub)
Parameter
NameDescription
stubVpcAccessServiceStubSettings
Returns
TypeDescription
VpcAccessServiceSettings
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 VpcAccessServiceSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
VpcAccessServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static VpcAccessServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
VpcAccessServiceSettings.Builder

Constructors

VpcAccessServiceSettings(VpcAccessServiceSettings.Builder settingsBuilder)

protected VpcAccessServiceSettings(VpcAccessServiceSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderVpcAccessServiceSettings.Builder

Methods

createConnectorOperationSettings()

public OperationCallSettings<CreateConnectorRequest,Connector,OperationMetadata> createConnectorOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<CreateConnectorRequest,Connector,OperationMetadata>

createConnectorSettings()

public UnaryCallSettings<CreateConnectorRequest,Operation> createConnectorSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateConnectorRequest,Operation>

deleteConnectorOperationSettings()

public OperationCallSettings<DeleteConnectorRequest,Empty,OperationMetadata> deleteConnectorOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<DeleteConnectorRequest,Empty,OperationMetadata>

deleteConnectorSettings()

public UnaryCallSettings<DeleteConnectorRequest,Operation> deleteConnectorSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteConnectorRequest,Operation>

getConnectorSettings()

public UnaryCallSettings<GetConnectorRequest,Connector> getConnectorSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetConnectorRequest,Connector>

listConnectorsSettings()

public PagedCallSettings<ListConnectorsRequest,ListConnectorsResponse,VpcAccessServiceClient.ListConnectorsPagedResponse> listConnectorsSettings()

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

Returns
TypeDescription
PagedCallSettings<ListConnectorsRequest,ListConnectorsResponse,ListConnectorsPagedResponse>

toBuilder()

public VpcAccessServiceSettings.Builder toBuilder()

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

Returns
TypeDescription
VpcAccessServiceSettings.Builder
Overrides