Class SchemaServiceSettings (1.115.5)

public class SchemaServiceSettings extends ClientSettings<SchemaServiceSettings>

Settings class to configure an instance of SchemaServiceClient.

The default instance has everything set to sensible defaults:

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


 SchemaServiceSettings.Builder schemaServiceSettingsBuilder = SchemaServiceSettings.newBuilder();
 schemaServiceSettingsBuilder
     .createSchemaSettings()
     .setRetrySettings(
         schemaServiceSettingsBuilder
             .createSchemaSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 SchemaServiceSettings schemaServiceSettings = schemaServiceSettingsBuilder.build();
 

Inheritance

java.lang.Object > ClientSettings > SchemaServiceSettings

Static Methods

create(SchemaServiceStubSettings stub)

public static final SchemaServiceSettings create(SchemaServiceStubSettings stub)
Parameter
NameDescription
stubSchemaServiceStubSettings
Returns
TypeDescription
SchemaServiceSettings
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 SchemaServiceSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
SchemaServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static SchemaServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
SchemaServiceSettings.Builder

Constructors

SchemaServiceSettings(SchemaServiceSettings.Builder settingsBuilder)

protected SchemaServiceSettings(SchemaServiceSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderSchemaServiceSettings.Builder

Methods

createSchemaSettings()

public UnaryCallSettings<CreateSchemaRequest,Schema> createSchemaSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateSchemaRequest,Schema>

deleteSchemaSettings()

public UnaryCallSettings<DeleteSchemaRequest,Empty> deleteSchemaSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteSchemaRequest,Empty>

getIamPolicySettings()

public UnaryCallSettings<GetIamPolicyRequest,Policy> getIamPolicySettings()

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

Returns
TypeDescription
UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>

getSchemaSettings()

public UnaryCallSettings<GetSchemaRequest,Schema> getSchemaSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetSchemaRequest,Schema>

listSchemasSettings()

public PagedCallSettings<ListSchemasRequest,ListSchemasResponse,SchemaServiceClient.ListSchemasPagedResponse> listSchemasSettings()

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

Returns
TypeDescription
PagedCallSettings<ListSchemasRequest,ListSchemasResponse,ListSchemasPagedResponse>

setIamPolicySettings()

public UnaryCallSettings<SetIamPolicyRequest,Policy> setIamPolicySettings()

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

Returns
TypeDescription
UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>

testIamPermissionsSettings()

public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()

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

Returns
TypeDescription
UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>

toBuilder()

public SchemaServiceSettings.Builder toBuilder()

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

Returns
TypeDescription
SchemaServiceSettings.Builder
Overrides

validateMessageSettings()

public UnaryCallSettings<ValidateMessageRequest,ValidateMessageResponse> validateMessageSettings()

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

Returns
TypeDescription
UnaryCallSettings<ValidateMessageRequest,ValidateMessageResponse>

validateSchemaSettings()

public UnaryCallSettings<ValidateSchemaRequest,ValidateSchemaResponse> validateSchemaSettings()

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

Returns
TypeDescription
UnaryCallSettings<ValidateSchemaRequest,ValidateSchemaResponse>