Class RegistryGrpc.RegistryFutureStub (0.12.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

Methods

build(Channel channel, CallOptions callOptions)

protected RegistryGrpc.RegistryFutureStub build(Channel channel, CallOptions callOptions)
Parameters
NameDescription
channelio.grpc.Channel
callOptionsio.grpc.CallOptions
Returns
TypeDescription
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
NameDescription
requestCreateApiRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Api>

createApiDeployment(CreateApiDeploymentRequest request)

public ListenableFuture<ApiDeployment> createApiDeployment(CreateApiDeploymentRequest request)

Creates a specified deployment.

Parameter
NameDescription
requestCreateApiDeploymentRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ApiDeployment>

createApiSpec(CreateApiSpecRequest request)

public ListenableFuture<ApiSpec> createApiSpec(CreateApiSpecRequest request)

Creates a specified spec.

Parameter
NameDescription
requestCreateApiSpecRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ApiSpec>

createApiVersion(CreateApiVersionRequest request)

public ListenableFuture<ApiVersion> createApiVersion(CreateApiVersionRequest request)

Creates a specified version.

Parameter
NameDescription
requestCreateApiVersionRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ApiVersion>

createArtifact(CreateArtifactRequest request)

public ListenableFuture<Artifact> createArtifact(CreateArtifactRequest request)

Creates a specified artifact.

Parameter
NameDescription
requestCreateArtifactRequest
Returns
TypeDescription
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
NameDescription
requestDeleteApiRequest
Returns
TypeDescription
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
NameDescription
requestDeleteApiDeploymentRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteApiDeploymentRevision(DeleteApiDeploymentRevisionRequest request)

public ListenableFuture<ApiDeployment> deleteApiDeploymentRevision(DeleteApiDeploymentRevisionRequest request)

Deletes a revision of a deployment.

Parameter
NameDescription
requestDeleteApiDeploymentRevisionRequest
Returns
TypeDescription
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
NameDescription
requestDeleteApiSpecRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteApiSpecRevision(DeleteApiSpecRevisionRequest request)

public ListenableFuture<ApiSpec> deleteApiSpecRevision(DeleteApiSpecRevisionRequest request)

Deletes a revision of a spec.

Parameter
NameDescription
requestDeleteApiSpecRevisionRequest
Returns
TypeDescription
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
NameDescription
requestDeleteApiVersionRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteArtifact(DeleteArtifactRequest request)

public ListenableFuture<Empty> deleteArtifact(DeleteArtifactRequest request)

Removes a specified artifact.

Parameter
NameDescription
requestDeleteArtifactRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>

getApi(GetApiRequest request)

public ListenableFuture<Api> getApi(GetApiRequest request)

Returns a specified API.

Parameter
NameDescription
requestGetApiRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Api>

getApiDeployment(GetApiDeploymentRequest request)

public ListenableFuture<ApiDeployment> getApiDeployment(GetApiDeploymentRequest request)

Returns a specified deployment.

Parameter
NameDescription
requestGetApiDeploymentRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ApiDeployment>

getApiSpec(GetApiSpecRequest request)

public ListenableFuture<ApiSpec> getApiSpec(GetApiSpecRequest request)

Returns a specified spec.

Parameter
NameDescription
requestGetApiSpecRequest
Returns
TypeDescription
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
NameDescription
requestGetApiSpecContentsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<com.google.api.HttpBody>

getApiVersion(GetApiVersionRequest request)

public ListenableFuture<ApiVersion> getApiVersion(GetApiVersionRequest request)

Returns a specified version.

Parameter
NameDescription
requestGetApiVersionRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ApiVersion>

getArtifact(GetArtifactRequest request)

public ListenableFuture<Artifact> getArtifact(GetArtifactRequest request)

Returns a specified artifact.

Parameter
NameDescription
requestGetArtifactRequest
Returns
TypeDescription
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
NameDescription
requestGetArtifactContentsRequest
Returns
TypeDescription
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
NameDescription
requestListApiDeploymentRevisionsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListApiDeploymentRevisionsResponse>

listApiDeployments(ListApiDeploymentsRequest request)

public ListenableFuture<ListApiDeploymentsResponse> listApiDeployments(ListApiDeploymentsRequest request)

Returns matching deployments.

Parameter
NameDescription
requestListApiDeploymentsRequest
Returns
TypeDescription
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
NameDescription
requestListApiSpecRevisionsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListApiSpecRevisionsResponse>

listApiSpecs(ListApiSpecsRequest request)

public ListenableFuture<ListApiSpecsResponse> listApiSpecs(ListApiSpecsRequest request)

Returns matching specs.

Parameter
NameDescription
requestListApiSpecsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListApiSpecsResponse>

listApiVersions(ListApiVersionsRequest request)

public ListenableFuture<ListApiVersionsResponse> listApiVersions(ListApiVersionsRequest request)

Returns matching versions.

Parameter
NameDescription
requestListApiVersionsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListApiVersionsResponse>

listApis(ListApisRequest request)

public ListenableFuture<ListApisResponse> listApis(ListApisRequest request)

Returns matching APIs.

Parameter
NameDescription
requestListApisRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListApisResponse>

listArtifacts(ListArtifactsRequest request)

public ListenableFuture<ListArtifactsResponse> listArtifacts(ListArtifactsRequest request)

Returns matching artifacts.

Parameter
NameDescription
requestListArtifactsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListArtifactsResponse>

replaceArtifact(ReplaceArtifactRequest request)

public ListenableFuture<Artifact> replaceArtifact(ReplaceArtifactRequest request)

Used to replace a specified artifact.

Parameter
NameDescription
requestReplaceArtifactRequest
Returns
TypeDescription
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
NameDescription
requestRollbackApiDeploymentRequest
Returns
TypeDescription
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
NameDescription
requestRollbackApiSpecRequest
Returns
TypeDescription
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
NameDescription
requestTagApiDeploymentRevisionRequest
Returns
TypeDescription
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
NameDescription
requestTagApiSpecRevisionRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ApiSpec>

updateApi(UpdateApiRequest request)

public ListenableFuture<Api> updateApi(UpdateApiRequest request)

Used to modify a specified API.

Parameter
NameDescription
requestUpdateApiRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Api>

updateApiDeployment(UpdateApiDeploymentRequest request)

public ListenableFuture<ApiDeployment> updateApiDeployment(UpdateApiDeploymentRequest request)

Used to modify a specified deployment.

Parameter
NameDescription
requestUpdateApiDeploymentRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ApiDeployment>

updateApiSpec(UpdateApiSpecRequest request)

public ListenableFuture<ApiSpec> updateApiSpec(UpdateApiSpecRequest request)

Used to modify a specified spec.

Parameter
NameDescription
requestUpdateApiSpecRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ApiSpec>

updateApiVersion(UpdateApiVersionRequest request)

public ListenableFuture<ApiVersion> updateApiVersion(UpdateApiVersionRequest request)

Used to modify a specified version.

Parameter
NameDescription
requestUpdateApiVersionRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ApiVersion>