Interface RegistryGrpc.AsyncService (0.16.0)

Version 0.16.0

• 0.51.0 (latest)
• 0.49.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.1
• 0.2.2
• 0.1.1

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
Name	Description
request	CreateApiRequest
responseObserver	io.grpc.stub.StreamObserver<Api>

createApiDeployment(CreateApiDeploymentRequest request, StreamObserver<ApiDeployment> responseObserver)

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

Creates a specified deployment.

Parameters
Name	Description
request	CreateApiDeploymentRequest
responseObserver	io.grpc.stub.StreamObserver<ApiDeployment>

createApiSpec(CreateApiSpecRequest request, StreamObserver<ApiSpec> responseObserver)

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

Creates a specified spec.

Parameters
Name	Description
request	CreateApiSpecRequest
responseObserver	io.grpc.stub.StreamObserver<ApiSpec>

createApiVersion(CreateApiVersionRequest request, StreamObserver<ApiVersion> responseObserver)

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

Creates a specified version.

Parameters
Name	Description
request	CreateApiVersionRequest
responseObserver	io.grpc.stub.StreamObserver<ApiVersion>

createArtifact(CreateArtifactRequest request, StreamObserver<Artifact> responseObserver)

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

Creates a specified artifact.

Parameters
Name	Description
request	CreateArtifactRequest
responseObserver	io.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
Name	Description
request	DeleteApiRequest
responseObserver	io.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
Name	Description
request	DeleteApiDeploymentRequest
responseObserver	io.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
Name	Description
request	DeleteApiDeploymentRevisionRequest
responseObserver	io.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
Name	Description
request	DeleteApiSpecRequest
responseObserver	io.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
Name	Description
request	DeleteApiSpecRevisionRequest
responseObserver	io.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
Name	Description
request	DeleteApiVersionRequest
responseObserver	io.grpc.stub.StreamObserver<Empty>

deleteArtifact(DeleteArtifactRequest request, StreamObserver<Empty> responseObserver)

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

Removes a specified artifact.

Parameters
Name	Description
request	DeleteArtifactRequest
responseObserver	io.grpc.stub.StreamObserver<Empty>

getApi(GetApiRequest request, StreamObserver<Api> responseObserver)

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

Returns a specified API.

Parameters
Name	Description
request	GetApiRequest
responseObserver	io.grpc.stub.StreamObserver<Api>

getApiDeployment(GetApiDeploymentRequest request, StreamObserver<ApiDeployment> responseObserver)

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

Returns a specified deployment.

Parameters
Name	Description
request	GetApiDeploymentRequest
responseObserver	io.grpc.stub.StreamObserver<ApiDeployment>

getApiSpec(GetApiSpecRequest request, StreamObserver<ApiSpec> responseObserver)

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

Returns a specified spec.

Parameters
Name	Description
request	GetApiSpecRequest
responseObserver	io.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
Name	Description
request	GetApiSpecContentsRequest
responseObserver	io.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
Name	Description
request	GetApiVersionRequest
responseObserver	io.grpc.stub.StreamObserver<ApiVersion>

getArtifact(GetArtifactRequest request, StreamObserver<Artifact> responseObserver)

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

Returns a specified artifact.

Parameters
Name	Description
request	GetArtifactRequest
responseObserver	io.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
Name	Description
request	GetArtifactContentsRequest
responseObserver	io.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
Name	Description
request	ListApiDeploymentRevisionsRequest
responseObserver	io.grpc.stub.StreamObserver<ListApiDeploymentRevisionsResponse>

listApiDeployments(ListApiDeploymentsRequest request, StreamObserver<ListApiDeploymentsResponse> responseObserver)

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

Returns matching deployments.

Parameters
Name	Description
request	ListApiDeploymentsRequest
responseObserver	io.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
Name	Description
request	ListApiSpecRevisionsRequest
responseObserver	io.grpc.stub.StreamObserver<ListApiSpecRevisionsResponse>

listApiSpecs(ListApiSpecsRequest request, StreamObserver<ListApiSpecsResponse> responseObserver)

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

Returns matching specs.

Parameters
Name	Description
request	ListApiSpecsRequest
responseObserver	io.grpc.stub.StreamObserver<ListApiSpecsResponse>

listApiVersions(ListApiVersionsRequest request, StreamObserver<ListApiVersionsResponse> responseObserver)

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

Returns matching versions.

Parameters
Name	Description
request	ListApiVersionsRequest
responseObserver	io.grpc.stub.StreamObserver<ListApiVersionsResponse>

listApis(ListApisRequest request, StreamObserver<ListApisResponse> responseObserver)

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

Returns matching APIs.

Parameters
Name	Description
request	ListApisRequest
responseObserver	io.grpc.stub.StreamObserver<ListApisResponse>

listArtifacts(ListArtifactsRequest request, StreamObserver<ListArtifactsResponse> responseObserver)

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

Returns matching artifacts.

Parameters
Name	Description
request	ListArtifactsRequest
responseObserver	io.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
Name	Description
request	ReplaceArtifactRequest
responseObserver	io.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
Name	Description
request	RollbackApiDeploymentRequest
responseObserver	io.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
Name	Description
request	RollbackApiSpecRequest
responseObserver	io.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
Name	Description
request	TagApiDeploymentRevisionRequest
responseObserver	io.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
Name	Description
request	TagApiSpecRevisionRequest
responseObserver	io.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
Name	Description
request	UpdateApiRequest
responseObserver	io.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
Name	Description
request	UpdateApiDeploymentRequest
responseObserver	io.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
Name	Description
request	UpdateApiSpecRequest
responseObserver	io.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
Name	Description
request	UpdateApiVersionRequest
responseObserver	io.grpc.stub.StreamObserver<ApiVersion>