Class ServicesStubSettings (2.1.10) 

public class ServicesStubSettings extends StubSettings<ServicesStubSettings>

Settings class to configure an instance of ServicesStub.

The default instance has everything set to sensible defaults:

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


 ServicesStubSettings.Builder servicesSettingsBuilder = ServicesStubSettings.newBuilder();
 servicesSettingsBuilder
     .getServiceSettings()
     .setRetrySettings(
         servicesSettingsBuilder
             .getServiceSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 ServicesStubSettings servicesSettings = servicesSettingsBuilder.build();

Inheritance

java.lang.Object > StubSettings > ServicesStubSettings

Static Methods

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

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static ServicesStubSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
ServicesStubSettings.Builder

newBuilder(ClientContext clientContext)

public static ServicesStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
ServicesStubSettings.Builder

Constructors

ServicesStubSettings(ServicesStubSettings.Builder settingsBuilder)

protected ServicesStubSettings(ServicesStubSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderServicesStubSettings.Builder

Methods

createStub()

public ServicesStub createStub()
Returns
TypeDescription
ServicesStub
Exceptions
TypeDescription
IOException

deleteServiceOperationSettings()

public OperationCallSettings<DeleteServiceRequest,Empty,OperationMetadataV1> deleteServiceOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<DeleteServiceRequest,Empty,OperationMetadataV1>

deleteServiceSettings()

public UnaryCallSettings<DeleteServiceRequest,Operation> deleteServiceSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteServiceRequest,Operation>

getServiceSettings()

public UnaryCallSettings<GetServiceRequest,Service> getServiceSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetServiceRequest,Service>

listServicesSettings()

public PagedCallSettings<ListServicesRequest,ListServicesResponse,ServicesClient.ListServicesPagedResponse> listServicesSettings()

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

Returns
TypeDescription
PagedCallSettings<ListServicesRequest,ListServicesResponse,ListServicesPagedResponse>

toBuilder()

public ServicesStubSettings.Builder toBuilder()

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

Returns
TypeDescription
ServicesStubSettings.Builder
Overrides

updateServiceOperationSettings()

public OperationCallSettings<UpdateServiceRequest,Service,OperationMetadataV1> updateServiceOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<UpdateServiceRequest,Service,OperationMetadataV1>

updateServiceSettings()

public UnaryCallSettings<UpdateServiceRequest,Operation> updateServiceSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateServiceRequest,Operation>