GrafeasSettings.java
/*
* Copyright 2022 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 io.grafeas.v1;
import static io.grafeas.v1.GrafeasClient.ListNoteOccurrencesPagedResponse;
import static io.grafeas.v1.GrafeasClient.ListNotesPagedResponse;
import static io.grafeas.v1.GrafeasClient.ListOccurrencesPagedResponse;
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.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.protobuf.Empty;
import io.grafeas.v1.stub.GrafeasStubSettings;
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 GrafeasClient}.
*
* <p>The default instance has everything set to sensible defaults:
*
* <ul>
* <li>The default service address (containeranalysis.googleapis.com) and default port (443) are
* used.
* <li>Credentials are acquired automatically through Application Default Credentials.
* <li>Retries are configured for idempotent methods but not for non-idempotent methods.
* </ul>
*
* <p>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.
*
* <p>For example, to set the total timeout of getOccurrence to 30 seconds:
*
* <pre>{@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
* GrafeasSettings.Builder grafeasSettingsBuilder = GrafeasSettings.newBuilder();
* grafeasSettingsBuilder
* .getOccurrenceSettings()
* .setRetrySettings(
* grafeasSettingsBuilder.getOccurrenceSettings().getRetrySettings().toBuilder()
* .setTotalTimeout(Duration.ofSeconds(30))
* .build());
* GrafeasSettings grafeasSettings = grafeasSettingsBuilder.build();
* }</pre>
*/
@Generated("by gapic-generator-java")
public class GrafeasSettings extends ClientSettings<GrafeasSettings> {
/** Returns the object with the settings used for calls to getOccurrence. */
public UnaryCallSettings<GetOccurrenceRequest, Occurrence> getOccurrenceSettings() {
return ((GrafeasStubSettings) getStubSettings()).getOccurrenceSettings();
}
/** Returns the object with the settings used for calls to listOccurrences. */
public PagedCallSettings<
ListOccurrencesRequest, ListOccurrencesResponse, ListOccurrencesPagedResponse>
listOccurrencesSettings() {
return ((GrafeasStubSettings) getStubSettings()).listOccurrencesSettings();
}
/** Returns the object with the settings used for calls to deleteOccurrence. */
public UnaryCallSettings<DeleteOccurrenceRequest, Empty> deleteOccurrenceSettings() {
return ((GrafeasStubSettings) getStubSettings()).deleteOccurrenceSettings();
}
/** Returns the object with the settings used for calls to createOccurrence. */
public UnaryCallSettings<CreateOccurrenceRequest, Occurrence> createOccurrenceSettings() {
return ((GrafeasStubSettings) getStubSettings()).createOccurrenceSettings();
}
/** Returns the object with the settings used for calls to batchCreateOccurrences. */
public UnaryCallSettings<BatchCreateOccurrencesRequest, BatchCreateOccurrencesResponse>
batchCreateOccurrencesSettings() {
return ((GrafeasStubSettings) getStubSettings()).batchCreateOccurrencesSettings();
}
/** Returns the object with the settings used for calls to updateOccurrence. */
public UnaryCallSettings<UpdateOccurrenceRequest, Occurrence> updateOccurrenceSettings() {
return ((GrafeasStubSettings) getStubSettings()).updateOccurrenceSettings();
}
/** Returns the object with the settings used for calls to getOccurrenceNote. */
public UnaryCallSettings<GetOccurrenceNoteRequest, Note> getOccurrenceNoteSettings() {
return ((GrafeasStubSettings) getStubSettings()).getOccurrenceNoteSettings();
}
/** Returns the object with the settings used for calls to getNote. */
public UnaryCallSettings<GetNoteRequest, Note> getNoteSettings() {
return ((GrafeasStubSettings) getStubSettings()).getNoteSettings();
}
/** Returns the object with the settings used for calls to listNotes. */
public PagedCallSettings<ListNotesRequest, ListNotesResponse, ListNotesPagedResponse>
listNotesSettings() {
return ((GrafeasStubSettings) getStubSettings()).listNotesSettings();
}
/** Returns the object with the settings used for calls to deleteNote. */
public UnaryCallSettings<DeleteNoteRequest, Empty> deleteNoteSettings() {
return ((GrafeasStubSettings) getStubSettings()).deleteNoteSettings();
}
/** Returns the object with the settings used for calls to createNote. */
public UnaryCallSettings<CreateNoteRequest, Note> createNoteSettings() {
return ((GrafeasStubSettings) getStubSettings()).createNoteSettings();
}
/** Returns the object with the settings used for calls to batchCreateNotes. */
public UnaryCallSettings<BatchCreateNotesRequest, BatchCreateNotesResponse>
batchCreateNotesSettings() {
return ((GrafeasStubSettings) getStubSettings()).batchCreateNotesSettings();
}
/** Returns the object with the settings used for calls to updateNote. */
public UnaryCallSettings<UpdateNoteRequest, Note> updateNoteSettings() {
return ((GrafeasStubSettings) getStubSettings()).updateNoteSettings();
}
/** Returns the object with the settings used for calls to listNoteOccurrences. */
public PagedCallSettings<
ListNoteOccurrencesRequest, ListNoteOccurrencesResponse, ListNoteOccurrencesPagedResponse>
listNoteOccurrencesSettings() {
return ((GrafeasStubSettings) getStubSettings()).listNoteOccurrencesSettings();
}
public static final GrafeasSettings create(GrafeasStubSettings stub) throws IOException {
return new GrafeasSettings.Builder(stub.toBuilder()).build();
}
/** Returns a builder for the default ExecutorProvider for this service. */
public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() {
return GrafeasStubSettings.defaultExecutorProviderBuilder();
}
/** Returns the default service endpoint. */
public static String getDefaultEndpoint() {
return GrafeasStubSettings.getDefaultEndpoint();
}
/** Returns the default service scopes. */
public static List<String> getDefaultServiceScopes() {
return GrafeasStubSettings.getDefaultServiceScopes();
}
/** Returns a builder for the default credentials for this service. */
public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder() {
return GrafeasStubSettings.defaultCredentialsProviderBuilder();
}
/** Returns a builder for the default ChannelProvider for this service. */
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder() {
return GrafeasStubSettings.defaultGrpcTransportProviderBuilder();
}
public static TransportChannelProvider defaultTransportChannelProvider() {
return GrafeasStubSettings.defaultTransportChannelProvider();
}
@BetaApi("The surface for customizing headers is not stable yet and may change in the future.")
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder() {
return GrafeasStubSettings.defaultApiClientHeaderProviderBuilder();
}
/** Returns a new builder for this class. */
public static Builder newBuilder() {
return Builder.createDefault();
}
/** 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 GrafeasSettings(Builder settingsBuilder) throws IOException {
super(settingsBuilder);
}
/** Builder for GrafeasSettings. */
public static class Builder extends ClientSettings.Builder<GrafeasSettings, Builder> {
protected Builder() throws IOException {
this(((ClientContext) null));
}
protected Builder(ClientContext clientContext) {
super(GrafeasStubSettings.newBuilder(clientContext));
}
protected Builder(GrafeasSettings settings) {
super(settings.getStubSettings().toBuilder());
}
protected Builder(GrafeasStubSettings.Builder stubSettings) {
super(stubSettings);
}
private static Builder createDefault() {
return new Builder(GrafeasStubSettings.newBuilder());
}
public GrafeasStubSettings.Builder getStubSettingsBuilder() {
return ((GrafeasStubSettings.Builder) getStubSettings());
}
/**
* Applies the given settings updater function to all of the unary API methods in this service.
*
* <p>Note: This method does not support applying settings to streaming methods.
*/
public Builder applyToAllUnaryMethods(
ApiFunction<UnaryCallSettings.Builder<?, ?>, Void> settingsUpdater) {
super.applyToAllUnaryMethods(
getStubSettingsBuilder().unaryMethodSettingsBuilders(), settingsUpdater);
return this;
}
/** Returns the builder for the settings used for calls to getOccurrence. */
public UnaryCallSettings.Builder<GetOccurrenceRequest, Occurrence> getOccurrenceSettings() {
return getStubSettingsBuilder().getOccurrenceSettings();
}
/** Returns the builder for the settings used for calls to listOccurrences. */
public PagedCallSettings.Builder<
ListOccurrencesRequest, ListOccurrencesResponse, ListOccurrencesPagedResponse>
listOccurrencesSettings() {
return getStubSettingsBuilder().listOccurrencesSettings();
}
/** Returns the builder for the settings used for calls to deleteOccurrence. */
public UnaryCallSettings.Builder<DeleteOccurrenceRequest, Empty> deleteOccurrenceSettings() {
return getStubSettingsBuilder().deleteOccurrenceSettings();
}
/** Returns the builder for the settings used for calls to createOccurrence. */
public UnaryCallSettings.Builder<CreateOccurrenceRequest, Occurrence>
createOccurrenceSettings() {
return getStubSettingsBuilder().createOccurrenceSettings();
}
/** Returns the builder for the settings used for calls to batchCreateOccurrences. */
public UnaryCallSettings.Builder<BatchCreateOccurrencesRequest, BatchCreateOccurrencesResponse>
batchCreateOccurrencesSettings() {
return getStubSettingsBuilder().batchCreateOccurrencesSettings();
}
/** Returns the builder for the settings used for calls to updateOccurrence. */
public UnaryCallSettings.Builder<UpdateOccurrenceRequest, Occurrence>
updateOccurrenceSettings() {
return getStubSettingsBuilder().updateOccurrenceSettings();
}
/** Returns the builder for the settings used for calls to getOccurrenceNote. */
public UnaryCallSettings.Builder<GetOccurrenceNoteRequest, Note> getOccurrenceNoteSettings() {
return getStubSettingsBuilder().getOccurrenceNoteSettings();
}
/** Returns the builder for the settings used for calls to getNote. */
public UnaryCallSettings.Builder<GetNoteRequest, Note> getNoteSettings() {
return getStubSettingsBuilder().getNoteSettings();
}
/** Returns the builder for the settings used for calls to listNotes. */
public PagedCallSettings.Builder<ListNotesRequest, ListNotesResponse, ListNotesPagedResponse>
listNotesSettings() {
return getStubSettingsBuilder().listNotesSettings();
}
/** Returns the builder for the settings used for calls to deleteNote. */
public UnaryCallSettings.Builder<DeleteNoteRequest, Empty> deleteNoteSettings() {
return getStubSettingsBuilder().deleteNoteSettings();
}
/** Returns the builder for the settings used for calls to createNote. */
public UnaryCallSettings.Builder<CreateNoteRequest, Note> createNoteSettings() {
return getStubSettingsBuilder().createNoteSettings();
}
/** Returns the builder for the settings used for calls to batchCreateNotes. */
public UnaryCallSettings.Builder<BatchCreateNotesRequest, BatchCreateNotesResponse>
batchCreateNotesSettings() {
return getStubSettingsBuilder().batchCreateNotesSettings();
}
/** Returns the builder for the settings used for calls to updateNote. */
public UnaryCallSettings.Builder<UpdateNoteRequest, Note> updateNoteSettings() {
return getStubSettingsBuilder().updateNoteSettings();
}
/** Returns the builder for the settings used for calls to listNoteOccurrences. */
public PagedCallSettings.Builder<
ListNoteOccurrencesRequest,
ListNoteOccurrencesResponse,
ListNoteOccurrencesPagedResponse>
listNoteOccurrencesSettings() {
return getStubSettingsBuilder().listNoteOccurrencesSettings();
}
@Override
public GrafeasSettings build() throws IOException {
return new GrafeasSettings(this);
}
}
}