Class IDSSettings (1.0.4)

public class IDSSettings extends ClientSettings<IDSSettings>

Settings class to configure an instance of IDSClient.

The default instance has everything set to sensible defaults:

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


 IDSSettings.Builder iDSSettingsBuilder = IDSSettings.newBuilder();
 iDSSettingsBuilder
     .getEndpointSettings()
     .setRetrySettings(
         iDSSettingsBuilder
             .getEndpointSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 IDSSettings iDSSettings = iDSSettingsBuilder.build();
 

Inheritance

java.lang.Object > ClientSettings > IDSSettings

Static Methods

create(IDSStubSettings stub)

public static final IDSSettings create(IDSStubSettings stub)
Parameter
NameDescription
stubIDSStubSettings
Returns
TypeDescription
IDSSettings
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 IDSSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
IDSSettings.Builder

newBuilder(ClientContext clientContext)

public static IDSSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
IDSSettings.Builder

Constructors

IDSSettings(IDSSettings.Builder settingsBuilder)

protected IDSSettings(IDSSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderIDSSettings.Builder

Methods

createEndpointOperationSettings()

public OperationCallSettings<CreateEndpointRequest,Endpoint,OperationMetadata> createEndpointOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<CreateEndpointRequest,Endpoint,OperationMetadata>

createEndpointSettings()

public UnaryCallSettings<CreateEndpointRequest,Operation> createEndpointSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateEndpointRequest,Operation>

deleteEndpointOperationSettings()

public OperationCallSettings<DeleteEndpointRequest,Empty,OperationMetadata> deleteEndpointOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<DeleteEndpointRequest,Empty,OperationMetadata>

deleteEndpointSettings()

public UnaryCallSettings<DeleteEndpointRequest,Operation> deleteEndpointSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteEndpointRequest,Operation>

getEndpointSettings()

public UnaryCallSettings<GetEndpointRequest,Endpoint> getEndpointSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetEndpointRequest,Endpoint>

listEndpointsSettings()

public PagedCallSettings<ListEndpointsRequest,ListEndpointsResponse,IDSClient.ListEndpointsPagedResponse> listEndpointsSettings()

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

Returns
TypeDescription
PagedCallSettings<ListEndpointsRequest,ListEndpointsResponse,ListEndpointsPagedResponse>

toBuilder()

public IDSSettings.Builder toBuilder()

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

Returns
TypeDescription
IDSSettings.Builder
Overrides