Skip to content
This repository was archived by the owner on Sep 26, 2023. It is now read-only.

Stub Settings #459

Merged
andreamlin merged 13 commits into from
Jan 31, 2018
Merged

Stub Settings #459

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
870ab4f
StubSettings is autovalued
andreamlin Jan 24, 2018
1941f44
tests pass
andreamlin Jan 24, 2018
b8ed3af
stub settings extends clientsettings
andreamlin Jan 24, 2018
ca81036
got hand edited pubsub to work
andreamlin Jan 24, 2018
e9bae2e
all tests pass
andreamlin Jan 24, 2018
b2972f1
formatting
andreamlin Jan 24, 2018
0738574
restore public static getDefault*() methods in OperationsSettings
andreamlin Jan 24, 2018
c87c860
fix comments and remove dead code
andreamlin Jan 25, 2018
f1427a1
remote createStub() and put all public static methods in same place i…
andreamlin Jan 25, 2018
c2c9ed8
update OperationsClient so compiles
andreamlin Jan 25, 2018
d417d1b
remove setInternalHeaderProvider override
andreamlin Jan 26, 2018
91d0144
Merge branch 'master' into stubsettings
andreamlin Jan 30, 2018
93119e5
updated longrunning gen from newest toolkit
andreamlin Jan 30, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
250 changes: 29 additions & 221 deletions gax-grpc/src/main/java/com/google/longrunning/OperationsSettings.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2017, Google LLC All rights reserved.
* Copyright 2018, Google LLC All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
Expand Down Expand Up @@ -32,98 +32,52 @@
import static com.google.longrunning.PagedResponseWrappers.ListOperationsPagedResponse;

import com.google.api.core.ApiFunction;
import com.google.api.core.ApiFuture;
import com.google.api.core.BetaApi;
import com.google.api.gax.core.GaxProperties;
import com.google.api.gax.core.GoogleCredentialsProvider;
import com.google.api.gax.core.InstantiatingExecutorProvider;
import com.google.api.gax.grpc.GaxGrpcProperties;
import com.google.api.gax.grpc.GrpcTransportChannel;
import com.google.api.gax.retrying.RetrySettings;
import com.google.api.gax.rpc.ApiCallContext;
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.PageContext;
import com.google.api.gax.rpc.PagedCallSettings;
import com.google.api.gax.rpc.PagedListDescriptor;
import com.google.api.gax.rpc.PagedListResponseFactory;
import com.google.api.gax.rpc.StatusCode;
import com.google.api.gax.rpc.UnaryCallSettings;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Lists;
import com.google.longrunning.stub.GrpcOperationsStub;
import com.google.longrunning.stub.OperationsStub;
import com.google.longrunning.stub.OperationsStubSettings;
import com.google.protobuf.Empty;
import java.io.IOException;
import javax.annotation.Generated;
import org.threeten.bp.Duration;

// AUTO-GENERATED DOCUMENTATION AND CLASS
/** Settings class to configure an instance of {@link OperationsClient}. */
@Generated("by GAPIC v0.0.5")
@BetaApi
public class OperationsSettings extends ClientSettings<OperationsSettings> {
private final UnaryCallSettings<GetOperationRequest, Operation> getOperationSettings;
private final PagedCallSettings<
ListOperationsRequest, ListOperationsResponse, ListOperationsPagedResponse>
listOperationsSettings;
private final UnaryCallSettings<CancelOperationRequest, Empty> cancelOperationSettings;
private final UnaryCallSettings<DeleteOperationRequest, Empty> deleteOperationSettings;

public static final OperationsSettings create(OperationsStubSettings stub) throws IOException {
return new OperationsSettings.Builder(stub.toBuilder()).build();
}

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view


/** Returns the object with the settings used for calls to getOperation. */
public UnaryCallSettings<GetOperationRequest, Operation> getOperationSettings() {
return getOperationSettings;
return ((OperationsStubSettings) getStubSettings()).getOperationSettings();
}

/** Returns the object with the settings used for calls to listOperations. */
public PagedCallSettings<
ListOperationsRequest, ListOperationsResponse, ListOperationsPagedResponse>
listOperationsSettings() {
return listOperationsSettings;
return ((OperationsStubSettings) getStubSettings()).listOperationsSettings();
}

/** Returns the object with the settings used for calls to cancelOperation. */
public UnaryCallSettings<CancelOperationRequest, Empty> cancelOperationSettings() {
return cancelOperationSettings;
return ((OperationsStubSettings) getStubSettings()).cancelOperationSettings();
}

/** Returns the object with the settings used for calls to deleteOperation. */
public UnaryCallSettings<DeleteOperationRequest, Empty> deleteOperationSettings() {
return deleteOperationSettings;
return ((OperationsStubSettings) getStubSettings()).deleteOperationSettings();
}

@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public OperationsStub createStub() throws IOException {

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

if (getTransportChannelProvider()
.getTransportName()
.equals(GrpcTransportChannel.getGrpcTransportName())) {
return GrpcOperationsStub.create(this);
} else {
throw new UnsupportedOperationException(
"Transport not supported: " + getTransportChannelProvider().getTransportName());
}
}

/** Returns a builder for the default ExecutorProvider for this service. */
public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() {
return InstantiatingExecutorProvider.newBuilder();
}

/** Returns a builder for the default credentials for this service. */
public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder() {

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

return GoogleCredentialsProvider.newBuilder();
}

@BetaApi("The surface for customizing headers is not stable yet and may change in the future.")
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder() {
return ApiClientHeaderProvider.newBuilder()
.setGeneratedLibToken("gapic", GaxProperties.getLibraryVersion(OperationsSettings.class))
.setTransportToken(
GaxGrpcProperties.getGrpcTokenName(), GaxGrpcProperties.getGrpcVersion());
return ((OperationsStubSettings) getStubSettings()).createStub();
}

/** Returns a new builder for this class. */
Expand All @@ -141,181 +95,34 @@ public Builder toBuilder() {
return new Builder(this);
}

private OperationsSettings(Builder settingsBuilder) throws IOException {
protected OperationsSettings(Builder settingsBuilder) throws IOException {
super(settingsBuilder);

getOperationSettings = settingsBuilder.getOperationSettings().build();
listOperationsSettings = settingsBuilder.listOperationsSettings().build();
cancelOperationSettings = settingsBuilder.cancelOperationSettings().build();
deleteOperationSettings = settingsBuilder.deleteOperationSettings().build();
}

private static final PagedListDescriptor<ListOperationsRequest, ListOperationsResponse, Operation>
LIST_OPERATIONS_PAGE_STR_DESC =
new PagedListDescriptor<ListOperationsRequest, ListOperationsResponse, Operation>() {
@Override
public String emptyToken() {
return "";
}

@Override
public ListOperationsRequest injectToken(ListOperationsRequest payload, String token) {
return ListOperationsRequest.newBuilder(payload).setPageToken(token).build();
}

@Override
public ListOperationsRequest injectPageSize(
ListOperationsRequest payload, int pageSize) {
return ListOperationsRequest.newBuilder(payload).setPageSize(pageSize).build();
}

@Override
public Integer extractPageSize(ListOperationsRequest payload) {
return payload.getPageSize();
}

@Override
public String extractNextToken(ListOperationsResponse payload) {
return payload.getNextPageToken();
}

@Override
public Iterable<Operation> extractResources(ListOperationsResponse payload) {
return payload.getOperationsList();
}
};

private static final PagedListResponseFactory<
ListOperationsRequest, ListOperationsResponse, ListOperationsPagedResponse>
LIST_OPERATIONS_PAGE_STR_FACT =
new PagedListResponseFactory<
ListOperationsRequest, ListOperationsResponse, ListOperationsPagedResponse>() {
@Override
public ApiFuture<ListOperationsPagedResponse> getFuturePagedResponse(
UnaryCallable<ListOperationsRequest, ListOperationsResponse> callable,
ListOperationsRequest request,
ApiCallContext context,
ApiFuture<ListOperationsResponse> futureResponse) {
PageContext<ListOperationsRequest, ListOperationsResponse, Operation> pageContext =
PageContext.create(callable, LIST_OPERATIONS_PAGE_STR_DESC, request, context);
return ListOperationsPagedResponse.createAsync(pageContext, futureResponse);
}
};

/** Builder for OperationsSettings. */
public static class Builder extends ClientSettings.Builder<OperationsSettings, Builder> {
private final ImmutableList<UnaryCallSettings.Builder<?, ?>> unaryMethodSettingsBuilders;

private final UnaryCallSettings.Builder<GetOperationRequest, Operation> getOperationSettings;
private final PagedCallSettings.Builder<
ListOperationsRequest, ListOperationsResponse, ListOperationsPagedResponse>
listOperationsSettings;
private final UnaryCallSettings.Builder<CancelOperationRequest, Empty> cancelOperationSettings;
private final UnaryCallSettings.Builder<DeleteOperationRequest, Empty> deleteOperationSettings;

private static final ImmutableMap<String, ImmutableSet<StatusCode.Code>>
RETRYABLE_CODE_DEFINITIONS;

static {
ImmutableMap.Builder<String, ImmutableSet<StatusCode.Code>> definitions =
ImmutableMap.builder();
definitions.put(
"idempotent",
ImmutableSet.copyOf(
Lists.<StatusCode.Code>newArrayList(
StatusCode.Code.DEADLINE_EXCEEDED, StatusCode.Code.UNAVAILABLE)));
definitions.put("non_idempotent", ImmutableSet.copyOf(Lists.<StatusCode.Code>newArrayList()));
RETRYABLE_CODE_DEFINITIONS = definitions.build();
}

private static final ImmutableMap<String, RetrySettings> RETRY_PARAM_DEFINITIONS;

static {
ImmutableMap.Builder<String, RetrySettings> definitions = ImmutableMap.builder();
RetrySettings settings = null;
settings =
RetrySettings.newBuilder()
.setInitialRetryDelay(Duration.ofMillis(100L))
.setRetryDelayMultiplier(1.3)
.setMaxRetryDelay(Duration.ofMillis(60000L))
.setInitialRpcTimeout(Duration.ofMillis(90000L))
.setRpcTimeoutMultiplier(1.0)
.setMaxRpcTimeout(Duration.ofMillis(90000L))
.setTotalTimeout(Duration.ofMillis(600000L))
.build();
definitions.put("default", settings);
RETRY_PARAM_DEFINITIONS = definitions.build();
}

private Builder() {
protected Builder() throws IOException {
this((ClientContext) null);
}

private Builder(ClientContext clientContext) {
super(clientContext);

getOperationSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();

listOperationsSettings = PagedCallSettings.newBuilder(LIST_OPERATIONS_PAGE_STR_FACT);

cancelOperationSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();

deleteOperationSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();

unaryMethodSettingsBuilders =
ImmutableList.<UnaryCallSettings.Builder<?, ?>>of(
getOperationSettings,
listOperationsSettings,
cancelOperationSettings,
deleteOperationSettings);

initDefaults(this);
protected Builder(ClientContext clientContext) {
super(OperationsStubSettings.newBuilder(clientContext));
}

private static Builder createDefault() {
Builder builder = new Builder((ClientContext) null);
return initDefaults(builder);
return new Builder(OperationsStubSettings.newBuilder());
}

private static Builder initDefaults(Builder builder) {

builder
.getOperationSettings()
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("idempotent"))
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("default"));

builder
.listOperationsSettings()
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("idempotent"))
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("default"));

builder
.cancelOperationSettings()
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("idempotent"))
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("default"));

builder
.deleteOperationSettings()
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("idempotent"))
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("default"));

return builder;
protected Builder(OperationsSettings settings) {
super(settings.getStubSettings().toBuilder());
}

private Builder(OperationsSettings settings) {
super(settings);

getOperationSettings = settings.getOperationSettings.toBuilder();
listOperationsSettings = settings.listOperationsSettings.toBuilder();
cancelOperationSettings = settings.cancelOperationSettings.toBuilder();
deleteOperationSettings = settings.deleteOperationSettings.toBuilder();
protected Builder(OperationsStubSettings.Builder stubSettings) {
super(stubSettings);
}

unaryMethodSettingsBuilders =
ImmutableList.<UnaryCallSettings.Builder<?, ?>>of(
getOperationSettings,
listOperationsSettings,
cancelOperationSettings,
deleteOperationSettings);
public OperationsStubSettings.Builder getStubSettingsBuilder() {
return ((OperationsStubSettings.Builder) getStubSettings());
}

/**
Expand All @@ -325,30 +132,31 @@ private Builder(OperationsSettings settings) {
*/
public Builder applyToAllUnaryMethods(
ApiFunction<UnaryCallSettings.Builder<?, ?>, Void> settingsUpdater) throws Exception {
super.applyToAllUnaryMethods(unaryMethodSettingsBuilders, settingsUpdater);
super.applyToAllUnaryMethods(
getStubSettingsBuilder().unaryMethodSettingsBuilders(), settingsUpdater);
return this;
}

/** Returns the builder for the settings used for calls to getOperation. */
public UnaryCallSettings.Builder<GetOperationRequest, Operation> getOperationSettings() {
return getOperationSettings;
return getStubSettingsBuilder().getOperationSettings();
}

/** Returns the builder for the settings used for calls to listOperations. */
public PagedCallSettings.Builder<
ListOperationsRequest, ListOperationsResponse, ListOperationsPagedResponse>
listOperationsSettings() {
return listOperationsSettings;
return getStubSettingsBuilder().listOperationsSettings();
}

/** Returns the builder for the settings used for calls to cancelOperation. */
public UnaryCallSettings.Builder<CancelOperationRequest, Empty> cancelOperationSettings() {
return cancelOperationSettings;
return getStubSettingsBuilder().cancelOperationSettings();
}

/** Returns the builder for the settings used for calls to deleteOperation. */
public UnaryCallSettings.Builder<DeleteOperationRequest, Empty> deleteOperationSettings() {
return deleteOperationSettings;
return getStubSettingsBuilder().deleteOperationSettings();
}

@Override
Expand Down
10 changes: 5 additions & 5 deletions gax-grpc/src/main/java/com/google/longrunning/stub/GrpcOperationsStub.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2017, Google LLC All rights reserved.
* Copyright 2018, Google LLC All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
Expand Down Expand Up @@ -44,7 +44,6 @@
import com.google.longrunning.ListOperationsRequest;
import com.google.longrunning.ListOperationsResponse;
import com.google.longrunning.Operation;
import com.google.longrunning.OperationsSettings;
import com.google.protobuf.Empty;
import io.grpc.MethodDescriptor;
import io.grpc.protobuf.ProtoUtils;
Expand Down Expand Up @@ -108,20 +107,21 @@ public class GrpcOperationsStub extends OperationsStub {
private final UnaryCallable<CancelOperationRequest, Empty> cancelOperationCallable;
private final UnaryCallable<DeleteOperationRequest, Empty> deleteOperationCallable;

public static final GrpcOperationsStub create(OperationsSettings settings) throws IOException {
public static final GrpcOperationsStub create(OperationsStubSettings settings)
throws IOException {
return new GrpcOperationsStub(settings, ClientContext.create(settings));
}

public static final GrpcOperationsStub create(ClientContext clientContext) throws IOException {
return new GrpcOperationsStub(OperationsSettings.newBuilder().build(), clientContext);
return new GrpcOperationsStub(OperationsStubSettings.newBuilder().build(), clientContext);
}

/**
* Constructs an instance of GrpcOperationsStub, 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 GrpcOperationsStub(OperationsSettings settings, ClientContext clientContext)
protected GrpcOperationsStub(OperationsStubSettings settings, ClientContext clientContext)
throws IOException {

GrpcCallSettings<GetOperationRequest, Operation> getOperationTransportSettings =
Expand Down
Loading