Interface ApiOperationOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ApiOperation, ApiOperation.Builder

@Generated public interface ApiOperationOrBuilder extends com.google.protobuf.MessageOrBuilder
  • Method Details

    • getName

      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:
      The name.
    • getNameBytes

      com.google.protobuf.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:
      The bytes for name.
    • getSpec

      String 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][google.cloud.apihub.v1.ApiHub.CreateApiOperation] API.
       
      string spec = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Returns:
      The spec.
    • getSpecBytes

      com.google.protobuf.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][google.cloud.apihub.v1.ApiHub.CreateApiOperation] API.
       
      string spec = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for spec.
    • hasDetails

      boolean hasDetails()
       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.
       
      .google.cloud.apihub.v1.OperationDetails details = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the details field is set.
    • getDetails

      OperationDetails getDetails()
       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.
       
      .google.cloud.apihub.v1.OperationDetails details = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The details.
    • getDetailsOrBuilder

      OperationDetailsOrBuilder getDetailsOrBuilder()
       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.
       
      .google.cloud.apihub.v1.OperationDetails details = 3 [(.google.api.field_behavior) = OPTIONAL];
    • hasCreateTime

      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:
      Whether the createTime field is set.
    • getCreateTime

      com.google.protobuf.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:
      The createTime.
    • getCreateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. The time at which the operation was created.
       
      .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • hasUpdateTime

      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:
      Whether the updateTime field is set.
    • getUpdateTime

      com.google.protobuf.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:
      The updateTime.
    • getUpdateTimeOrBuilder

      com.google.protobuf.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];
    • getAttributesCount

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

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

      Deprecated.
      Use getAttributesMap() instead.
    • getAttributesMap

      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

      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

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

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

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

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

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

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