Package com.google.cloud.apihub.v1
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:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classAn external API represents an API being provided by external sources.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParentNested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleancontainsAttributes(String key) Optional.booleanDeprecated.intOptional.Optional.getAttributesOrDefault(String key, AttributeValues defaultValue) Optional.Optional.com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.static ExternalApiOptional.com.google.protobuf.ByteStringOptional.static final com.google.protobuf.Descriptors.DescriptorRequired.com.google.protobuf.ByteStringRequired.Optional.Optional.getEndpoints(int index) Optional.com.google.protobuf.ByteStringgetEndpointsBytes(int index) Optional.intOptional.com.google.protobuf.ProtocolStringListOptional.getName()Identifier.com.google.protobuf.ByteStringIdentifier.com.google.protobuf.Parser<ExternalApi>getPaths(int index) Optional.com.google.protobuf.ByteStringgetPathsBytes(int index) Optional.intOptional.com.google.protobuf.ProtocolStringListOptional.intcom.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.booleanOutput only.booleanOptional.inthashCode()booleanOutput only.protected com.google.protobuf.GeneratedMessage.FieldAccessorTableprotected com.google.protobuf.MapFieldReflectionAccessorinternalGetMapFieldReflection(int number) final booleanstatic ExternalApi.Builderstatic ExternalApi.BuildernewBuilder(ExternalApi prototype) protected ExternalApi.BuildernewBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) static ExternalApiparseDelimitedFrom(InputStream input) static ExternalApiparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ExternalApiparseFrom(byte[] data) static ExternalApiparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ExternalApiparseFrom(com.google.protobuf.ByteString data) static ExternalApiparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ExternalApiparseFrom(com.google.protobuf.CodedInputStream input) static ExternalApiparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ExternalApiparseFrom(InputStream input) static ExternalApiparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ExternalApiparseFrom(ByteBuffer data) static ExternalApiparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<ExternalApi>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
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:
internalGetMapFieldReflectionin classcom.google.protobuf.GeneratedMessage
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage
-
getName
Identifier. Format: `projects/{project}/locations/{location}/externalApi/{externalApi}`.string name = 1 [(.google.api.field_behavior) = IDENTIFIER];- Specified by:
getNamein interfaceExternalApiOrBuilder- 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:
getNameBytesin interfaceExternalApiOrBuilder- Returns:
- The bytes for name.
-
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:
getDisplayNamein interfaceExternalApiOrBuilder- 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:
getDisplayNameBytesin interfaceExternalApiOrBuilder- Returns:
- The bytes for displayName.
-
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:
getDescriptionin interfaceExternalApiOrBuilder- 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:
getDescriptionBytesin interfaceExternalApiOrBuilder- 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:
getEndpointsListin interfaceExternalApiOrBuilder- 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:
getEndpointsCountin interfaceExternalApiOrBuilder- Returns:
- The count of endpoints.
-
getEndpoints
Optional. List of endpoints on which this API is accessible.
repeated string endpoints = 4 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getEndpointsin interfaceExternalApiOrBuilder- 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:
getEndpointsBytesin interfaceExternalApiOrBuilder- 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:
getPathsListin interfaceExternalApiOrBuilder- 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:
getPathsCountin interfaceExternalApiOrBuilder- Returns:
- The count of paths.
-
getPaths
Optional. List of paths served by this API.
repeated string paths = 5 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getPathsin interfaceExternalApiOrBuilder- 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:
getPathsBytesin interfaceExternalApiOrBuilder- 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:
hasDocumentationin interfaceExternalApiOrBuilder- Returns:
- Whether the documentation field is set.
-
getDocumentation
Optional. Documentation of the external API.
.google.cloud.apihub.v1.Documentation documentation = 6 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getDocumentationin interfaceExternalApiOrBuilder- Returns:
- The documentation.
-
getDocumentationOrBuilder
Optional. Documentation of the external API.
.google.cloud.apihub.v1.Documentation documentation = 6 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getDocumentationOrBuilderin interfaceExternalApiOrBuilder
-
getAttributesCount
public int getAttributesCount()Description copied from interface:ExternalApiOrBuilderOptional. 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:
getAttributesCountin interfaceExternalApiOrBuilder
-
containsAttributes
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:
containsAttributesin interfaceExternalApiOrBuilder
-
getAttributes
Deprecated.UsegetAttributesMap()instead.- Specified by:
getAttributesin interfaceExternalApiOrBuilder
-
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:
getAttributesMapin interfaceExternalApiOrBuilder
-
getAttributesOrDefault
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:
getAttributesOrDefaultin interfaceExternalApiOrBuilder
-
getAttributesOrThrow
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:
getAttributesOrThrowin interfaceExternalApiOrBuilder
-
hasCreateTime
public boolean hasCreateTime()Output only. Creation timestamp.
.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasCreateTimein interfaceExternalApiOrBuilder- 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:
getCreateTimein interfaceExternalApiOrBuilder- 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:
getCreateTimeOrBuilderin interfaceExternalApiOrBuilder
-
hasUpdateTime
public boolean hasUpdateTime()Output only. Last update timestamp.
.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasUpdateTimein interfaceExternalApiOrBuilder- 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:
getUpdateTimein interfaceExternalApiOrBuilder- 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:
getUpdateTimeOrBuilderin interfaceExternalApiOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessage- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.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
- Throws:
IOException
-
parseFrom
public static ExternalApi parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static ExternalApi parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static ExternalApi parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected ExternalApi.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForTypein classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-