com.google.cloud.retail.v2alpha.stub.HttpJsonModelServiceStub Maven / Gradle / Ivy
/*
* 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.retail.v2alpha.stub;
import static com.google.cloud.retail.v2alpha.ModelServiceClient.ListModelsPagedResponse;
import com.google.api.HttpRule;
import com.google.api.core.BetaApi;
import com.google.api.core.InternalApi;
import com.google.api.gax.core.BackgroundResource;
import com.google.api.gax.core.BackgroundResourceAggregation;
import com.google.api.gax.httpjson.ApiMethodDescriptor;
import com.google.api.gax.httpjson.HttpJsonCallSettings;
import com.google.api.gax.httpjson.HttpJsonOperationSnapshot;
import com.google.api.gax.httpjson.HttpJsonStubCallableFactory;
import com.google.api.gax.httpjson.ProtoMessageRequestFormatter;
import com.google.api.gax.httpjson.ProtoMessageResponseParser;
import com.google.api.gax.httpjson.ProtoRestSerializer;
import com.google.api.gax.httpjson.longrunning.stub.HttpJsonOperationsStub;
import com.google.api.gax.rpc.ClientContext;
import com.google.api.gax.rpc.OperationCallable;
import com.google.api.gax.rpc.RequestParamsBuilder;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.cloud.retail.v2alpha.CreateModelMetadata;
import com.google.cloud.retail.v2alpha.CreateModelRequest;
import com.google.cloud.retail.v2alpha.DeleteModelRequest;
import com.google.cloud.retail.v2alpha.GetModelRequest;
import com.google.cloud.retail.v2alpha.ListModelsRequest;
import com.google.cloud.retail.v2alpha.ListModelsResponse;
import com.google.cloud.retail.v2alpha.Model;
import com.google.cloud.retail.v2alpha.PauseModelRequest;
import com.google.cloud.retail.v2alpha.ResumeModelRequest;
import com.google.cloud.retail.v2alpha.TuneModelMetadata;
import com.google.cloud.retail.v2alpha.TuneModelRequest;
import com.google.cloud.retail.v2alpha.TuneModelResponse;
import com.google.cloud.retail.v2alpha.UpdateModelRequest;
import com.google.common.collect.ImmutableMap;
import com.google.longrunning.Operation;
import com.google.protobuf.Empty;
import com.google.protobuf.TypeRegistry;
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* REST stub implementation for the ModelService service API.
*
* This class is for advanced usage and reflects the underlying API directly.
*/
@BetaApi
@Generated("by gapic-generator-java")
public class HttpJsonModelServiceStub extends ModelServiceStub {
private static final TypeRegistry typeRegistry =
TypeRegistry.newBuilder()
.add(TuneModelMetadata.getDescriptor())
.add(Model.getDescriptor())
.add(TuneModelResponse.getDescriptor())
.add(CreateModelMetadata.getDescriptor())
.build();
private static final ApiMethodDescriptor
createModelMethodDescriptor =
ApiMethodDescriptor.newBuilder()
.setFullMethodName("google.cloud.retail.v2alpha.ModelService/CreateModel")
.setHttpMethod("POST")
.setType(ApiMethodDescriptor.MethodType.UNARY)
.setRequestFormatter(
ProtoMessageRequestFormatter.newBuilder()
.setPath(
"/v2alpha/{parent=projects/*/locations/*/catalogs/*}/models",
request -> {
Map fields = new HashMap<>();
ProtoRestSerializer serializer =
ProtoRestSerializer.create();
serializer.putPathParam(fields, "parent", request.getParent());
return fields;
})
.setQueryParamsExtractor(
request -> {
Map> fields = new HashMap<>();
ProtoRestSerializer serializer =
ProtoRestSerializer.create();
serializer.putQueryParam(fields, "dryRun", request.getDryRun());
serializer.putQueryParam(fields, "$alt", "json;enum-encoding=int");
return fields;
})
.setRequestBodyExtractor(
request ->
ProtoRestSerializer.create()
.toBody("model", request.getModel(), true))
.build())
.setResponseParser(
ProtoMessageResponseParser.newBuilder()
.setDefaultInstance(Operation.getDefaultInstance())
.setDefaultTypeRegistry(typeRegistry)
.build())
.setOperationSnapshotFactory(
(CreateModelRequest request, Operation response) ->
HttpJsonOperationSnapshot.create(response))
.build();
private static final ApiMethodDescriptor getModelMethodDescriptor =
ApiMethodDescriptor.newBuilder()
.setFullMethodName("google.cloud.retail.v2alpha.ModelService/GetModel")
.setHttpMethod("GET")
.setType(ApiMethodDescriptor.MethodType.UNARY)
.setRequestFormatter(
ProtoMessageRequestFormatter.newBuilder()
.setPath(
"/v2alpha/{name=projects/*/locations/*/catalogs/*/models/*}",
request -> {
Map fields = new HashMap<>();
ProtoRestSerializer serializer =
ProtoRestSerializer.create();
serializer.putPathParam(fields, "name", request.getName());
return fields;
})
.setQueryParamsExtractor(
request -> {
Map> fields = new HashMap<>();
ProtoRestSerializer serializer =
ProtoRestSerializer.create();
serializer.putQueryParam(fields, "$alt", "json;enum-encoding=int");
return fields;
})
.setRequestBodyExtractor(request -> null)
.build())
.setResponseParser(
ProtoMessageResponseParser.newBuilder()
.setDefaultInstance(Model.getDefaultInstance())
.setDefaultTypeRegistry(typeRegistry)
.build())
.build();
private static final ApiMethodDescriptor pauseModelMethodDescriptor =
ApiMethodDescriptor.newBuilder()
.setFullMethodName("google.cloud.retail.v2alpha.ModelService/PauseModel")
.setHttpMethod("POST")
.setType(ApiMethodDescriptor.MethodType.UNARY)
.setRequestFormatter(
ProtoMessageRequestFormatter.newBuilder()
.setPath(
"/v2alpha/{name=projects/*/locations/*/catalogs/*/models/*}:pause",
request -> {
Map fields = new HashMap<>();
ProtoRestSerializer serializer =
ProtoRestSerializer.create();
serializer.putPathParam(fields, "name", request.getName());
return fields;
})
.setQueryParamsExtractor(
request -> {
Map> fields = new HashMap<>();
ProtoRestSerializer serializer =
ProtoRestSerializer.create();
serializer.putQueryParam(fields, "$alt", "json;enum-encoding=int");
return fields;
})
.setRequestBodyExtractor(
request ->
ProtoRestSerializer.create()
.toBody("*", request.toBuilder().clearName().build(), true))
.build())
.setResponseParser(
ProtoMessageResponseParser.newBuilder()
.setDefaultInstance(Model.getDefaultInstance())
.setDefaultTypeRegistry(typeRegistry)
.build())
.build();
private static final ApiMethodDescriptor resumeModelMethodDescriptor =
ApiMethodDescriptor.newBuilder()
.setFullMethodName("google.cloud.retail.v2alpha.ModelService/ResumeModel")
.setHttpMethod("POST")
.setType(ApiMethodDescriptor.MethodType.UNARY)
.setRequestFormatter(
ProtoMessageRequestFormatter.newBuilder()
.setPath(
"/v2alpha/{name=projects/*/locations/*/catalogs/*/models/*}:resume",
request -> {
Map fields = new HashMap<>();
ProtoRestSerializer serializer =
ProtoRestSerializer.create();
serializer.putPathParam(fields, "name", request.getName());
return fields;
})
.setQueryParamsExtractor(
request -> {
Map> fields = new HashMap<>();
ProtoRestSerializer serializer =
ProtoRestSerializer.create();
serializer.putQueryParam(fields, "$alt", "json;enum-encoding=int");
return fields;
})
.setRequestBodyExtractor(
request ->
ProtoRestSerializer.create()
.toBody("*", request.toBuilder().clearName().build(), true))
.build())
.setResponseParser(
ProtoMessageResponseParser.newBuilder()
.setDefaultInstance(Model.getDefaultInstance())
.setDefaultTypeRegistry(typeRegistry)
.build())
.build();
private static final ApiMethodDescriptor deleteModelMethodDescriptor =
ApiMethodDescriptor.newBuilder()
.setFullMethodName("google.cloud.retail.v2alpha.ModelService/DeleteModel")
.setHttpMethod("DELETE")
.setType(ApiMethodDescriptor.MethodType.UNARY)
.setRequestFormatter(
ProtoMessageRequestFormatter.newBuilder()
.setPath(
"/v2alpha/{name=projects/*/locations/*/catalogs/*/models/*}",
request -> {
Map fields = new HashMap<>();
ProtoRestSerializer serializer =
ProtoRestSerializer.create();
serializer.putPathParam(fields, "name", request.getName());
return fields;
})
.setQueryParamsExtractor(
request -> {
Map> fields = new HashMap<>();
ProtoRestSerializer serializer =
ProtoRestSerializer.create();
serializer.putQueryParam(fields, "$alt", "json;enum-encoding=int");
return fields;
})
.setRequestBodyExtractor(request -> null)
.build())
.setResponseParser(
ProtoMessageResponseParser.newBuilder()
.setDefaultInstance(Empty.getDefaultInstance())
.setDefaultTypeRegistry(typeRegistry)
.build())
.build();
private static final ApiMethodDescriptor
listModelsMethodDescriptor =
ApiMethodDescriptor.newBuilder()
.setFullMethodName("google.cloud.retail.v2alpha.ModelService/ListModels")
.setHttpMethod("GET")
.setType(ApiMethodDescriptor.MethodType.UNARY)
.setRequestFormatter(
ProtoMessageRequestFormatter.newBuilder()
.setPath(
"/v2alpha/{parent=projects/*/locations/*/catalogs/*}/models",
request -> {
Map fields = new HashMap<>();
ProtoRestSerializer serializer =
ProtoRestSerializer.create();
serializer.putPathParam(fields, "parent", request.getParent());
return fields;
})
.setQueryParamsExtractor(
request -> {
Map> fields = new HashMap<>();
ProtoRestSerializer serializer =
ProtoRestSerializer.create();
serializer.putQueryParam(fields, "pageSize", request.getPageSize());
serializer.putQueryParam(fields, "pageToken", request.getPageToken());
serializer.putQueryParam(fields, "$alt", "json;enum-encoding=int");
return fields;
})
.setRequestBodyExtractor(request -> null)
.build())
.setResponseParser(
ProtoMessageResponseParser.newBuilder()
.setDefaultInstance(ListModelsResponse.getDefaultInstance())
.setDefaultTypeRegistry(typeRegistry)
.build())
.build();
private static final ApiMethodDescriptor updateModelMethodDescriptor =
ApiMethodDescriptor.newBuilder()
.setFullMethodName("google.cloud.retail.v2alpha.ModelService/UpdateModel")
.setHttpMethod("PATCH")
.setType(ApiMethodDescriptor.MethodType.UNARY)
.setRequestFormatter(
ProtoMessageRequestFormatter.newBuilder()
.setPath(
"/v2alpha/{model.name=projects/*/locations/*/catalogs/*/models/*}",
request -> {
Map fields = new HashMap<>();
ProtoRestSerializer serializer =
ProtoRestSerializer.create();
serializer.putPathParam(fields, "model.name", request.getModel().getName());
return fields;
})
.setQueryParamsExtractor(
request -> {
Map> fields = new HashMap<>();
ProtoRestSerializer serializer =
ProtoRestSerializer.create();
serializer.putQueryParam(fields, "updateMask", request.getUpdateMask());
serializer.putQueryParam(fields, "$alt", "json;enum-encoding=int");
return fields;
})
.setRequestBodyExtractor(
request ->
ProtoRestSerializer.create().toBody("model", request.getModel(), true))
.build())
.setResponseParser(
ProtoMessageResponseParser.newBuilder()
.setDefaultInstance(Model.getDefaultInstance())
.setDefaultTypeRegistry(typeRegistry)
.build())
.build();
private static final ApiMethodDescriptor tuneModelMethodDescriptor =
ApiMethodDescriptor.newBuilder()
.setFullMethodName("google.cloud.retail.v2alpha.ModelService/TuneModel")
.setHttpMethod("POST")
.setType(ApiMethodDescriptor.MethodType.UNARY)
.setRequestFormatter(
ProtoMessageRequestFormatter.newBuilder()
.setPath(
"/v2alpha/{name=projects/*/locations/*/catalogs/*/models/*}:tune",
request -> {
Map fields = new HashMap<>();
ProtoRestSerializer serializer =
ProtoRestSerializer.create();
serializer.putPathParam(fields, "name", request.getName());
return fields;
})
.setQueryParamsExtractor(
request -> {
Map> fields = new HashMap<>();
ProtoRestSerializer serializer =
ProtoRestSerializer.create();
serializer.putQueryParam(fields, "$alt", "json;enum-encoding=int");
return fields;
})
.setRequestBodyExtractor(
request ->
ProtoRestSerializer.create()
.toBody("*", request.toBuilder().clearName().build(), true))
.build())
.setResponseParser(
ProtoMessageResponseParser.newBuilder()
.setDefaultInstance(Operation.getDefaultInstance())
.setDefaultTypeRegistry(typeRegistry)
.build())
.setOperationSnapshotFactory(
(TuneModelRequest request, Operation response) ->
HttpJsonOperationSnapshot.create(response))
.build();
private final UnaryCallable createModelCallable;
private final OperationCallable
createModelOperationCallable;
private final UnaryCallable getModelCallable;
private final UnaryCallable pauseModelCallable;
private final UnaryCallable resumeModelCallable;
private final UnaryCallable deleteModelCallable;
private final UnaryCallable listModelsCallable;
private final UnaryCallable listModelsPagedCallable;
private final UnaryCallable updateModelCallable;
private final UnaryCallable tuneModelCallable;
private final OperationCallable
tuneModelOperationCallable;
private final BackgroundResource backgroundResources;
private final HttpJsonOperationsStub httpJsonOperationsStub;
private final HttpJsonStubCallableFactory callableFactory;
public static final HttpJsonModelServiceStub create(ModelServiceStubSettings settings)
throws IOException {
return new HttpJsonModelServiceStub(settings, ClientContext.create(settings));
}
public static final HttpJsonModelServiceStub create(ClientContext clientContext)
throws IOException {
return new HttpJsonModelServiceStub(
ModelServiceStubSettings.newHttpJsonBuilder().build(), clientContext);
}
public static final HttpJsonModelServiceStub create(
ClientContext clientContext, HttpJsonStubCallableFactory callableFactory) throws IOException {
return new HttpJsonModelServiceStub(
ModelServiceStubSettings.newHttpJsonBuilder().build(), clientContext, callableFactory);
}
/**
* Constructs an instance of HttpJsonModelServiceStub, using the given settings. This is protected
* so that it is easy to make a subclass, but otherwise, the static factory methods should be
* preferred.
*/
protected HttpJsonModelServiceStub(ModelServiceStubSettings settings, ClientContext clientContext)
throws IOException {
this(settings, clientContext, new HttpJsonModelServiceCallableFactory());
}
/**
* Constructs an instance of HttpJsonModelServiceStub, using the given settings. This is protected
* so that it is easy to make a subclass, but otherwise, the static factory methods should be
* preferred.
*/
protected HttpJsonModelServiceStub(
ModelServiceStubSettings settings,
ClientContext clientContext,
HttpJsonStubCallableFactory callableFactory)
throws IOException {
this.callableFactory = callableFactory;
this.httpJsonOperationsStub =
HttpJsonOperationsStub.create(
clientContext,
callableFactory,
typeRegistry,
ImmutableMap.builder()
.put(
"google.longrunning.Operations.GetOperation",
HttpRule.newBuilder()
.setGet(
"/v2alpha/{name=projects/*/locations/*/catalogs/*/branches/*/operations/*}")
.addAdditionalBindings(
HttpRule.newBuilder()
.setGet(
"/v2alpha/{name=projects/*/locations/*/catalogs/*/branches/*/places/*/operations/*}")
.build())
.addAdditionalBindings(
HttpRule.newBuilder()
.setGet(
"/v2alpha/{name=projects/*/locations/*/catalogs/*/operations/*}")
.build())
.addAdditionalBindings(
HttpRule.newBuilder()
.setGet("/v2alpha/{name=projects/*/locations/*/operations/*}")
.build())
.addAdditionalBindings(
HttpRule.newBuilder()
.setGet("/v2alpha/{name=projects/*/operations/*}")
.build())
.build())
.put(
"google.longrunning.Operations.ListOperations",
HttpRule.newBuilder()
.setGet("/v2alpha/{name=projects/*/locations/*/catalogs/*}/operations")
.addAdditionalBindings(
HttpRule.newBuilder()
.setGet("/v2alpha/{name=projects/*/locations/*}/operations")
.build())
.addAdditionalBindings(
HttpRule.newBuilder()
.setGet("/v2alpha/{name=projects/*}/operations")
.build())
.build())
.build());
HttpJsonCallSettings createModelTransportSettings =
HttpJsonCallSettings.newBuilder()
.setMethodDescriptor(createModelMethodDescriptor)
.setTypeRegistry(typeRegistry)
.setParamsExtractor(
request -> {
RequestParamsBuilder builder = RequestParamsBuilder.create();
builder.add("parent", String.valueOf(request.getParent()));
return builder.build();
})
.build();
HttpJsonCallSettings getModelTransportSettings =
HttpJsonCallSettings.newBuilder()
.setMethodDescriptor(getModelMethodDescriptor)
.setTypeRegistry(typeRegistry)
.setParamsExtractor(
request -> {
RequestParamsBuilder builder = RequestParamsBuilder.create();
builder.add("name", String.valueOf(request.getName()));
return builder.build();
})
.build();
HttpJsonCallSettings pauseModelTransportSettings =
HttpJsonCallSettings.newBuilder()
.setMethodDescriptor(pauseModelMethodDescriptor)
.setTypeRegistry(typeRegistry)
.setParamsExtractor(
request -> {
RequestParamsBuilder builder = RequestParamsBuilder.create();
builder.add("name", String.valueOf(request.getName()));
return builder.build();
})
.build();
HttpJsonCallSettings resumeModelTransportSettings =
HttpJsonCallSettings.newBuilder()
.setMethodDescriptor(resumeModelMethodDescriptor)
.setTypeRegistry(typeRegistry)
.setParamsExtractor(
request -> {
RequestParamsBuilder builder = RequestParamsBuilder.create();
builder.add("name", String.valueOf(request.getName()));
return builder.build();
})
.build();
HttpJsonCallSettings deleteModelTransportSettings =
HttpJsonCallSettings.newBuilder()
.setMethodDescriptor(deleteModelMethodDescriptor)
.setTypeRegistry(typeRegistry)
.setParamsExtractor(
request -> {
RequestParamsBuilder builder = RequestParamsBuilder.create();
builder.add("name", String.valueOf(request.getName()));
return builder.build();
})
.build();
HttpJsonCallSettings listModelsTransportSettings =
HttpJsonCallSettings.newBuilder()
.setMethodDescriptor(listModelsMethodDescriptor)
.setTypeRegistry(typeRegistry)
.setParamsExtractor(
request -> {
RequestParamsBuilder builder = RequestParamsBuilder.create();
builder.add("parent", String.valueOf(request.getParent()));
return builder.build();
})
.build();
HttpJsonCallSettings updateModelTransportSettings =
HttpJsonCallSettings.newBuilder()
.setMethodDescriptor(updateModelMethodDescriptor)
.setTypeRegistry(typeRegistry)
.setParamsExtractor(
request -> {
RequestParamsBuilder builder = RequestParamsBuilder.create();
builder.add("model.name", String.valueOf(request.getModel().getName()));
return builder.build();
})
.build();
HttpJsonCallSettings tuneModelTransportSettings =
HttpJsonCallSettings.newBuilder()
.setMethodDescriptor(tuneModelMethodDescriptor)
.setTypeRegistry(typeRegistry)
.setParamsExtractor(
request -> {
RequestParamsBuilder builder = RequestParamsBuilder.create();
builder.add("name", String.valueOf(request.getName()));
return builder.build();
})
.build();
this.createModelCallable =
callableFactory.createUnaryCallable(
createModelTransportSettings, settings.createModelSettings(), clientContext);
this.createModelOperationCallable =
callableFactory.createOperationCallable(
createModelTransportSettings,
settings.createModelOperationSettings(),
clientContext,
httpJsonOperationsStub);
this.getModelCallable =
callableFactory.createUnaryCallable(
getModelTransportSettings, settings.getModelSettings(), clientContext);
this.pauseModelCallable =
callableFactory.createUnaryCallable(
pauseModelTransportSettings, settings.pauseModelSettings(), clientContext);
this.resumeModelCallable =
callableFactory.createUnaryCallable(
resumeModelTransportSettings, settings.resumeModelSettings(), clientContext);
this.deleteModelCallable =
callableFactory.createUnaryCallable(
deleteModelTransportSettings, settings.deleteModelSettings(), clientContext);
this.listModelsCallable =
callableFactory.createUnaryCallable(
listModelsTransportSettings, settings.listModelsSettings(), clientContext);
this.listModelsPagedCallable =
callableFactory.createPagedCallable(
listModelsTransportSettings, settings.listModelsSettings(), clientContext);
this.updateModelCallable =
callableFactory.createUnaryCallable(
updateModelTransportSettings, settings.updateModelSettings(), clientContext);
this.tuneModelCallable =
callableFactory.createUnaryCallable(
tuneModelTransportSettings, settings.tuneModelSettings(), clientContext);
this.tuneModelOperationCallable =
callableFactory.createOperationCallable(
tuneModelTransportSettings,
settings.tuneModelOperationSettings(),
clientContext,
httpJsonOperationsStub);
this.backgroundResources =
new BackgroundResourceAggregation(clientContext.getBackgroundResources());
}
@InternalApi
public static List getMethodDescriptors() {
List methodDescriptors = new ArrayList<>();
methodDescriptors.add(createModelMethodDescriptor);
methodDescriptors.add(getModelMethodDescriptor);
methodDescriptors.add(pauseModelMethodDescriptor);
methodDescriptors.add(resumeModelMethodDescriptor);
methodDescriptors.add(deleteModelMethodDescriptor);
methodDescriptors.add(listModelsMethodDescriptor);
methodDescriptors.add(updateModelMethodDescriptor);
methodDescriptors.add(tuneModelMethodDescriptor);
return methodDescriptors;
}
public HttpJsonOperationsStub getHttpJsonOperationsStub() {
return httpJsonOperationsStub;
}
@Override
public UnaryCallable createModelCallable() {
return createModelCallable;
}
@Override
public OperationCallable
createModelOperationCallable() {
return createModelOperationCallable;
}
@Override
public UnaryCallable getModelCallable() {
return getModelCallable;
}
@Override
public UnaryCallable pauseModelCallable() {
return pauseModelCallable;
}
@Override
public UnaryCallable resumeModelCallable() {
return resumeModelCallable;
}
@Override
public UnaryCallable deleteModelCallable() {
return deleteModelCallable;
}
@Override
public UnaryCallable listModelsCallable() {
return listModelsCallable;
}
@Override
public UnaryCallable listModelsPagedCallable() {
return listModelsPagedCallable;
}
@Override
public UnaryCallable updateModelCallable() {
return updateModelCallable;
}
@Override
public UnaryCallable tuneModelCallable() {
return tuneModelCallable;
}
@Override
public OperationCallable
tuneModelOperationCallable() {
return tuneModelOperationCallable;
}
@Override
public final void close() {
try {
backgroundResources.close();
} catch (RuntimeException e) {
throw e;
} catch (Exception e) {
throw new IllegalStateException("Failed to close resource", e);
}
}
@Override
public void shutdown() {
backgroundResources.shutdown();
}
@Override
public boolean isShutdown() {
return backgroundResources.isShutdown();
}
@Override
public boolean isTerminated() {
return backgroundResources.isTerminated();
}
@Override
public void shutdownNow() {
backgroundResources.shutdownNow();
}
@Override
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException {
return backgroundResources.awaitTermination(duration, unit);
}
}