Class ExternalApi

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.apihub.v1.ExternalApi
All Implemented Interfaces:
ExternalApiOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

@Generated public final class ExternalApi extends com.google.protobuf.GeneratedMessage implements ExternalApiOrBuilder
 An external API represents an API being provided by external sources. This
 can be used to model third-party APIs and can be used to define dependencies.
 
Protobuf type google.cloud.apihub.v1.ExternalApi
See Also:
  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:
    • DISPLAY_NAME_FIELD_NUMBER

      public static final int DISPLAY_NAME_FIELD_NUMBER
      See Also:
    • DESCRIPTION_FIELD_NUMBER

      public static final int DESCRIPTION_FIELD_NUMBER
      See Also:
    • ENDPOINTS_FIELD_NUMBER

      public static final int ENDPOINTS_FIELD_NUMBER
      See Also:
    • PATHS_FIELD_NUMBER

      public static final int PATHS_FIELD_NUMBER
      See Also:
    • DOCUMENTATION_FIELD_NUMBER

      public static final int DOCUMENTATION_FIELD_NUMBER
      See Also:
    • ATTRIBUTES_FIELD_NUMBER

      public static final int ATTRIBUTES_FIELD_NUMBER
      See Also:
    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:
    • UPDATE_TIME_FIELD_NUMBER

      public static final int UPDATE_TIME_FIELD_NUMBER
      See Also:
  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage
    • getName

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

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

      public 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];
      Specified by:
      getDisplayName in interface ExternalApiOrBuilder
      Returns:
      The displayName.
    • getDisplayNameBytes

      public 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];
      Specified by:
      getDisplayNameBytes in interface ExternalApiOrBuilder
      Returns:
      The bytes for displayName.
    • getDescription

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

      public 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];
      Specified by:
      getDescriptionBytes in interface ExternalApiOrBuilder
      Returns:
      The bytes for description.
    • getEndpointsList

      public com.google.protobuf.ProtocolStringList getEndpointsList()
       Optional. List of endpoints on which this API is accessible.
       
      repeated string endpoints = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEndpointsList in interface ExternalApiOrBuilder
      Returns:
      A list containing the endpoints.
    • getEndpointsCount

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

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

      public 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];
      Specified by:
      getEndpointsBytes in interface ExternalApiOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the endpoints at the given index.
    • getPathsList

      public com.google.protobuf.ProtocolStringList getPathsList()
       Optional. List of paths served by this API.
       
      repeated string paths = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPathsList in interface ExternalApiOrBuilder
      Returns:
      A list containing the paths.
    • getPathsCount

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

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

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

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

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

      public DocumentationOrBuilder getDocumentationOrBuilder()
       Optional. Documentation of the external API.
       
      .google.cloud.apihub.v1.Documentation documentation = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDocumentationOrBuilder in interface ExternalApiOrBuilder
    • getAttributesCount

      public int getAttributesCount()
      Description copied from interface: ExternalApiOrBuilder
       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];
      Specified by:
      getAttributesCount in interface ExternalApiOrBuilder
    • containsAttributes

      public 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];
      Specified by:
      containsAttributes in interface ExternalApiOrBuilder
    • getAttributes

      @Deprecated public Map<String,AttributeValues> getAttributes()
      Deprecated.
      Use getAttributesMap() instead.
      Specified by:
      getAttributes in interface ExternalApiOrBuilder
    • getAttributesMap

      public 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];
      Specified by:
      getAttributesMap in interface ExternalApiOrBuilder
    • getAttributesOrDefault

      public 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];
      Specified by:
      getAttributesOrDefault in interface ExternalApiOrBuilder
    • getAttributesOrThrow

      public 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];
      Specified by:
      getAttributesOrThrow in interface ExternalApiOrBuilder
    • hasCreateTime

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

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

      public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. Creation timestamp.
       
      .google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTimeOrBuilder in interface ExternalApiOrBuilder
    • hasUpdateTime

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

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

      public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. Last update timestamp.
       
      .google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTimeOrBuilder in interface ExternalApiOrBuilder
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage
    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException
    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage
    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage
    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage
    • parseFrom

      public static ExternalApi parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static ExternalApi parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static ExternalApi parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static ExternalApi parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static ExternalApi parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static ExternalApi parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static ExternalApi parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static ExternalApi parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static ExternalApi parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static ExternalApi parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseFrom

      public static ExternalApi parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static ExternalApi parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • newBuilderForType

      public ExternalApi.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite
    • newBuilder

      public static ExternalApi.Builder newBuilder()
    • newBuilder

      public static ExternalApi.Builder newBuilder(ExternalApi prototype)
    • toBuilder

      public ExternalApi.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite
    • newBuilderForType

      protected ExternalApi.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage
    • getDefaultInstance

      public static ExternalApi getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<ExternalApi> parser()
    • getParserForType

      public com.google.protobuf.Parser<ExternalApi> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage
    • getDefaultInstanceForType

      public ExternalApi getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder