Class TenantServiceStubSettings

public class TenantServiceStubSettings extends StubSettings<TenantServiceStubSettings>

Settings class to configure an instance of TenantServiceStub.

The default instance has everything set to sensible defaults:

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


 TenantServiceStubSettings.Builder tenantServiceSettingsBuilder =
     TenantServiceStubSettings.newBuilder();
 tenantServiceSettingsBuilder
     .createTenantSettings()
     .setRetrySettings(
         tenantServiceSettingsBuilder
             .createTenantSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 TenantServiceStubSettings tenantServiceSettings = tenantServiceSettingsBuilder.build();
 

Inheritance

java.lang.Object > StubSettings > TenantServiceStubSettings

Constructors

TenantServiceStubSettings(TenantServiceStubSettings.Builder settingsBuilder)

protected TenantServiceStubSettings(TenantServiceStubSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderTenantServiceStubSettings.Builder

Methods

createStub()

public TenantServiceStub createStub()
Returns
TypeDescription
TenantServiceStub
Exceptions
TypeDescription
IOException

createTenantSettings()

public UnaryCallSettings<CreateTenantRequest,Tenant> createTenantSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateTenantRequest,Tenant>

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

deleteTenantSettings()

public UnaryCallSettings<DeleteTenantRequest,Empty> deleteTenantSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteTenantRequest,Empty>

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>

getTenantSettings()

public UnaryCallSettings<GetTenantRequest,Tenant> getTenantSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetTenantRequest,Tenant>

listTenantsSettings()

public PagedCallSettings<ListTenantsRequest,ListTenantsResponse,TenantServiceClient.ListTenantsPagedResponse> listTenantsSettings()

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

Returns
TypeDescription
PagedCallSettings<ListTenantsRequest,ListTenantsResponse,ListTenantsPagedResponse>

newBuilder()

public static TenantServiceStubSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
TenantServiceStubSettings.Builder

newBuilder(ClientContext clientContext)

public static TenantServiceStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
TenantServiceStubSettings.Builder

toBuilder()

public TenantServiceStubSettings.Builder toBuilder()

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

Returns
TypeDescription
TenantServiceStubSettings.Builder
Overrides

updateTenantSettings()

public UnaryCallSettings<UpdateTenantRequest,Tenant> updateTenantSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateTenantRequest,Tenant>