public sealed class ApiOperation : IMessage<ApiOperation>, IEquatable<ApiOperation>, IDeepCloneable<ApiOperation>, IBufferMessage, IMessageReference documentation and code samples for the API hub v1 API class ApiOperation.
Represents an operation contained in an API version in the API Hub. An operation is added/updated/deleted in an API version when a new spec is added or an existing spec is updated/deleted in a version. Currently, an operation will be created only corresponding to OpenAPI spec as parsing is supported for OpenAPI spec. Alternatively operations can be managed via create,update and delete APIs, creation of apiOperation can be possible only for version with no parsed operations and update/delete can be possible only for operations created via create API.
Implements
IMessageApiOperation, IEquatableApiOperation, IDeepCloneableApiOperation, IBufferMessage, IMessageNamespace
Google.Cloud.ApiHub.V1Assembly
Google.Cloud.ApiHub.V1.dll
Constructors
ApiOperation()
public ApiOperation()ApiOperation(ApiOperation)
public ApiOperation(ApiOperation other)| Parameter | |
|---|---|
| Name | Description |
other |
ApiOperation |
Properties
ApiOperationName
public ApiOperationName ApiOperationName { get; set; }ApiOperationName-typed view over the Name resource name property.
| Property Value | |
|---|---|
| Type | Description |
ApiOperationName |
|
Attributes
public MapField<string, AttributeValues> Attributes { get; }Optional. The list of user defined attributes associated with the API
operation resource. The key is the attribute name. It will be of the
format: projects/{project}/locations/{location}/attributes/{attribute}.
The value is the attribute values associated with the resource.
| Property Value | |
|---|---|
| Type | Description |
MapFieldstringAttributeValues |
|
CreateTime
public Timestamp CreateTime { get; set; }Output only. The time at which the operation was created.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|
Details
public OperationDetails Details { get; set; }Optional. Operation details. Note: Even though this field is optional, it is required for [CreateApiOperation][google.cloud.apihub.v1.ApiHub.CreateApiOperation] API and we will fail the request if not provided.
| Property Value | |
|---|---|
| Type | Description |
OperationDetails |
|
Name
public string Name { get; set; }Identifier. The name of the operation.
Format:
projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}
| Property Value | |
|---|---|
| Type | Description |
string |
|
SourceMetadata
public RepeatedField<SourceMetadata> SourceMetadata { get; }Output only. The list of sources and metadata from the sources of the API operation.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldSourceMetadata |
|
Spec
public string Spec { get; set; }Output only. The name of the spec will be of the format:
projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}
Note:The name of the spec will be empty if the operation is created via
[CreateApiOperation][google.cloud.apihub.v1.ApiHub.CreateApiOperation] API.
| Property Value | |
|---|---|
| Type | Description |
string |
|
SpecAsSpecName
public SpecName SpecAsSpecName { get; set; }| Property Value | |
|---|---|
| Type | Description |
SpecName |
|
UpdateTime
public Timestamp UpdateTime { get; set; }Output only. The time at which the operation was last updated.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|