Class RegistryGrpc.RegistryFutureStub (0.9.0)

public static final class RegistryGrpc.RegistryFutureStub extends AbstractFutureStub<RegistryGrpc.RegistryFutureStub>

The Registry service allows teams to manage descriptions of APIs.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > RegistryGrpc.RegistryFutureStub

Inherited Members

io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)

io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.<T>withOption(io.grpc.CallOptions.Key<T>,T)

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.getCallOptions()

io.grpc.stub.AbstractStub.getChannel()

io.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials)

io.grpc.stub.AbstractStub.withChannel(io.grpc.Channel)

io.grpc.stub.AbstractStub.withCompression(java.lang.String)

io.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline)

io.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit)

io.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor)

io.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...)

io.grpc.stub.AbstractStub.withMaxInboundMessageSize(int)

io.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int)

io.grpc.stub.AbstractStub.withWaitForReady()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

build(Channel channel, CallOptions callOptions)

protected RegistryGrpc.RegistryFutureStub build(Channel channel, CallOptions callOptions)

Parameters

Name	Description
`channel`	`io.grpc.Channel`
`callOptions`	`io.grpc.CallOptions`

Returns

Type	Description
`RegistryGrpc.RegistryFutureStub`

Overrides

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createApi(CreateApiRequest request)

public ListenableFuture<Api> createApi(CreateApiRequest request)

Creates a specified API.

Parameter

Name	Description
`request`	`CreateApiRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<Api>`

createApiDeployment(CreateApiDeploymentRequest request)

public ListenableFuture<ApiDeployment> createApiDeployment(CreateApiDeploymentRequest request)

Creates a specified deployment.

Parameter

Name	Description
`request`	`CreateApiDeploymentRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<ApiDeployment>`

createApiSpec(CreateApiSpecRequest request)

public ListenableFuture<ApiSpec> createApiSpec(CreateApiSpecRequest request)

Creates a specified spec.

Parameter

Name	Description
`request`	`CreateApiSpecRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<ApiSpec>`

createApiVersion(CreateApiVersionRequest request)

public ListenableFuture<ApiVersion> createApiVersion(CreateApiVersionRequest request)

Creates a specified version.

Parameter

Name	Description
`request`	`CreateApiVersionRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<ApiVersion>`

createArtifact(CreateArtifactRequest request)

public ListenableFuture<Artifact> createArtifact(CreateArtifactRequest request)

Creates a specified artifact.

Parameter

Name	Description
`request`	`CreateArtifactRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<Artifact>`

deleteApi(DeleteApiRequest request)

public ListenableFuture<Empty> deleteApi(DeleteApiRequest request)

Removes a specified API and all of the resources that it owns.

Parameter

Name	Description
`request`	`DeleteApiRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<Empty>`

deleteApiDeployment(DeleteApiDeploymentRequest request)

public ListenableFuture<Empty> deleteApiDeployment(DeleteApiDeploymentRequest request)

Removes a specified deployment, all revisions, and all child resources (e.g., artifacts).

Parameter

Name	Description
`request`	`DeleteApiDeploymentRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<Empty>`

deleteApiDeploymentRevision(DeleteApiDeploymentRevisionRequest request)

public ListenableFuture<ApiDeployment> deleteApiDeploymentRevision(DeleteApiDeploymentRevisionRequest request)

Deletes a revision of a deployment.

Parameter

Name	Description
`request`	`DeleteApiDeploymentRevisionRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<ApiDeployment>`

deleteApiSpec(DeleteApiSpecRequest request)

public ListenableFuture<Empty> deleteApiSpec(DeleteApiSpecRequest request)

Removes a specified spec, all revisions, and all child resources (e.g., artifacts).

Parameter

Name	Description
`request`	`DeleteApiSpecRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<Empty>`

deleteApiSpecRevision(DeleteApiSpecRevisionRequest request)

public ListenableFuture<ApiSpec> deleteApiSpecRevision(DeleteApiSpecRevisionRequest request)

Deletes a revision of a spec.

Parameter

Name	Description
`request`	`DeleteApiSpecRevisionRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<ApiSpec>`

deleteApiVersion(DeleteApiVersionRequest request)

public ListenableFuture<Empty> deleteApiVersion(DeleteApiVersionRequest request)

Removes a specified version and all of the resources that it owns.

Parameter

Name	Description
`request`	`DeleteApiVersionRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<Empty>`

deleteArtifact(DeleteArtifactRequest request)

public ListenableFuture<Empty> deleteArtifact(DeleteArtifactRequest request)

Removes a specified artifact.

Parameter

Name	Description
`request`	`DeleteArtifactRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<Empty>`

getApi(GetApiRequest request)

public ListenableFuture<Api> getApi(GetApiRequest request)

Returns a specified API.

Parameter

Name	Description
`request`	`GetApiRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<Api>`

getApiDeployment(GetApiDeploymentRequest request)

public ListenableFuture<ApiDeployment> getApiDeployment(GetApiDeploymentRequest request)

Returns a specified deployment.

Parameter

Name	Description
`request`	`GetApiDeploymentRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<ApiDeployment>`

getApiSpec(GetApiSpecRequest request)

public ListenableFuture<ApiSpec> getApiSpec(GetApiSpecRequest request)

Returns a specified spec.

Parameter

Name	Description
`request`	`GetApiSpecRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<ApiSpec>`

getApiSpecContents(GetApiSpecContentsRequest request)

public ListenableFuture<HttpBody> getApiSpecContents(GetApiSpecContentsRequest request)

Returns the contents of a specified spec. If specs are stored with GZip compression, the default behavior is to return the spec uncompressed (the mime_type response field indicates the exact format returned).

Parameter

Name	Description
`request`	`GetApiSpecContentsRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<com.google.api.HttpBody>`

getApiVersion(GetApiVersionRequest request)

public ListenableFuture<ApiVersion> getApiVersion(GetApiVersionRequest request)

Returns a specified version.

Parameter

Name	Description
`request`	`GetApiVersionRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<ApiVersion>`

getArtifact(GetArtifactRequest request)

public ListenableFuture<Artifact> getArtifact(GetArtifactRequest request)

Returns a specified artifact.

Parameter

Name	Description
`request`	`GetArtifactRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<Artifact>`

getArtifactContents(GetArtifactContentsRequest request)

public ListenableFuture<HttpBody> getArtifactContents(GetArtifactContentsRequest request)

Returns the contents of a specified artifact. If artifacts are stored with GZip compression, the default behavior is to return the artifact uncompressed (the mime_type response field indicates the exact format returned).

Parameter

Name	Description
`request`	`GetArtifactContentsRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<com.google.api.HttpBody>`

listApiDeploymentRevisions(ListApiDeploymentRevisionsRequest request)

public ListenableFuture<ListApiDeploymentRevisionsResponse> listApiDeploymentRevisions(ListApiDeploymentRevisionsRequest request)

Lists all revisions of a deployment. Revisions are returned in descending order of revision creation time.

Parameter

Name	Description
`request`	`ListApiDeploymentRevisionsRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListApiDeploymentRevisionsResponse>`

listApiDeployments(ListApiDeploymentsRequest request)

public ListenableFuture<ListApiDeploymentsResponse> listApiDeployments(ListApiDeploymentsRequest request)

Returns matching deployments.

Parameter

Name	Description
`request`	`ListApiDeploymentsRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListApiDeploymentsResponse>`

listApiSpecRevisions(ListApiSpecRevisionsRequest request)

public ListenableFuture<ListApiSpecRevisionsResponse> listApiSpecRevisions(ListApiSpecRevisionsRequest request)

Lists all revisions of a spec. Revisions are returned in descending order of revision creation time.

Parameter

Name	Description
`request`	`ListApiSpecRevisionsRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListApiSpecRevisionsResponse>`

listApiSpecs(ListApiSpecsRequest request)

public ListenableFuture<ListApiSpecsResponse> listApiSpecs(ListApiSpecsRequest request)

Returns matching specs.

Parameter

Name	Description
`request`	`ListApiSpecsRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListApiSpecsResponse>`

listApiVersions(ListApiVersionsRequest request)

public ListenableFuture<ListApiVersionsResponse> listApiVersions(ListApiVersionsRequest request)

Returns matching versions.

Parameter

Name	Description
`request`	`ListApiVersionsRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListApiVersionsResponse>`

listApis(ListApisRequest request)

public ListenableFuture<ListApisResponse> listApis(ListApisRequest request)

Returns matching APIs.

Parameter

Name	Description
`request`	`ListApisRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListApisResponse>`

listArtifacts(ListArtifactsRequest request)

public ListenableFuture<ListArtifactsResponse> listArtifacts(ListArtifactsRequest request)

Returns matching artifacts.

Parameter

Name	Description
`request`	`ListArtifactsRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListArtifactsResponse>`

replaceArtifact(ReplaceArtifactRequest request)

public ListenableFuture<Artifact> replaceArtifact(ReplaceArtifactRequest request)

Used to replace a specified artifact.

Parameter

Name	Description
`request`	`ReplaceArtifactRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<Artifact>`

rollbackApiDeployment(RollbackApiDeploymentRequest request)

public ListenableFuture<ApiDeployment> rollbackApiDeployment(RollbackApiDeploymentRequest request)

Sets the current revision to a specified prior revision. Note that this creates a new revision with a new revision ID.

Parameter

Name	Description
`request`	`RollbackApiDeploymentRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<ApiDeployment>`

rollbackApiSpec(RollbackApiSpecRequest request)

public ListenableFuture<ApiSpec> rollbackApiSpec(RollbackApiSpecRequest request)

Sets the current revision to a specified prior revision. Note that this creates a new revision with a new revision ID.

Parameter

Name	Description
`request`	`RollbackApiSpecRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<ApiSpec>`

tagApiDeploymentRevision(TagApiDeploymentRevisionRequest request)

public ListenableFuture<ApiDeployment> tagApiDeploymentRevision(TagApiDeploymentRevisionRequest request)

Adds a tag to a specified revision of a deployment.

Parameter

Name	Description
`request`	`TagApiDeploymentRevisionRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<ApiDeployment>`

tagApiSpecRevision(TagApiSpecRevisionRequest request)

public ListenableFuture<ApiSpec> tagApiSpecRevision(TagApiSpecRevisionRequest request)

Adds a tag to a specified revision of a spec.

Parameter

Name	Description
`request`	`TagApiSpecRevisionRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<ApiSpec>`

updateApi(UpdateApiRequest request)

public ListenableFuture<Api> updateApi(UpdateApiRequest request)

Used to modify a specified API.

Parameter

Name	Description
`request`	`UpdateApiRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<Api>`

updateApiDeployment(UpdateApiDeploymentRequest request)

public ListenableFuture<ApiDeployment> updateApiDeployment(UpdateApiDeploymentRequest request)

Used to modify a specified deployment.

Parameter

Name	Description
`request`	`UpdateApiDeploymentRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<ApiDeployment>`

updateApiSpec(UpdateApiSpecRequest request)

public ListenableFuture<ApiSpec> updateApiSpec(UpdateApiSpecRequest request)

Used to modify a specified spec.

Parameter

Name	Description
`request`	`UpdateApiSpecRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<ApiSpec>`

updateApiVersion(UpdateApiVersionRequest request)

public ListenableFuture<ApiVersion> updateApiVersion(UpdateApiVersionRequest request)

Used to modify a specified version.

Parameter

Name	Description
`request`	`UpdateApiVersionRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<ApiVersion>`