com.google.cloud.pubsub.v1.SchemaServiceSettings Maven / Gradle / Ivy
Show all versions of google-cloud-pubsub Show documentation
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.cloud.pubsub.v1;
import static com.google.cloud.pubsub.v1.SchemaServiceClient.ListSchemaRevisionsPagedResponse;
import static com.google.cloud.pubsub.v1.SchemaServiceClient.ListSchemasPagedResponse;
import com.google.api.core.ApiFunction;
import com.google.api.core.BetaApi;
import com.google.api.gax.core.GoogleCredentialsProvider;
import com.google.api.gax.core.InstantiatingExecutorProvider;
import com.google.api.gax.grpc.InstantiatingGrpcChannelProvider;
import com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider;
import com.google.api.gax.rpc.ApiClientHeaderProvider;
import com.google.api.gax.rpc.ClientContext;
import com.google.api.gax.rpc.ClientSettings;
import com.google.api.gax.rpc.PagedCallSettings;
import com.google.api.gax.rpc.TransportChannelProvider;
import com.google.api.gax.rpc.UnaryCallSettings;
import com.google.cloud.pubsub.v1.stub.SchemaServiceStubSettings;
import com.google.iam.v1.GetIamPolicyRequest;
import com.google.iam.v1.Policy;
import com.google.iam.v1.SetIamPolicyRequest;
import com.google.iam.v1.TestIamPermissionsRequest;
import com.google.iam.v1.TestIamPermissionsResponse;
import com.google.protobuf.Empty;
import com.google.pubsub.v1.CommitSchemaRequest;
import com.google.pubsub.v1.CreateSchemaRequest;
import com.google.pubsub.v1.DeleteSchemaRequest;
import com.google.pubsub.v1.DeleteSchemaRevisionRequest;
import com.google.pubsub.v1.GetSchemaRequest;
import com.google.pubsub.v1.ListSchemaRevisionsRequest;
import com.google.pubsub.v1.ListSchemaRevisionsResponse;
import com.google.pubsub.v1.ListSchemasRequest;
import com.google.pubsub.v1.ListSchemasResponse;
import com.google.pubsub.v1.RollbackSchemaRequest;
import com.google.pubsub.v1.Schema;
import com.google.pubsub.v1.ValidateMessageRequest;
import com.google.pubsub.v1.ValidateMessageResponse;
import com.google.pubsub.v1.ValidateSchemaRequest;
import com.google.pubsub.v1.ValidateSchemaResponse;
import java.io.IOException;
import java.util.List;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* Settings class to configure an instance of {@link 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:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* SchemaServiceSettings.Builder schemaServiceSettingsBuilder = SchemaServiceSettings.newBuilder();
* schemaServiceSettingsBuilder
* .createSchemaSettings()
* .setRetrySettings(
* schemaServiceSettingsBuilder
* .createSchemaSettings()
* .getRetrySettings()
* .toBuilder()
* .setTotalTimeout(Duration.ofSeconds(30))
* .build());
* SchemaServiceSettings schemaServiceSettings = schemaServiceSettingsBuilder.build();
* }
*/
@Generated("by gapic-generator-java")
public class SchemaServiceSettings extends ClientSettings {
/** Returns the object with the settings used for calls to createSchema. */
public UnaryCallSettings createSchemaSettings() {
return ((SchemaServiceStubSettings) getStubSettings()).createSchemaSettings();
}
/** Returns the object with the settings used for calls to getSchema. */
public UnaryCallSettings getSchemaSettings() {
return ((SchemaServiceStubSettings) getStubSettings()).getSchemaSettings();
}
/** Returns the object with the settings used for calls to listSchemas. */
public PagedCallSettings
listSchemasSettings() {
return ((SchemaServiceStubSettings) getStubSettings()).listSchemasSettings();
}
/** Returns the object with the settings used for calls to listSchemaRevisions. */
public PagedCallSettings<
ListSchemaRevisionsRequest, ListSchemaRevisionsResponse, ListSchemaRevisionsPagedResponse>
listSchemaRevisionsSettings() {
return ((SchemaServiceStubSettings) getStubSettings()).listSchemaRevisionsSettings();
}
/** Returns the object with the settings used for calls to commitSchema. */
public UnaryCallSettings commitSchemaSettings() {
return ((SchemaServiceStubSettings) getStubSettings()).commitSchemaSettings();
}
/** Returns the object with the settings used for calls to rollbackSchema. */
public UnaryCallSettings rollbackSchemaSettings() {
return ((SchemaServiceStubSettings) getStubSettings()).rollbackSchemaSettings();
}
/** Returns the object with the settings used for calls to deleteSchemaRevision. */
public UnaryCallSettings deleteSchemaRevisionSettings() {
return ((SchemaServiceStubSettings) getStubSettings()).deleteSchemaRevisionSettings();
}
/** Returns the object with the settings used for calls to deleteSchema. */
public UnaryCallSettings deleteSchemaSettings() {
return ((SchemaServiceStubSettings) getStubSettings()).deleteSchemaSettings();
}
/** Returns the object with the settings used for calls to validateSchema. */
public UnaryCallSettings validateSchemaSettings() {
return ((SchemaServiceStubSettings) getStubSettings()).validateSchemaSettings();
}
/** Returns the object with the settings used for calls to validateMessage. */
public UnaryCallSettings
validateMessageSettings() {
return ((SchemaServiceStubSettings) getStubSettings()).validateMessageSettings();
}
/** Returns the object with the settings used for calls to setIamPolicy. */
public UnaryCallSettings setIamPolicySettings() {
return ((SchemaServiceStubSettings) getStubSettings()).setIamPolicySettings();
}
/** Returns the object with the settings used for calls to getIamPolicy. */
public UnaryCallSettings getIamPolicySettings() {
return ((SchemaServiceStubSettings) getStubSettings()).getIamPolicySettings();
}
/** Returns the object with the settings used for calls to testIamPermissions. */
public UnaryCallSettings
testIamPermissionsSettings() {
return ((SchemaServiceStubSettings) getStubSettings()).testIamPermissionsSettings();
}
public static final SchemaServiceSettings create(SchemaServiceStubSettings stub)
throws IOException {
return new SchemaServiceSettings.Builder(stub.toBuilder()).build();
}
/** Returns a builder for the default ExecutorProvider for this service. */
public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() {
return SchemaServiceStubSettings.defaultExecutorProviderBuilder();
}
/** Returns the default service endpoint. */
public static String getDefaultEndpoint() {
return SchemaServiceStubSettings.getDefaultEndpoint();
}
/** Returns the default service scopes. */
public static List getDefaultServiceScopes() {
return SchemaServiceStubSettings.getDefaultServiceScopes();
}
/** Returns a builder for the default credentials for this service. */
public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder() {
return SchemaServiceStubSettings.defaultCredentialsProviderBuilder();
}
/** Returns a builder for the default gRPC ChannelProvider for this service. */
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder() {
return SchemaServiceStubSettings.defaultGrpcTransportProviderBuilder();
}
/** Returns a builder for the default REST ChannelProvider for this service. */
@BetaApi
public static InstantiatingHttpJsonChannelProvider.Builder
defaultHttpJsonTransportProviderBuilder() {
return SchemaServiceStubSettings.defaultHttpJsonTransportProviderBuilder();
}
public static TransportChannelProvider defaultTransportChannelProvider() {
return SchemaServiceStubSettings.defaultTransportChannelProvider();
}
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder() {
return SchemaServiceStubSettings.defaultApiClientHeaderProviderBuilder();
}
/** Returns a new gRPC builder for this class. */
public static Builder newBuilder() {
return Builder.createDefault();
}
/** Returns a new REST builder for this class. */
public static Builder newHttpJsonBuilder() {
return Builder.createHttpJsonDefault();
}
/** Returns a new builder for this class. */
public static Builder newBuilder(ClientContext clientContext) {
return new Builder(clientContext);
}
/** Returns a builder containing all the values of this settings class. */
public Builder toBuilder() {
return new Builder(this);
}
protected SchemaServiceSettings(Builder settingsBuilder) throws IOException {
super(settingsBuilder);
}
/** Builder for SchemaServiceSettings. */
public static class Builder extends ClientSettings.Builder {
protected Builder() throws IOException {
this(((ClientContext) null));
}
protected Builder(ClientContext clientContext) {
super(SchemaServiceStubSettings.newBuilder(clientContext));
}
protected Builder(SchemaServiceSettings settings) {
super(settings.getStubSettings().toBuilder());
}
protected Builder(SchemaServiceStubSettings.Builder stubSettings) {
super(stubSettings);
}
private static Builder createDefault() {
return new Builder(SchemaServiceStubSettings.newBuilder());
}
private static Builder createHttpJsonDefault() {
return new Builder(SchemaServiceStubSettings.newHttpJsonBuilder());
}
public SchemaServiceStubSettings.Builder getStubSettingsBuilder() {
return ((SchemaServiceStubSettings.Builder) getStubSettings());
}
/**
* Applies the given settings updater function to all of the unary API methods in this service.
*
* Note: This method does not support applying settings to streaming methods.
*/
public Builder applyToAllUnaryMethods(
ApiFunction, Void> settingsUpdater) {
super.applyToAllUnaryMethods(
getStubSettingsBuilder().unaryMethodSettingsBuilders(), settingsUpdater);
return this;
}
/** Returns the builder for the settings used for calls to createSchema. */
public UnaryCallSettings.Builder createSchemaSettings() {
return getStubSettingsBuilder().createSchemaSettings();
}
/** Returns the builder for the settings used for calls to getSchema. */
public UnaryCallSettings.Builder getSchemaSettings() {
return getStubSettingsBuilder().getSchemaSettings();
}
/** Returns the builder for the settings used for calls to listSchemas. */
public PagedCallSettings.Builder<
ListSchemasRequest, ListSchemasResponse, ListSchemasPagedResponse>
listSchemasSettings() {
return getStubSettingsBuilder().listSchemasSettings();
}
/** Returns the builder for the settings used for calls to listSchemaRevisions. */
public PagedCallSettings.Builder<
ListSchemaRevisionsRequest,
ListSchemaRevisionsResponse,
ListSchemaRevisionsPagedResponse>
listSchemaRevisionsSettings() {
return getStubSettingsBuilder().listSchemaRevisionsSettings();
}
/** Returns the builder for the settings used for calls to commitSchema. */
public UnaryCallSettings.Builder commitSchemaSettings() {
return getStubSettingsBuilder().commitSchemaSettings();
}
/** Returns the builder for the settings used for calls to rollbackSchema. */
public UnaryCallSettings.Builder rollbackSchemaSettings() {
return getStubSettingsBuilder().rollbackSchemaSettings();
}
/** Returns the builder for the settings used for calls to deleteSchemaRevision. */
public UnaryCallSettings.Builder
deleteSchemaRevisionSettings() {
return getStubSettingsBuilder().deleteSchemaRevisionSettings();
}
/** Returns the builder for the settings used for calls to deleteSchema. */
public UnaryCallSettings.Builder deleteSchemaSettings() {
return getStubSettingsBuilder().deleteSchemaSettings();
}
/** Returns the builder for the settings used for calls to validateSchema. */
public UnaryCallSettings.Builder
validateSchemaSettings() {
return getStubSettingsBuilder().validateSchemaSettings();
}
/** Returns the builder for the settings used for calls to validateMessage. */
public UnaryCallSettings.Builder
validateMessageSettings() {
return getStubSettingsBuilder().validateMessageSettings();
}
/** Returns the builder for the settings used for calls to setIamPolicy. */
public UnaryCallSettings.Builder setIamPolicySettings() {
return getStubSettingsBuilder().setIamPolicySettings();
}
/** Returns the builder for the settings used for calls to getIamPolicy. */
public UnaryCallSettings.Builder getIamPolicySettings() {
return getStubSettingsBuilder().getIamPolicySettings();
}
/** Returns the builder for the settings used for calls to testIamPermissions. */
public UnaryCallSettings.Builder
testIamPermissionsSettings() {
return getStubSettingsBuilder().testIamPermissionsSettings();
}
@Override
public SchemaServiceSettings build() throws IOException {
return new SchemaServiceSettings(this);
}
}
}