[BindServiceMethod(typeof(Registry), "BindService")]
public abstract class Registry.RegistryBase
Reference documentation and code samples for the Apigee Registry v1 API class Registry.RegistryBase.
Base class for server-side implementations of Registry
Namespace
Google.Cloud.ApigeeRegistry.V1Assembly
Google.Cloud.ApigeeRegistry.V1.dll
Methods
CreateApi(CreateApiRequest, ServerCallContext)
public virtual Task<Api> CreateApi(CreateApiRequest request, ServerCallContext context)
Creates a specified API.
Parameters | |
---|---|
Name | Description |
request |
CreateApiRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskApi |
The response to send back to the client (wrapped by a task). |
CreateApiDeployment(CreateApiDeploymentRequest, ServerCallContext)
public virtual Task<ApiDeployment> CreateApiDeployment(CreateApiDeploymentRequest request, ServerCallContext context)
Creates a specified deployment.
Parameters | |
---|---|
Name | Description |
request |
CreateApiDeploymentRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskApiDeployment |
The response to send back to the client (wrapped by a task). |
CreateApiSpec(CreateApiSpecRequest, ServerCallContext)
public virtual Task<ApiSpec> CreateApiSpec(CreateApiSpecRequest request, ServerCallContext context)
Creates a specified spec.
Parameters | |
---|---|
Name | Description |
request |
CreateApiSpecRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskApiSpec |
The response to send back to the client (wrapped by a task). |
CreateApiVersion(CreateApiVersionRequest, ServerCallContext)
public virtual Task<ApiVersion> CreateApiVersion(CreateApiVersionRequest request, ServerCallContext context)
Creates a specified version.
Parameters | |
---|---|
Name | Description |
request |
CreateApiVersionRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskApiVersion |
The response to send back to the client (wrapped by a task). |
CreateArtifact(CreateArtifactRequest, ServerCallContext)
public virtual Task<Artifact> CreateArtifact(CreateArtifactRequest request, ServerCallContext context)
Creates a specified artifact.
Parameters | |
---|---|
Name | Description |
request |
CreateArtifactRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskArtifact |
The response to send back to the client (wrapped by a task). |
DeleteApi(DeleteApiRequest, ServerCallContext)
public virtual Task<Empty> DeleteApi(DeleteApiRequest request, ServerCallContext context)
Removes a specified API and all of the resources that it owns.
Parameters | |
---|---|
Name | Description |
request |
DeleteApiRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskEmpty |
The response to send back to the client (wrapped by a task). |
DeleteApiDeployment(DeleteApiDeploymentRequest, ServerCallContext)
public virtual Task<Empty> DeleteApiDeployment(DeleteApiDeploymentRequest request, ServerCallContext context)
Removes a specified deployment, all revisions, and all child resources (e.g., artifacts).
Parameters | |
---|---|
Name | Description |
request |
DeleteApiDeploymentRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskEmpty |
The response to send back to the client (wrapped by a task). |
DeleteApiDeploymentRevision(DeleteApiDeploymentRevisionRequest, ServerCallContext)
public virtual Task<ApiDeployment> DeleteApiDeploymentRevision(DeleteApiDeploymentRevisionRequest request, ServerCallContext context)
Deletes a revision of a deployment.
Parameters | |
---|---|
Name | Description |
request |
DeleteApiDeploymentRevisionRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskApiDeployment |
The response to send back to the client (wrapped by a task). |
DeleteApiSpec(DeleteApiSpecRequest, ServerCallContext)
public virtual Task<Empty> DeleteApiSpec(DeleteApiSpecRequest request, ServerCallContext context)
Removes a specified spec, all revisions, and all child resources (e.g., artifacts).
Parameters | |
---|---|
Name | Description |
request |
DeleteApiSpecRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskEmpty |
The response to send back to the client (wrapped by a task). |
DeleteApiSpecRevision(DeleteApiSpecRevisionRequest, ServerCallContext)
public virtual Task<ApiSpec> DeleteApiSpecRevision(DeleteApiSpecRevisionRequest request, ServerCallContext context)
Deletes a revision of a spec.
Parameters | |
---|---|
Name | Description |
request |
DeleteApiSpecRevisionRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskApiSpec |
The response to send back to the client (wrapped by a task). |
DeleteApiVersion(DeleteApiVersionRequest, ServerCallContext)
public virtual Task<Empty> DeleteApiVersion(DeleteApiVersionRequest request, ServerCallContext context)
Removes a specified version and all of the resources that it owns.
Parameters | |
---|---|
Name | Description |
request |
DeleteApiVersionRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskEmpty |
The response to send back to the client (wrapped by a task). |
DeleteArtifact(DeleteArtifactRequest, ServerCallContext)
public virtual Task<Empty> DeleteArtifact(DeleteArtifactRequest request, ServerCallContext context)
Removes a specified artifact.
Parameters | |
---|---|
Name | Description |
request |
DeleteArtifactRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskEmpty |
The response to send back to the client (wrapped by a task). |
GetApi(GetApiRequest, ServerCallContext)
public virtual Task<Api> GetApi(GetApiRequest request, ServerCallContext context)
Returns a specified API.
Parameters | |
---|---|
Name | Description |
request |
GetApiRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskApi |
The response to send back to the client (wrapped by a task). |
GetApiDeployment(GetApiDeploymentRequest, ServerCallContext)
public virtual Task<ApiDeployment> GetApiDeployment(GetApiDeploymentRequest request, ServerCallContext context)
Returns a specified deployment.
Parameters | |
---|---|
Name | Description |
request |
GetApiDeploymentRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskApiDeployment |
The response to send back to the client (wrapped by a task). |
GetApiSpec(GetApiSpecRequest, ServerCallContext)
public virtual Task<ApiSpec> GetApiSpec(GetApiSpecRequest request, ServerCallContext context)
Returns a specified spec.
Parameters | |
---|---|
Name | Description |
request |
GetApiSpecRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskApiSpec |
The response to send back to the client (wrapped by a task). |
GetApiSpecContents(GetApiSpecContentsRequest, ServerCallContext)
public virtual Task<HttpBody> GetApiSpecContents(GetApiSpecContentsRequest request, ServerCallContext context)
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 The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskHttpBody |
The response to send back to the client (wrapped by a task). |
GetApiVersion(GetApiVersionRequest, ServerCallContext)
public virtual Task<ApiVersion> GetApiVersion(GetApiVersionRequest request, ServerCallContext context)
Returns a specified version.
Parameters | |
---|---|
Name | Description |
request |
GetApiVersionRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskApiVersion |
The response to send back to the client (wrapped by a task). |
GetArtifact(GetArtifactRequest, ServerCallContext)
public virtual Task<Artifact> GetArtifact(GetArtifactRequest request, ServerCallContext context)
Returns a specified artifact.
Parameters | |
---|---|
Name | Description |
request |
GetArtifactRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskArtifact |
The response to send back to the client (wrapped by a task). |
GetArtifactContents(GetArtifactContentsRequest, ServerCallContext)
public virtual Task<HttpBody> GetArtifactContents(GetArtifactContentsRequest request, ServerCallContext context)
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 The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskHttpBody |
The response to send back to the client (wrapped by a task). |
ListApiDeploymentRevisions(ListApiDeploymentRevisionsRequest, ServerCallContext)
public virtual Task<ListApiDeploymentRevisionsResponse> ListApiDeploymentRevisions(ListApiDeploymentRevisionsRequest request, ServerCallContext context)
Lists all revisions of a deployment. Revisions are returned in descending order of revision creation time.
Parameters | |
---|---|
Name | Description |
request |
ListApiDeploymentRevisionsRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskListApiDeploymentRevisionsResponse |
The response to send back to the client (wrapped by a task). |
ListApiDeployments(ListApiDeploymentsRequest, ServerCallContext)
public virtual Task<ListApiDeploymentsResponse> ListApiDeployments(ListApiDeploymentsRequest request, ServerCallContext context)
Returns matching deployments.
Parameters | |
---|---|
Name | Description |
request |
ListApiDeploymentsRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskListApiDeploymentsResponse |
The response to send back to the client (wrapped by a task). |
ListApiSpecRevisions(ListApiSpecRevisionsRequest, ServerCallContext)
public virtual Task<ListApiSpecRevisionsResponse> ListApiSpecRevisions(ListApiSpecRevisionsRequest request, ServerCallContext context)
Lists all revisions of a spec. Revisions are returned in descending order of revision creation time.
Parameters | |
---|---|
Name | Description |
request |
ListApiSpecRevisionsRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskListApiSpecRevisionsResponse |
The response to send back to the client (wrapped by a task). |
ListApiSpecs(ListApiSpecsRequest, ServerCallContext)
public virtual Task<ListApiSpecsResponse> ListApiSpecs(ListApiSpecsRequest request, ServerCallContext context)
Returns matching specs.
Parameters | |
---|---|
Name | Description |
request |
ListApiSpecsRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskListApiSpecsResponse |
The response to send back to the client (wrapped by a task). |
ListApiVersions(ListApiVersionsRequest, ServerCallContext)
public virtual Task<ListApiVersionsResponse> ListApiVersions(ListApiVersionsRequest request, ServerCallContext context)
Returns matching versions.
Parameters | |
---|---|
Name | Description |
request |
ListApiVersionsRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskListApiVersionsResponse |
The response to send back to the client (wrapped by a task). |
ListApis(ListApisRequest, ServerCallContext)
public virtual Task<ListApisResponse> ListApis(ListApisRequest request, ServerCallContext context)
Returns matching APIs.
Parameters | |
---|---|
Name | Description |
request |
ListApisRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskListApisResponse |
The response to send back to the client (wrapped by a task). |
ListArtifacts(ListArtifactsRequest, ServerCallContext)
public virtual Task<ListArtifactsResponse> ListArtifacts(ListArtifactsRequest request, ServerCallContext context)
Returns matching artifacts.
Parameters | |
---|---|
Name | Description |
request |
ListArtifactsRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskListArtifactsResponse |
The response to send back to the client (wrapped by a task). |
ReplaceArtifact(ReplaceArtifactRequest, ServerCallContext)
public virtual Task<Artifact> ReplaceArtifact(ReplaceArtifactRequest request, ServerCallContext context)
Used to replace a specified artifact.
Parameters | |
---|---|
Name | Description |
request |
ReplaceArtifactRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskArtifact |
The response to send back to the client (wrapped by a task). |
RollbackApiDeployment(RollbackApiDeploymentRequest, ServerCallContext)
public virtual Task<ApiDeployment> RollbackApiDeployment(RollbackApiDeploymentRequest request, ServerCallContext context)
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 The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskApiDeployment |
The response to send back to the client (wrapped by a task). |
RollbackApiSpec(RollbackApiSpecRequest, ServerCallContext)
public virtual Task<ApiSpec> RollbackApiSpec(RollbackApiSpecRequest request, ServerCallContext context)
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 The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskApiSpec |
The response to send back to the client (wrapped by a task). |
TagApiDeploymentRevision(TagApiDeploymentRevisionRequest, ServerCallContext)
public virtual Task<ApiDeployment> TagApiDeploymentRevision(TagApiDeploymentRevisionRequest request, ServerCallContext context)
Adds a tag to a specified revision of a deployment.
Parameters | |
---|---|
Name | Description |
request |
TagApiDeploymentRevisionRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskApiDeployment |
The response to send back to the client (wrapped by a task). |
TagApiSpecRevision(TagApiSpecRevisionRequest, ServerCallContext)
public virtual Task<ApiSpec> TagApiSpecRevision(TagApiSpecRevisionRequest request, ServerCallContext context)
Adds a tag to a specified revision of a spec.
Parameters | |
---|---|
Name | Description |
request |
TagApiSpecRevisionRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskApiSpec |
The response to send back to the client (wrapped by a task). |
UpdateApi(UpdateApiRequest, ServerCallContext)
public virtual Task<Api> UpdateApi(UpdateApiRequest request, ServerCallContext context)
Used to modify a specified API.
Parameters | |
---|---|
Name | Description |
request |
UpdateApiRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskApi |
The response to send back to the client (wrapped by a task). |
UpdateApiDeployment(UpdateApiDeploymentRequest, ServerCallContext)
public virtual Task<ApiDeployment> UpdateApiDeployment(UpdateApiDeploymentRequest request, ServerCallContext context)
Used to modify a specified deployment.
Parameters | |
---|---|
Name | Description |
request |
UpdateApiDeploymentRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskApiDeployment |
The response to send back to the client (wrapped by a task). |
UpdateApiSpec(UpdateApiSpecRequest, ServerCallContext)
public virtual Task<ApiSpec> UpdateApiSpec(UpdateApiSpecRequest request, ServerCallContext context)
Used to modify a specified spec.
Parameters | |
---|---|
Name | Description |
request |
UpdateApiSpecRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskApiSpec |
The response to send back to the client (wrapped by a task). |
UpdateApiVersion(UpdateApiVersionRequest, ServerCallContext)
public virtual Task<ApiVersion> UpdateApiVersion(UpdateApiVersionRequest request, ServerCallContext context)
Used to modify a specified version.
Parameters | |
---|---|
Name | Description |
request |
UpdateApiVersionRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskApiVersion |
The response to send back to the client (wrapped by a task). |