Interface RegistryGrpc.AsyncService (0.28.0)

public static interface RegistryGrpc.AsyncService

The Registry service allows teams to manage descriptions of APIs.

Methods

createApi(CreateApiRequest request, StreamObserver<Api> responseObserver)

public default void createApi(CreateApiRequest request, StreamObserver<Api> responseObserver)

Creates a specified API.

Parameters
NameDescription
requestCreateApiRequest
responseObserverio.grpc.stub.StreamObserver<Api>

createApiDeployment(CreateApiDeploymentRequest request, StreamObserver<ApiDeployment> responseObserver)

public default void createApiDeployment(CreateApiDeploymentRequest request, StreamObserver<ApiDeployment> responseObserver)

Creates a specified deployment.

Parameters
NameDescription
requestCreateApiDeploymentRequest
responseObserverio.grpc.stub.StreamObserver<ApiDeployment>

createApiSpec(CreateApiSpecRequest request, StreamObserver<ApiSpec> responseObserver)

public default void createApiSpec(CreateApiSpecRequest request, StreamObserver<ApiSpec> responseObserver)

Creates a specified spec.

Parameters
NameDescription
requestCreateApiSpecRequest
responseObserverio.grpc.stub.StreamObserver<ApiSpec>

createApiVersion(CreateApiVersionRequest request, StreamObserver<ApiVersion> responseObserver)

public default void createApiVersion(CreateApiVersionRequest request, StreamObserver<ApiVersion> responseObserver)

Creates a specified version.

Parameters
NameDescription
requestCreateApiVersionRequest
responseObserverio.grpc.stub.StreamObserver<ApiVersion>

createArtifact(CreateArtifactRequest request, StreamObserver<Artifact> responseObserver)

public default void createArtifact(CreateArtifactRequest request, StreamObserver<Artifact> responseObserver)

Creates a specified artifact.

Parameters
NameDescription
requestCreateArtifactRequest
responseObserverio.grpc.stub.StreamObserver<Artifact>

deleteApi(DeleteApiRequest request, StreamObserver<Empty> responseObserver)

public default void deleteApi(DeleteApiRequest request, StreamObserver<Empty> responseObserver)

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

Parameters
NameDescription
requestDeleteApiRequest
responseObserverio.grpc.stub.StreamObserver<Empty>

deleteApiDeployment(DeleteApiDeploymentRequest request, StreamObserver<Empty> responseObserver)

public default void deleteApiDeployment(DeleteApiDeploymentRequest request, StreamObserver<Empty> responseObserver)

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

Parameters
NameDescription
requestDeleteApiDeploymentRequest
responseObserverio.grpc.stub.StreamObserver<Empty>

deleteApiDeploymentRevision(DeleteApiDeploymentRevisionRequest request, StreamObserver<ApiDeployment> responseObserver)

public default void deleteApiDeploymentRevision(DeleteApiDeploymentRevisionRequest request, StreamObserver<ApiDeployment> responseObserver)

Deletes a revision of a deployment.

Parameters
NameDescription
requestDeleteApiDeploymentRevisionRequest
responseObserverio.grpc.stub.StreamObserver<ApiDeployment>

deleteApiSpec(DeleteApiSpecRequest request, StreamObserver<Empty> responseObserver)

public default void deleteApiSpec(DeleteApiSpecRequest request, StreamObserver<Empty> responseObserver)

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

Parameters
NameDescription
requestDeleteApiSpecRequest
responseObserverio.grpc.stub.StreamObserver<Empty>

deleteApiSpecRevision(DeleteApiSpecRevisionRequest request, StreamObserver<ApiSpec> responseObserver)

public default void deleteApiSpecRevision(DeleteApiSpecRevisionRequest request, StreamObserver<ApiSpec> responseObserver)

Deletes a revision of a spec.

Parameters
NameDescription
requestDeleteApiSpecRevisionRequest
responseObserverio.grpc.stub.StreamObserver<ApiSpec>

deleteApiVersion(DeleteApiVersionRequest request, StreamObserver<Empty> responseObserver)

public default void deleteApiVersion(DeleteApiVersionRequest request, StreamObserver<Empty> responseObserver)

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

Parameters
NameDescription
requestDeleteApiVersionRequest
responseObserverio.grpc.stub.StreamObserver<Empty>

deleteArtifact(DeleteArtifactRequest request, StreamObserver<Empty> responseObserver)

public default void deleteArtifact(DeleteArtifactRequest request, StreamObserver<Empty> responseObserver)

Removes a specified artifact.

Parameters
NameDescription
requestDeleteArtifactRequest
responseObserverio.grpc.stub.StreamObserver<Empty>

getApi(GetApiRequest request, StreamObserver<Api> responseObserver)

public default void getApi(GetApiRequest request, StreamObserver<Api> responseObserver)

Returns a specified API.

Parameters
NameDescription
requestGetApiRequest
responseObserverio.grpc.stub.StreamObserver<Api>

getApiDeployment(GetApiDeploymentRequest request, StreamObserver<ApiDeployment> responseObserver)

public default void getApiDeployment(GetApiDeploymentRequest request, StreamObserver<ApiDeployment> responseObserver)

Returns a specified deployment.

Parameters
NameDescription
requestGetApiDeploymentRequest
responseObserverio.grpc.stub.StreamObserver<ApiDeployment>

getApiSpec(GetApiSpecRequest request, StreamObserver<ApiSpec> responseObserver)

public default void getApiSpec(GetApiSpecRequest request, StreamObserver<ApiSpec> responseObserver)

Returns a specified spec.

Parameters
NameDescription
requestGetApiSpecRequest
responseObserverio.grpc.stub.StreamObserver<ApiSpec>

getApiSpecContents(GetApiSpecContentsRequest request, StreamObserver<HttpBody> responseObserver)

public default void getApiSpecContents(GetApiSpecContentsRequest request, StreamObserver<HttpBody> responseObserver)

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).

Parameters
NameDescription
requestGetApiSpecContentsRequest
responseObserverio.grpc.stub.StreamObserver<com.google.api.HttpBody>

getApiVersion(GetApiVersionRequest request, StreamObserver<ApiVersion> responseObserver)

public default void getApiVersion(GetApiVersionRequest request, StreamObserver<ApiVersion> responseObserver)

Returns a specified version.

Parameters
NameDescription
requestGetApiVersionRequest
responseObserverio.grpc.stub.StreamObserver<ApiVersion>

getArtifact(GetArtifactRequest request, StreamObserver<Artifact> responseObserver)

public default void getArtifact(GetArtifactRequest request, StreamObserver<Artifact> responseObserver)

Returns a specified artifact.

Parameters
NameDescription
requestGetArtifactRequest
responseObserverio.grpc.stub.StreamObserver<Artifact>

getArtifactContents(GetArtifactContentsRequest request, StreamObserver<HttpBody> responseObserver)

public default void getArtifactContents(GetArtifactContentsRequest request, StreamObserver<HttpBody> responseObserver)

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).

Parameters
NameDescription
requestGetArtifactContentsRequest
responseObserverio.grpc.stub.StreamObserver<com.google.api.HttpBody>

listApiDeploymentRevisions(ListApiDeploymentRevisionsRequest request, StreamObserver<ListApiDeploymentRevisionsResponse> responseObserver)

public default void listApiDeploymentRevisions(ListApiDeploymentRevisionsRequest request, StreamObserver<ListApiDeploymentRevisionsResponse> responseObserver)

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

Parameters
NameDescription
requestListApiDeploymentRevisionsRequest
responseObserverio.grpc.stub.StreamObserver<ListApiDeploymentRevisionsResponse>

listApiDeployments(ListApiDeploymentsRequest request, StreamObserver<ListApiDeploymentsResponse> responseObserver)

public default void listApiDeployments(ListApiDeploymentsRequest request, StreamObserver<ListApiDeploymentsResponse> responseObserver)

Returns matching deployments.

Parameters
NameDescription
requestListApiDeploymentsRequest
responseObserverio.grpc.stub.StreamObserver<ListApiDeploymentsResponse>

listApiSpecRevisions(ListApiSpecRevisionsRequest request, StreamObserver<ListApiSpecRevisionsResponse> responseObserver)

public default void listApiSpecRevisions(ListApiSpecRevisionsRequest request, StreamObserver<ListApiSpecRevisionsResponse> responseObserver)

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

Parameters
NameDescription
requestListApiSpecRevisionsRequest
responseObserverio.grpc.stub.StreamObserver<ListApiSpecRevisionsResponse>

listApiSpecs(ListApiSpecsRequest request, StreamObserver<ListApiSpecsResponse> responseObserver)

public default void listApiSpecs(ListApiSpecsRequest request, StreamObserver<ListApiSpecsResponse> responseObserver)

Returns matching specs.

Parameters
NameDescription
requestListApiSpecsRequest
responseObserverio.grpc.stub.StreamObserver<ListApiSpecsResponse>

listApiVersions(ListApiVersionsRequest request, StreamObserver<ListApiVersionsResponse> responseObserver)

public default void listApiVersions(ListApiVersionsRequest request, StreamObserver<ListApiVersionsResponse> responseObserver)

Returns matching versions.

Parameters
NameDescription
requestListApiVersionsRequest
responseObserverio.grpc.stub.StreamObserver<ListApiVersionsResponse>

listApis(ListApisRequest request, StreamObserver<ListApisResponse> responseObserver)

public default void listApis(ListApisRequest request, StreamObserver<ListApisResponse> responseObserver)

Returns matching APIs.

Parameters
NameDescription
requestListApisRequest
responseObserverio.grpc.stub.StreamObserver<ListApisResponse>

listArtifacts(ListArtifactsRequest request, StreamObserver<ListArtifactsResponse> responseObserver)

public default void listArtifacts(ListArtifactsRequest request, StreamObserver<ListArtifactsResponse> responseObserver)

Returns matching artifacts.

Parameters
NameDescription
requestListArtifactsRequest
responseObserverio.grpc.stub.StreamObserver<ListArtifactsResponse>

replaceArtifact(ReplaceArtifactRequest request, StreamObserver<Artifact> responseObserver)

public default void replaceArtifact(ReplaceArtifactRequest request, StreamObserver<Artifact> responseObserver)

Used to replace a specified artifact.

Parameters
NameDescription
requestReplaceArtifactRequest
responseObserverio.grpc.stub.StreamObserver<Artifact>

rollbackApiDeployment(RollbackApiDeploymentRequest request, StreamObserver<ApiDeployment> responseObserver)

public default void rollbackApiDeployment(RollbackApiDeploymentRequest request, StreamObserver<ApiDeployment> responseObserver)

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

Parameters
NameDescription
requestRollbackApiDeploymentRequest
responseObserverio.grpc.stub.StreamObserver<ApiDeployment>

rollbackApiSpec(RollbackApiSpecRequest request, StreamObserver<ApiSpec> responseObserver)

public default void rollbackApiSpec(RollbackApiSpecRequest request, StreamObserver<ApiSpec> responseObserver)

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

Parameters
NameDescription
requestRollbackApiSpecRequest
responseObserverio.grpc.stub.StreamObserver<ApiSpec>

tagApiDeploymentRevision(TagApiDeploymentRevisionRequest request, StreamObserver<ApiDeployment> responseObserver)

public default void tagApiDeploymentRevision(TagApiDeploymentRevisionRequest request, StreamObserver<ApiDeployment> responseObserver)

Adds a tag to a specified revision of a deployment.

Parameters
NameDescription
requestTagApiDeploymentRevisionRequest
responseObserverio.grpc.stub.StreamObserver<ApiDeployment>

tagApiSpecRevision(TagApiSpecRevisionRequest request, StreamObserver<ApiSpec> responseObserver)

public default void tagApiSpecRevision(TagApiSpecRevisionRequest request, StreamObserver<ApiSpec> responseObserver)

Adds a tag to a specified revision of a spec.

Parameters
NameDescription
requestTagApiSpecRevisionRequest
responseObserverio.grpc.stub.StreamObserver<ApiSpec>

updateApi(UpdateApiRequest request, StreamObserver<Api> responseObserver)

public default void updateApi(UpdateApiRequest request, StreamObserver<Api> responseObserver)

Used to modify a specified API.

Parameters
NameDescription
requestUpdateApiRequest
responseObserverio.grpc.stub.StreamObserver<Api>

updateApiDeployment(UpdateApiDeploymentRequest request, StreamObserver<ApiDeployment> responseObserver)

public default void updateApiDeployment(UpdateApiDeploymentRequest request, StreamObserver<ApiDeployment> responseObserver)

Used to modify a specified deployment.

Parameters
NameDescription
requestUpdateApiDeploymentRequest
responseObserverio.grpc.stub.StreamObserver<ApiDeployment>

updateApiSpec(UpdateApiSpecRequest request, StreamObserver<ApiSpec> responseObserver)

public default void updateApiSpec(UpdateApiSpecRequest request, StreamObserver<ApiSpec> responseObserver)

Used to modify a specified spec.

Parameters
NameDescription
requestUpdateApiSpecRequest
responseObserverio.grpc.stub.StreamObserver<ApiSpec>

updateApiVersion(UpdateApiVersionRequest request, StreamObserver<ApiVersion> responseObserver)

public default void updateApiVersion(UpdateApiVersionRequest request, StreamObserver<ApiVersion> responseObserver)

Used to modify a specified version.

Parameters
NameDescription
requestUpdateApiVersionRequest
responseObserverio.grpc.stub.StreamObserver<ApiVersion>