Class ApiOperation.Builder (0.1.0)

public static final class ApiOperation.Builder extends GeneratedMessageV3.Builder<ApiOperation.Builder> 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.

Protobuf type google.cloud.apihub.v1.ApiOperation

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ApiOperation.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ApiOperation.Builder
Overrides

build()

public ApiOperation build()
Returns
Type Description
ApiOperation

buildPartial()

public ApiOperation buildPartial()
Returns
Type Description
ApiOperation

clear()

public ApiOperation.Builder clear()
Returns
Type Description
ApiOperation.Builder
Overrides

clearAttributes()

public ApiOperation.Builder clearAttributes()
Returns
Type Description
ApiOperation.Builder

clearCreateTime()

public ApiOperation.Builder clearCreateTime()

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
ApiOperation.Builder

clearDetails()

public ApiOperation.Builder clearDetails()

Output only. Operation details.

.google.cloud.apihub.v1.OperationDetails details = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ApiOperation.Builder

clearField(Descriptors.FieldDescriptor field)

public ApiOperation.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ApiOperation.Builder
Overrides

clearName()

public ApiOperation.Builder clearName()

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
ApiOperation.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ApiOperation.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ApiOperation.Builder
Overrides

clearSpec()

public ApiOperation.Builder clearSpec()

Output only. The name of the spec from where the operation was parsed. Format is projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}

string spec = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ApiOperation.Builder

This builder for chaining.

clearUpdateTime()

public ApiOperation.Builder clearUpdateTime()

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
ApiOperation.Builder

clone()

public ApiOperation.Builder clone()
Returns
Type Description
ApiOperation.Builder
Overrides

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
Returns
Type Description
boolean

getAttributes() (deprecated)

public Map<String,AttributeValues> getAttributes()

Use #getAttributesMap() instead.

Returns
Type Description
Map<String,AttributeValues>

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];

Returns
Type Description
Map<String,AttributeValues>

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];

Parameters
Name Description
key String
defaultValue AttributeValues
Returns
Type Description
AttributeValues

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
Returns
Type Description
AttributeValues

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.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

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
Builder

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];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public ApiOperation getDefaultInstanceForType()
Returns
Type Description
ApiOperation

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDetails()

public OperationDetails getDetails()

Output only. Operation details.

.google.cloud.apihub.v1.OperationDetails details = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
OperationDetails

The details.

getDetailsBuilder()

public OperationDetails.Builder getDetailsBuilder()

Output only. Operation details.

.google.cloud.apihub.v1.OperationDetails details = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
OperationDetails.Builder

getDetailsOrBuilder()

public OperationDetailsOrBuilder getDetailsOrBuilder()

Output only. Operation details.

.google.cloud.apihub.v1.OperationDetails details = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
OperationDetailsOrBuilder

getMutableAttributes() (deprecated)

public Map<String,AttributeValues> getMutableAttributes()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,AttributeValues>

getName()

public String 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.

getSpec()

public String getSpec()

Output only. The name of the spec from where the operation was parsed. Format is projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}

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 from where the operation was parsed. Format is projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}

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.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

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
Builder

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];

Returns
Type Description
TimestampOrBuilder

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()

Output only. Operation details.

.google.cloud.apihub.v1.OperationDetails details = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
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.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public ApiOperation.Builder mergeCreateTime(Timestamp value)

Output only. The time at which the operation was created.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
ApiOperation.Builder

mergeDetails(OperationDetails value)

public ApiOperation.Builder mergeDetails(OperationDetails value)

Output only. Operation details.

.google.cloud.apihub.v1.OperationDetails details = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value OperationDetails
Returns
Type Description
ApiOperation.Builder

mergeFrom(ApiOperation other)

public ApiOperation.Builder mergeFrom(ApiOperation other)
Parameter
Name Description
other ApiOperation
Returns
Type Description
ApiOperation.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ApiOperation.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ApiOperation.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ApiOperation.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ApiOperation.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ApiOperation.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ApiOperation.Builder
Overrides

mergeUpdateTime(Timestamp value)

public ApiOperation.Builder mergeUpdateTime(Timestamp value)

Output only. The time at which the operation was last updated.

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
ApiOperation.Builder

putAllAttributes(Map<String,AttributeValues> values)

public ApiOperation.Builder putAllAttributes(Map<String,AttributeValues> values)

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
values Map<String,AttributeValues>
Returns
Type Description
ApiOperation.Builder

putAttributes(String key, AttributeValues value)

public ApiOperation.Builder putAttributes(String key, AttributeValues value)

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];

Parameters
Name Description
key String
value AttributeValues
Returns
Type Description
ApiOperation.Builder

putAttributesBuilderIfAbsent(String key)

public AttributeValues.Builder putAttributesBuilderIfAbsent(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
Returns
Type Description
AttributeValues.Builder

removeAttributes(String key)

public ApiOperation.Builder removeAttributes(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
Returns
Type Description
ApiOperation.Builder

setCreateTime(Timestamp value)

public ApiOperation.Builder setCreateTime(Timestamp value)

Output only. The time at which the operation was created.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
ApiOperation.Builder

setCreateTime(Timestamp.Builder builderForValue)

public ApiOperation.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. The time at which the operation was created.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ApiOperation.Builder

setDetails(OperationDetails value)

public ApiOperation.Builder setDetails(OperationDetails value)

Output only. Operation details.

.google.cloud.apihub.v1.OperationDetails details = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value OperationDetails
Returns
Type Description
ApiOperation.Builder

setDetails(OperationDetails.Builder builderForValue)

public ApiOperation.Builder setDetails(OperationDetails.Builder builderForValue)

Output only. Operation details.

.google.cloud.apihub.v1.OperationDetails details = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue OperationDetails.Builder
Returns
Type Description
ApiOperation.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ApiOperation.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ApiOperation.Builder
Overrides

setName(String value)

public ApiOperation.Builder setName(String value)

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];

Parameter
Name Description
value String

The name to set.

Returns
Type Description
ApiOperation.Builder

This builder for chaining.

setNameBytes(ByteString value)

public ApiOperation.Builder setNameBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
ApiOperation.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ApiOperation.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ApiOperation.Builder
Overrides

setSpec(String value)

public ApiOperation.Builder setSpec(String value)

Output only. The name of the spec from where the operation was parsed. Format is projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}

string spec = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The spec to set.

Returns
Type Description
ApiOperation.Builder

This builder for chaining.

setSpecBytes(ByteString value)

public ApiOperation.Builder setSpecBytes(ByteString value)

Output only. The name of the spec from where the operation was parsed. Format is projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}

string spec = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for spec to set.

Returns
Type Description
ApiOperation.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ApiOperation.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ApiOperation.Builder
Overrides

setUpdateTime(Timestamp value)

public ApiOperation.Builder setUpdateTime(Timestamp value)

Output only. The time at which the operation was last updated.

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
ApiOperation.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public ApiOperation.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. The time at which the operation was last updated.

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ApiOperation.Builder