public final class ApiOperation extends GeneratedMessageV3 implements ApiOperationOrBuilder
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.
Protobuf type google.cloud.apihub.v1.ApiOperation
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
ATTRIBUTES_FIELD_NUMBER
public static final int ATTRIBUTES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DETAILS_FIELD_NUMBER
public static final int DETAILS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int SOURCE_METADATA_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SPEC_FIELD_NUMBER
public static final int SPEC_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static ApiOperation getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ApiOperation.Builder newBuilder()
newBuilder(ApiOperation prototype)
public static ApiOperation.Builder newBuilder(ApiOperation prototype)
public static ApiOperation parseDelimitedFrom(InputStream input)
public static ApiOperation parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ApiOperation parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ApiOperation parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ApiOperation parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ApiOperation parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ApiOperation parseFrom(CodedInputStream input)
public static ApiOperation parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ApiOperation parseFrom(InputStream input)
public static ApiOperation parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ApiOperation parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ApiOperation parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ApiOperation> parser()
Methods
containsAttributes(String key)
public boolean containsAttributes(String key)
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.
map<string, .google.cloud.apihub.v1.AttributeValues> attributes = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
key |
String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getAttributes() (deprecated)
public Map<String,AttributeValues> getAttributes()
getAttributesCount()
public int getAttributesCount()
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.
map<string, .google.cloud.apihub.v1.AttributeValues> attributes = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
|
getAttributesMap()
public Map<String,AttributeValues> getAttributesMap()
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.
map<string, .google.cloud.apihub.v1.AttributeValues> attributes = 6 [(.google.api.field_behavior) = OPTIONAL];
getAttributesOrDefault(String key, AttributeValues defaultValue)
public AttributeValues getAttributesOrDefault(String key, AttributeValues defaultValue)
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.
map<string, .google.cloud.apihub.v1.AttributeValues> attributes = 6 [(.google.api.field_behavior) = OPTIONAL];
getAttributesOrThrow(String key)
public AttributeValues getAttributesOrThrow(String key)
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.
map<string, .google.cloud.apihub.v1.AttributeValues> attributes = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
key |
String
|
getCreateTime()
public Timestamp getCreateTime()
Output only. The time at which the operation was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
Timestamp |
The createTime.
|
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The time at which the operation was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public ApiOperation getDefaultInstanceForType()
getDetails()
public OperationDetails getDetails()
Optional. Operation details.
Note: Even though this field is optional, it is required for
CreateApiOperation
API and we will fail the request if not provided.
.google.cloud.apihub.v1.OperationDetails details = 3 [(.google.api.field_behavior) = OPTIONAL];
getDetailsOrBuilder()
public OperationDetailsOrBuilder getDetailsOrBuilder()
Optional. Operation details.
Note: Even though this field is optional, it is required for
CreateApiOperation
API and we will fail the request if not provided.
.google.cloud.apihub.v1.OperationDetails details = 3 [(.google.api.field_behavior) = OPTIONAL];
getName()
Identifier. The name of the operation.
Format:
projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns |
| Type |
Description |
String |
The name.
|
getNameBytes()
public ByteString getNameBytes()
Identifier. The name of the operation.
Format:
projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
getParserForType()
public Parser<ApiOperation> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
public SourceMetadata getSourceMetadata(int index)
Output only. The list of sources and metadata from the sources of the API
operation.
repeated .google.cloud.apihub.v1.SourceMetadata source_metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter |
| Name |
Description |
index |
int
|
public int getSourceMetadataCount()
Output only. The list of sources and metadata from the sources of the API
operation.
repeated .google.cloud.apihub.v1.SourceMetadata source_metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
int |
|
public List<SourceMetadata> getSourceMetadataList()
Output only. The list of sources and metadata from the sources of the API
operation.
repeated .google.cloud.apihub.v1.SourceMetadata source_metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
public SourceMetadataOrBuilder getSourceMetadataOrBuilder(int index)
Output only. The list of sources and metadata from the sources of the API
operation.
repeated .google.cloud.apihub.v1.SourceMetadata source_metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter |
| Name |
Description |
index |
int
|
public List<? extends SourceMetadataOrBuilder> getSourceMetadataOrBuilderList()
Output only. The list of sources and metadata from the sources of the API
operation.
repeated .google.cloud.apihub.v1.SourceMetadata source_metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
List<? extends com.google.cloud.apihub.v1.SourceMetadataOrBuilder> |
|
getSpec()
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 API.
string spec = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
String |
The spec.
|
getSpecBytes()
public ByteString getSpecBytes()
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 API.
string spec = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for spec.
|
getUpdateTime()
public Timestamp getUpdateTime()
Output only. The time at which the operation was last updated.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
Timestamp |
The updateTime.
|
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. The time at which the operation was last updated.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCreateTime()
public boolean hasCreateTime()
Output only. The time at which the operation was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the createTime field is set.
|
hasDetails()
public boolean hasDetails()
Optional. Operation details.
Note: Even though this field is optional, it is required for
CreateApiOperation
API and we will fail the request if not provided.
.google.cloud.apihub.v1.OperationDetails details = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the details field is set.
|
hasUpdateTime()
public boolean hasUpdateTime()
Output only. The time at which the operation was last updated.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the updateTime field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ApiOperation.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ApiOperation.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public ApiOperation.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
