public sealed class RegistryClientImpl : RegistryClientReference documentation and code samples for the Apigee Registry v1 API class RegistryClientImpl.
Registry client wrapper implementation, for convenient use.
Namespace
Google.Cloud.ApigeeRegistry.V1Assembly
Google.Cloud.ApigeeRegistry.V1.dll
Remarks
The Registry service allows teams to manage descriptions of APIs.
Constructors
RegistryClientImpl(RegistryClient, RegistrySettings, ILogger)
public RegistryClientImpl(Registry.RegistryClient grpcClient, RegistrySettings settings, ILogger logger)Constructs a client wrapper for the Registry service, with the specified gRPC client and settings.
| Parameters | |
|---|---|
| Name | Description |
grpcClient |
RegistryRegistryClientThe underlying gRPC client. |
settings |
RegistrySettingsThe base RegistrySettings used within this client. |
logger |
ILoggerOptional ILogger to use within this client. |
Properties
GrpcClient
public override Registry.RegistryClient GrpcClient { get; }The underlying gRPC Registry client
| Property Value | |
|---|---|
| Type | Description |
RegistryRegistryClient |
|
IAMPolicyClient
public override IAMPolicyClient IAMPolicyClient { get; }The IAMPolicyClient associated with this client.
| Property Value | |
|---|---|
| Type | Description |
IAMPolicyClient |
|
LocationsClient
public override LocationsClient LocationsClient { get; }The LocationsClient associated with this client.
| Property Value | |
|---|---|
| Type | Description |
LocationsClient |
|
Methods
CreateApi(CreateApiRequest, CallSettings)
public override Api CreateApi(CreateApiRequest request, CallSettings callSettings = null)Creates a specified API.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateApiRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Api |
The RPC response. |
CreateApiAsync(CreateApiRequest, CallSettings)
public override Task<Api> CreateApiAsync(CreateApiRequest request, CallSettings callSettings = null)Creates a specified API.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateApiRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskApi |
A Task containing the RPC response. |
CreateApiDeployment(CreateApiDeploymentRequest, CallSettings)
public override ApiDeployment CreateApiDeployment(CreateApiDeploymentRequest request, CallSettings callSettings = null)Creates a specified deployment.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateApiDeploymentRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
ApiDeployment |
The RPC response. |
CreateApiDeploymentAsync(CreateApiDeploymentRequest, CallSettings)
public override Task<ApiDeployment> CreateApiDeploymentAsync(CreateApiDeploymentRequest request, CallSettings callSettings = null)Creates a specified deployment.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateApiDeploymentRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskApiDeployment |
A Task containing the RPC response. |
CreateApiSpec(CreateApiSpecRequest, CallSettings)
public override ApiSpec CreateApiSpec(CreateApiSpecRequest request, CallSettings callSettings = null)Creates a specified spec.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateApiSpecRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
ApiSpec |
The RPC response. |
CreateApiSpecAsync(CreateApiSpecRequest, CallSettings)
public override Task<ApiSpec> CreateApiSpecAsync(CreateApiSpecRequest request, CallSettings callSettings = null)Creates a specified spec.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateApiSpecRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskApiSpec |
A Task containing the RPC response. |
CreateApiVersion(CreateApiVersionRequest, CallSettings)
public override ApiVersion CreateApiVersion(CreateApiVersionRequest request, CallSettings callSettings = null)Creates a specified version.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateApiVersionRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
ApiVersion |
The RPC response. |
CreateApiVersionAsync(CreateApiVersionRequest, CallSettings)
public override Task<ApiVersion> CreateApiVersionAsync(CreateApiVersionRequest request, CallSettings callSettings = null)Creates a specified version.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateApiVersionRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskApiVersion |
A Task containing the RPC response. |
CreateArtifact(CreateArtifactRequest, CallSettings)
public override Artifact CreateArtifact(CreateArtifactRequest request, CallSettings callSettings = null)Creates a specified artifact.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateArtifactRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Artifact |
The RPC response. |
CreateArtifactAsync(CreateArtifactRequest, CallSettings)
public override Task<Artifact> CreateArtifactAsync(CreateArtifactRequest request, CallSettings callSettings = null)Creates a specified artifact.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateArtifactRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskArtifact |
A Task containing the RPC response. |
DeleteApi(DeleteApiRequest, CallSettings)
public override void DeleteApi(DeleteApiRequest request, CallSettings callSettings = null)Removes a specified API and all of the resources that it owns.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteApiRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
DeleteApiAsync(DeleteApiRequest, CallSettings)
public override Task DeleteApiAsync(DeleteApiRequest request, CallSettings callSettings = null)Removes a specified API and all of the resources that it owns.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteApiRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task |
A Task containing the RPC response. |
DeleteApiDeployment(DeleteApiDeploymentRequest, CallSettings)
public override void DeleteApiDeployment(DeleteApiDeploymentRequest request, CallSettings callSettings = null)Removes a specified deployment, all revisions, and all child resources (e.g., artifacts).
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteApiDeploymentRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
DeleteApiDeploymentAsync(DeleteApiDeploymentRequest, CallSettings)
public override Task DeleteApiDeploymentAsync(DeleteApiDeploymentRequest request, CallSettings callSettings = null)Removes a specified deployment, all revisions, and all child resources (e.g., artifacts).
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteApiDeploymentRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task |
A Task containing the RPC response. |
DeleteApiDeploymentRevision(DeleteApiDeploymentRevisionRequest, CallSettings)
public override ApiDeployment DeleteApiDeploymentRevision(DeleteApiDeploymentRevisionRequest request, CallSettings callSettings = null)Deletes a revision of a deployment.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteApiDeploymentRevisionRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
ApiDeployment |
The RPC response. |
DeleteApiDeploymentRevisionAsync(DeleteApiDeploymentRevisionRequest, CallSettings)
public override Task<ApiDeployment> DeleteApiDeploymentRevisionAsync(DeleteApiDeploymentRevisionRequest request, CallSettings callSettings = null)Deletes a revision of a deployment.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteApiDeploymentRevisionRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskApiDeployment |
A Task containing the RPC response. |
DeleteApiSpec(DeleteApiSpecRequest, CallSettings)
public override void DeleteApiSpec(DeleteApiSpecRequest request, CallSettings callSettings = null)Removes a specified spec, all revisions, and all child resources (e.g., artifacts).
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteApiSpecRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
DeleteApiSpecAsync(DeleteApiSpecRequest, CallSettings)
public override Task DeleteApiSpecAsync(DeleteApiSpecRequest request, CallSettings callSettings = null)Removes a specified spec, all revisions, and all child resources (e.g., artifacts).
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteApiSpecRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task |
A Task containing the RPC response. |
DeleteApiSpecRevision(DeleteApiSpecRevisionRequest, CallSettings)
public override ApiSpec DeleteApiSpecRevision(DeleteApiSpecRevisionRequest request, CallSettings callSettings = null)Deletes a revision of a spec.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteApiSpecRevisionRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
ApiSpec |
The RPC response. |
DeleteApiSpecRevisionAsync(DeleteApiSpecRevisionRequest, CallSettings)
public override Task<ApiSpec> DeleteApiSpecRevisionAsync(DeleteApiSpecRevisionRequest request, CallSettings callSettings = null)Deletes a revision of a spec.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteApiSpecRevisionRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskApiSpec |
A Task containing the RPC response. |
DeleteApiVersion(DeleteApiVersionRequest, CallSettings)
public override void DeleteApiVersion(DeleteApiVersionRequest request, CallSettings callSettings = null)Removes a specified version and all of the resources that it owns.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteApiVersionRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
DeleteApiVersionAsync(DeleteApiVersionRequest, CallSettings)
public override Task DeleteApiVersionAsync(DeleteApiVersionRequest request, CallSettings callSettings = null)Removes a specified version and all of the resources that it owns.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteApiVersionRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task |
A Task containing the RPC response. |
DeleteArtifact(DeleteArtifactRequest, CallSettings)
public override void DeleteArtifact(DeleteArtifactRequest request, CallSettings callSettings = null)Removes a specified artifact.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteArtifactRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
DeleteArtifactAsync(DeleteArtifactRequest, CallSettings)
public override Task DeleteArtifactAsync(DeleteArtifactRequest request, CallSettings callSettings = null)Removes a specified artifact.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteArtifactRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task |
A Task containing the RPC response. |
GetApi(GetApiRequest, CallSettings)
public override Api GetApi(GetApiRequest request, CallSettings callSettings = null)Returns a specified API.
| Parameters | |
|---|---|
| Name | Description |
request |
GetApiRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Api |
The RPC response. |
GetApiAsync(GetApiRequest, CallSettings)
public override Task<Api> GetApiAsync(GetApiRequest request, CallSettings callSettings = null)Returns a specified API.
| Parameters | |
|---|---|
| Name | Description |
request |
GetApiRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskApi |
A Task containing the RPC response. |
GetApiDeployment(GetApiDeploymentRequest, CallSettings)
public override ApiDeployment GetApiDeployment(GetApiDeploymentRequest request, CallSettings callSettings = null)Returns a specified deployment.
| Parameters | |
|---|---|
| Name | Description |
request |
GetApiDeploymentRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
ApiDeployment |
The RPC response. |
GetApiDeploymentAsync(GetApiDeploymentRequest, CallSettings)
public override Task<ApiDeployment> GetApiDeploymentAsync(GetApiDeploymentRequest request, CallSettings callSettings = null)Returns a specified deployment.
| Parameters | |
|---|---|
| Name | Description |
request |
GetApiDeploymentRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskApiDeployment |
A Task containing the RPC response. |
GetApiSpec(GetApiSpecRequest, CallSettings)
public override ApiSpec GetApiSpec(GetApiSpecRequest request, CallSettings callSettings = null)Returns a specified spec.
| Parameters | |
|---|---|
| Name | Description |
request |
GetApiSpecRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
ApiSpec |
The RPC response. |
GetApiSpecAsync(GetApiSpecRequest, CallSettings)
public override Task<ApiSpec> GetApiSpecAsync(GetApiSpecRequest request, CallSettings callSettings = null)Returns a specified spec.
| Parameters | |
|---|---|
| Name | Description |
request |
GetApiSpecRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskApiSpec |
A Task containing the RPC response. |
GetApiSpecContents(GetApiSpecContentsRequest, CallSettings)
public override HttpBody GetApiSpecContents(GetApiSpecContentsRequest request, CallSettings callSettings = null)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 |
GetApiSpecContentsRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
HttpBody |
The RPC response. |
GetApiSpecContentsAsync(GetApiSpecContentsRequest, CallSettings)
public override Task<HttpBody> GetApiSpecContentsAsync(GetApiSpecContentsRequest request, CallSettings callSettings = null)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 |
GetApiSpecContentsRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskHttpBody |
A Task containing the RPC response. |
GetApiVersion(GetApiVersionRequest, CallSettings)
public override ApiVersion GetApiVersion(GetApiVersionRequest request, CallSettings callSettings = null)Returns a specified version.
| Parameters | |
|---|---|
| Name | Description |
request |
GetApiVersionRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
ApiVersion |
The RPC response. |
GetApiVersionAsync(GetApiVersionRequest, CallSettings)
public override Task<ApiVersion> GetApiVersionAsync(GetApiVersionRequest request, CallSettings callSettings = null)Returns a specified version.
| Parameters | |
|---|---|
| Name | Description |
request |
GetApiVersionRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskApiVersion |
A Task containing the RPC response. |
GetArtifact(GetArtifactRequest, CallSettings)
public override Artifact GetArtifact(GetArtifactRequest request, CallSettings callSettings = null)Returns a specified artifact.
| Parameters | |
|---|---|
| Name | Description |
request |
GetArtifactRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Artifact |
The RPC response. |
GetArtifactAsync(GetArtifactRequest, CallSettings)
public override Task<Artifact> GetArtifactAsync(GetArtifactRequest request, CallSettings callSettings = null)Returns a specified artifact.
| Parameters | |
|---|---|
| Name | Description |
request |
GetArtifactRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskArtifact |
A Task containing the RPC response. |
GetArtifactContents(GetArtifactContentsRequest, CallSettings)
public override HttpBody GetArtifactContents(GetArtifactContentsRequest request, CallSettings callSettings = null)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 |
GetArtifactContentsRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
HttpBody |
The RPC response. |
GetArtifactContentsAsync(GetArtifactContentsRequest, CallSettings)
public override Task<HttpBody> GetArtifactContentsAsync(GetArtifactContentsRequest request, CallSettings callSettings = null)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 |
GetArtifactContentsRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskHttpBody |
A Task containing the RPC response. |
ListApiDeploymentRevisions(ListApiDeploymentRevisionsRequest, CallSettings)
public override PagedEnumerable<ListApiDeploymentRevisionsResponse, ApiDeployment> ListApiDeploymentRevisions(ListApiDeploymentRevisionsRequest request, CallSettings callSettings = null)Lists all revisions of a deployment. Revisions are returned in descending order of revision creation time.
| Parameters | |
|---|---|
| Name | Description |
request |
ListApiDeploymentRevisionsRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListApiDeploymentRevisionsResponseApiDeployment |
A pageable sequence of ApiDeployment resources. |
ListApiDeploymentRevisionsAsync(ListApiDeploymentRevisionsRequest, CallSettings)
public override PagedAsyncEnumerable<ListApiDeploymentRevisionsResponse, ApiDeployment> ListApiDeploymentRevisionsAsync(ListApiDeploymentRevisionsRequest request, CallSettings callSettings = null)Lists all revisions of a deployment. Revisions are returned in descending order of revision creation time.
| Parameters | |
|---|---|
| Name | Description |
request |
ListApiDeploymentRevisionsRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListApiDeploymentRevisionsResponseApiDeployment |
A pageable asynchronous sequence of ApiDeployment resources. |
ListApiDeployments(ListApiDeploymentsRequest, CallSettings)
public override PagedEnumerable<ListApiDeploymentsResponse, ApiDeployment> ListApiDeployments(ListApiDeploymentsRequest request, CallSettings callSettings = null)Returns matching deployments.
| Parameters | |
|---|---|
| Name | Description |
request |
ListApiDeploymentsRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListApiDeploymentsResponseApiDeployment |
A pageable sequence of ApiDeployment resources. |
ListApiDeploymentsAsync(ListApiDeploymentsRequest, CallSettings)
public override PagedAsyncEnumerable<ListApiDeploymentsResponse, ApiDeployment> ListApiDeploymentsAsync(ListApiDeploymentsRequest request, CallSettings callSettings = null)Returns matching deployments.
| Parameters | |
|---|---|
| Name | Description |
request |
ListApiDeploymentsRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListApiDeploymentsResponseApiDeployment |
A pageable asynchronous sequence of ApiDeployment resources. |
ListApiSpecRevisions(ListApiSpecRevisionsRequest, CallSettings)
public override PagedEnumerable<ListApiSpecRevisionsResponse, ApiSpec> ListApiSpecRevisions(ListApiSpecRevisionsRequest request, CallSettings callSettings = null)Lists all revisions of a spec. Revisions are returned in descending order of revision creation time.
| Parameters | |
|---|---|
| Name | Description |
request |
ListApiSpecRevisionsRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListApiSpecRevisionsResponseApiSpec |
A pageable sequence of ApiSpec resources. |
ListApiSpecRevisionsAsync(ListApiSpecRevisionsRequest, CallSettings)
public override PagedAsyncEnumerable<ListApiSpecRevisionsResponse, ApiSpec> ListApiSpecRevisionsAsync(ListApiSpecRevisionsRequest request, CallSettings callSettings = null)Lists all revisions of a spec. Revisions are returned in descending order of revision creation time.
| Parameters | |
|---|---|
| Name | Description |
request |
ListApiSpecRevisionsRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListApiSpecRevisionsResponseApiSpec |
A pageable asynchronous sequence of ApiSpec resources. |
ListApiSpecs(ListApiSpecsRequest, CallSettings)
public override PagedEnumerable<ListApiSpecsResponse, ApiSpec> ListApiSpecs(ListApiSpecsRequest request, CallSettings callSettings = null)Returns matching specs.
| Parameters | |
|---|---|
| Name | Description |
request |
ListApiSpecsRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListApiSpecsResponseApiSpec |
A pageable sequence of ApiSpec resources. |
ListApiSpecsAsync(ListApiSpecsRequest, CallSettings)
public override PagedAsyncEnumerable<ListApiSpecsResponse, ApiSpec> ListApiSpecsAsync(ListApiSpecsRequest request, CallSettings callSettings = null)Returns matching specs.
| Parameters | |
|---|---|
| Name | Description |
request |
ListApiSpecsRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListApiSpecsResponseApiSpec |
A pageable asynchronous sequence of ApiSpec resources. |
ListApiVersions(ListApiVersionsRequest, CallSettings)
public override PagedEnumerable<ListApiVersionsResponse, ApiVersion> ListApiVersions(ListApiVersionsRequest request, CallSettings callSettings = null)Returns matching versions.
| Parameters | |
|---|---|
| Name | Description |
request |
ListApiVersionsRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListApiVersionsResponseApiVersion |
A pageable sequence of ApiVersion resources. |
ListApiVersionsAsync(ListApiVersionsRequest, CallSettings)
public override PagedAsyncEnumerable<ListApiVersionsResponse, ApiVersion> ListApiVersionsAsync(ListApiVersionsRequest request, CallSettings callSettings = null)Returns matching versions.
| Parameters | |
|---|---|
| Name | Description |
request |
ListApiVersionsRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListApiVersionsResponseApiVersion |
A pageable asynchronous sequence of ApiVersion resources. |
ListApis(ListApisRequest, CallSettings)
public override PagedEnumerable<ListApisResponse, Api> ListApis(ListApisRequest request, CallSettings callSettings = null)Returns matching APIs.
| Parameters | |
|---|---|
| Name | Description |
request |
ListApisRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListApisResponseApi |
A pageable sequence of Api resources. |
ListApisAsync(ListApisRequest, CallSettings)
public override PagedAsyncEnumerable<ListApisResponse, Api> ListApisAsync(ListApisRequest request, CallSettings callSettings = null)Returns matching APIs.
| Parameters | |
|---|---|
| Name | Description |
request |
ListApisRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListApisResponseApi |
A pageable asynchronous sequence of Api resources. |
ListArtifacts(ListArtifactsRequest, CallSettings)
public override PagedEnumerable<ListArtifactsResponse, Artifact> ListArtifacts(ListArtifactsRequest request, CallSettings callSettings = null)Returns matching artifacts.
| Parameters | |
|---|---|
| Name | Description |
request |
ListArtifactsRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListArtifactsResponseArtifact |
A pageable sequence of Artifact resources. |
ListArtifactsAsync(ListArtifactsRequest, CallSettings)
public override PagedAsyncEnumerable<ListArtifactsResponse, Artifact> ListArtifactsAsync(ListArtifactsRequest request, CallSettings callSettings = null)Returns matching artifacts.
| Parameters | |
|---|---|
| Name | Description |
request |
ListArtifactsRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListArtifactsResponseArtifact |
A pageable asynchronous sequence of Artifact resources. |
ReplaceArtifact(ReplaceArtifactRequest, CallSettings)
public override Artifact ReplaceArtifact(ReplaceArtifactRequest request, CallSettings callSettings = null)Used to replace a specified artifact.
| Parameters | |
|---|---|
| Name | Description |
request |
ReplaceArtifactRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Artifact |
The RPC response. |
ReplaceArtifactAsync(ReplaceArtifactRequest, CallSettings)
public override Task<Artifact> ReplaceArtifactAsync(ReplaceArtifactRequest request, CallSettings callSettings = null)Used to replace a specified artifact.
| Parameters | |
|---|---|
| Name | Description |
request |
ReplaceArtifactRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskArtifact |
A Task containing the RPC response. |
RollbackApiDeployment(RollbackApiDeploymentRequest, CallSettings)
public override ApiDeployment RollbackApiDeployment(RollbackApiDeploymentRequest request, CallSettings callSettings = null)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 |
RollbackApiDeploymentRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
ApiDeployment |
The RPC response. |
RollbackApiDeploymentAsync(RollbackApiDeploymentRequest, CallSettings)
public override Task<ApiDeployment> RollbackApiDeploymentAsync(RollbackApiDeploymentRequest request, CallSettings callSettings = null)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 |
RollbackApiDeploymentRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskApiDeployment |
A Task containing the RPC response. |
RollbackApiSpec(RollbackApiSpecRequest, CallSettings)
public override ApiSpec RollbackApiSpec(RollbackApiSpecRequest request, CallSettings callSettings = null)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 |
RollbackApiSpecRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
ApiSpec |
The RPC response. |
RollbackApiSpecAsync(RollbackApiSpecRequest, CallSettings)
public override Task<ApiSpec> RollbackApiSpecAsync(RollbackApiSpecRequest request, CallSettings callSettings = null)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 |
RollbackApiSpecRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskApiSpec |
A Task containing the RPC response. |
TagApiDeploymentRevision(TagApiDeploymentRevisionRequest, CallSettings)
public override ApiDeployment TagApiDeploymentRevision(TagApiDeploymentRevisionRequest request, CallSettings callSettings = null)Adds a tag to a specified revision of a deployment.
| Parameters | |
|---|---|
| Name | Description |
request |
TagApiDeploymentRevisionRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
ApiDeployment |
The RPC response. |
TagApiDeploymentRevisionAsync(TagApiDeploymentRevisionRequest, CallSettings)
public override Task<ApiDeployment> TagApiDeploymentRevisionAsync(TagApiDeploymentRevisionRequest request, CallSettings callSettings = null)Adds a tag to a specified revision of a deployment.
| Parameters | |
|---|---|
| Name | Description |
request |
TagApiDeploymentRevisionRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskApiDeployment |
A Task containing the RPC response. |
TagApiSpecRevision(TagApiSpecRevisionRequest, CallSettings)
public override ApiSpec TagApiSpecRevision(TagApiSpecRevisionRequest request, CallSettings callSettings = null)Adds a tag to a specified revision of a spec.
| Parameters | |
|---|---|
| Name | Description |
request |
TagApiSpecRevisionRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
ApiSpec |
The RPC response. |
TagApiSpecRevisionAsync(TagApiSpecRevisionRequest, CallSettings)
public override Task<ApiSpec> TagApiSpecRevisionAsync(TagApiSpecRevisionRequest request, CallSettings callSettings = null)Adds a tag to a specified revision of a spec.
| Parameters | |
|---|---|
| Name | Description |
request |
TagApiSpecRevisionRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskApiSpec |
A Task containing the RPC response. |
UpdateApi(UpdateApiRequest, CallSettings)
public override Api UpdateApi(UpdateApiRequest request, CallSettings callSettings = null)Used to modify a specified API.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateApiRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Api |
The RPC response. |
UpdateApiAsync(UpdateApiRequest, CallSettings)
public override Task<Api> UpdateApiAsync(UpdateApiRequest request, CallSettings callSettings = null)Used to modify a specified API.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateApiRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskApi |
A Task containing the RPC response. |
UpdateApiDeployment(UpdateApiDeploymentRequest, CallSettings)
public override ApiDeployment UpdateApiDeployment(UpdateApiDeploymentRequest request, CallSettings callSettings = null)Used to modify a specified deployment.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateApiDeploymentRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
ApiDeployment |
The RPC response. |
UpdateApiDeploymentAsync(UpdateApiDeploymentRequest, CallSettings)
public override Task<ApiDeployment> UpdateApiDeploymentAsync(UpdateApiDeploymentRequest request, CallSettings callSettings = null)Used to modify a specified deployment.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateApiDeploymentRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskApiDeployment |
A Task containing the RPC response. |
UpdateApiSpec(UpdateApiSpecRequest, CallSettings)
public override ApiSpec UpdateApiSpec(UpdateApiSpecRequest request, CallSettings callSettings = null)Used to modify a specified spec.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateApiSpecRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
ApiSpec |
The RPC response. |
UpdateApiSpecAsync(UpdateApiSpecRequest, CallSettings)
public override Task<ApiSpec> UpdateApiSpecAsync(UpdateApiSpecRequest request, CallSettings callSettings = null)Used to modify a specified spec.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateApiSpecRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskApiSpec |
A Task containing the RPC response. |
UpdateApiVersion(UpdateApiVersionRequest, CallSettings)
public override ApiVersion UpdateApiVersion(UpdateApiVersionRequest request, CallSettings callSettings = null)Used to modify a specified version.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateApiVersionRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
ApiVersion |
The RPC response. |
UpdateApiVersionAsync(UpdateApiVersionRequest, CallSettings)
public override Task<ApiVersion> UpdateApiVersionAsync(UpdateApiVersionRequest request, CallSettings callSettings = null)Used to modify a specified version.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateApiVersionRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskApiVersion |
A Task containing the RPC response. |