Interface ExternalApiOrBuilder

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

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

    • getName

      String getName()
       Identifier. Format:
       `projects/{project}/locations/{location}/externalApi/{externalApi}`.
       
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Returns:
      The name.
    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Identifier. Format:
       `projects/{project}/locations/{location}/externalApi/{externalApi}`.
       
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Returns:
      The bytes for name.
    • getDisplayName

      String getDisplayName()
       Required. Display name of the external API. Max length is 63 characters
       (Unicode Code Points).
       
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The displayName.
    • getDisplayNameBytes

      com.google.protobuf.ByteString getDisplayNameBytes()
       Required. Display name of the external API. Max length is 63 characters
       (Unicode Code Points).
       
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for displayName.
    • getDescription

      String getDescription()
       Optional. Description of the external API. Max length is 2000 characters
       (Unicode Code Points).
       
      string description = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The description.
    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       Optional. Description of the external API. Max length is 2000 characters
       (Unicode Code Points).
       
      string description = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for description.
    • getEndpointsList

      List<String> getEndpointsList()
       Optional. List of endpoints on which this API is accessible.
       
      repeated string endpoints = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      A list containing the endpoints.
    • getEndpointsCount

      int getEndpointsCount()
       Optional. List of endpoints on which this API is accessible.
       
      repeated string endpoints = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The count of endpoints.
    • getEndpoints

      String getEndpoints(int index)
       Optional. List of endpoints on which this API is accessible.
       
      repeated string endpoints = 4 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      index - The index of the element to return.
      Returns:
      The endpoints at the given index.
    • getEndpointsBytes

      com.google.protobuf.ByteString getEndpointsBytes(int index)
       Optional. List of endpoints on which this API is accessible.
       
      repeated string endpoints = 4 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the endpoints at the given index.
    • getPathsList

      List<String> getPathsList()
       Optional. List of paths served by this API.
       
      repeated string paths = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      A list containing the paths.
    • getPathsCount

      int getPathsCount()
       Optional. List of paths served by this API.
       
      repeated string paths = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The count of paths.
    • getPaths

      String getPaths(int index)
       Optional. List of paths served by this API.
       
      repeated string paths = 5 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      index - The index of the element to return.
      Returns:
      The paths at the given index.
    • getPathsBytes

      com.google.protobuf.ByteString getPathsBytes(int index)
       Optional. List of paths served by this API.
       
      repeated string paths = 5 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the paths at the given index.
    • hasDocumentation

      boolean hasDocumentation()
       Optional. Documentation of the external API.
       
      .google.cloud.apihub.v1.Documentation documentation = 6 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the documentation field is set.
    • getDocumentation

      Documentation getDocumentation()
       Optional. Documentation of the external API.
       
      .google.cloud.apihub.v1.Documentation documentation = 6 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The documentation.
    • getDocumentationOrBuilder

      DocumentationOrBuilder getDocumentationOrBuilder()
       Optional. Documentation of the external API.
       
      .google.cloud.apihub.v1.Documentation documentation = 6 [(.google.api.field_behavior) = OPTIONAL];
    • getAttributesCount

      int getAttributesCount()
       Optional. The list of user defined attributes associated with the Version
       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 = 7 [(.google.api.field_behavior) = OPTIONAL];
    • containsAttributes

      boolean containsAttributes(String key)
       Optional. The list of user defined attributes associated with the Version
       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 = 7 [(.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 Version
       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 = 7 [(.google.api.field_behavior) = OPTIONAL];
    • getAttributesOrDefault

      AttributeValues getAttributesOrDefault(String key, AttributeValues defaultValue)
       Optional. The list of user defined attributes associated with the Version
       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 = 7 [(.google.api.field_behavior) = OPTIONAL];
    • getAttributesOrThrow

      AttributeValues getAttributesOrThrow(String key)
       Optional. The list of user defined attributes associated with the Version
       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 = 7 [(.google.api.field_behavior) = OPTIONAL];
    • hasCreateTime

      boolean hasCreateTime()
       Output only. Creation timestamp.
       
      .google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the createTime field is set.
    • getCreateTime

      com.google.protobuf.Timestamp getCreateTime()
       Output only. Creation timestamp.
       
      .google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The createTime.
    • getCreateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. Creation timestamp.
       
      .google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • hasUpdateTime

      boolean hasUpdateTime()
       Output only. Last update timestamp.
       
      .google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the updateTime field is set.
    • getUpdateTime

      com.google.protobuf.Timestamp getUpdateTime()
       Output only. Last update timestamp.
       
      .google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The updateTime.
    • getUpdateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. Last update timestamp.
       
      .google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];