public final class ExternalApi extends GeneratedMessageV3 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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
ATTRIBUTES_FIELD_NUMBER
public static final int ATTRIBUTES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DOCUMENTATION_FIELD_NUMBER
public static final int DOCUMENTATION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ENDPOINTS_FIELD_NUMBER
public static final int ENDPOINTS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PATHS_FIELD_NUMBER
public static final int PATHS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static ExternalApi getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ExternalApi.Builder newBuilder()
newBuilder(ExternalApi prototype)
public static ExternalApi.Builder newBuilder(ExternalApi prototype)
public static ExternalApi parseDelimitedFrom(InputStream input)
public static ExternalApi parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ExternalApi parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ExternalApi parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ExternalApi parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ExternalApi parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ExternalApi parseFrom(CodedInputStream input)
public static ExternalApi parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ExternalApi parseFrom(InputStream input)
public static ExternalApi parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ExternalApi parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ExternalApi parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ExternalApi> parser()
Methods
containsAttributes(String key)
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];
| Parameter |
| Name |
Description |
key |
String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getAttributes() (deprecated)
public Map<String,AttributeValues> getAttributes()
getAttributesCount()
public 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];
| Returns |
| Type |
Description |
int |
|
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];
getAttributesOrDefault(String key, AttributeValues defaultValue)
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];
getAttributesOrThrow(String key)
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];
| Parameter |
| Name |
Description |
key |
String
|
getCreateTime()
public Timestamp getCreateTime()
Output only. Creation timestamp.
.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
Timestamp |
The createTime.
|
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Creation timestamp.
.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public ExternalApi getDefaultInstanceForType()
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];
| Returns |
| Type |
Description |
String |
The description.
|
getDescriptionBytes()
public 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 |
| Type |
Description |
ByteString |
The bytes for description.
|
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];
| Returns |
| Type |
Description |
String |
The displayName.
|
getDisplayNameBytes()
public 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 |
| Type |
Description |
ByteString |
The bytes for displayName.
|
getDocumentation()
public Documentation getDocumentation()
Optional. Documentation of the external API.
.google.cloud.apihub.v1.Documentation documentation = 6 [(.google.api.field_behavior) = OPTIONAL];
getDocumentationOrBuilder()
public DocumentationOrBuilder getDocumentationOrBuilder()
Optional. Documentation of the external API.
.google.cloud.apihub.v1.Documentation documentation = 6 [(.google.api.field_behavior) = OPTIONAL];
getEndpoints(int index)
public String getEndpoints(int index)
Optional. List of endpoints on which this API is accessible.
repeated string endpoints = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
index |
int
The index of the element to return.
|
| Returns |
| Type |
Description |
String |
The endpoints at the given index.
|
getEndpointsBytes(int index)
public ByteString getEndpointsBytes(int index)
Optional. List of endpoints on which this API is accessible.
repeated string endpoints = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
index |
int
The index of the value to return.
|
| Returns |
| Type |
Description |
ByteString |
The bytes of the endpoints at the given index.
|
getEndpointsCount()
public int getEndpointsCount()
Optional. List of endpoints on which this API is accessible.
repeated string endpoints = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
The count of endpoints.
|
getEndpointsList()
public ProtocolStringList getEndpointsList()
Optional. List of endpoints on which this API is accessible.
repeated string endpoints = 4 [(.google.api.field_behavior) = OPTIONAL];
getName()
Identifier. Format:
projects/{project}/locations/{location}/externalApi/{externalApi}.
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns |
| Type |
Description |
String |
The name.
|
getNameBytes()
public ByteString getNameBytes()
Identifier. Format:
projects/{project}/locations/{location}/externalApi/{externalApi}.
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
getParserForType()
public Parser<ExternalApi> getParserForType()
Overrides
getPaths(int index)
public String getPaths(int index)
Optional. List of paths served by this API.
repeated string paths = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
index |
int
The index of the element to return.
|
| Returns |
| Type |
Description |
String |
The paths at the given index.
|
getPathsBytes(int index)
public ByteString getPathsBytes(int index)
Optional. List of paths served by this API.
repeated string paths = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
index |
int
The index of the value to return.
|
| Returns |
| Type |
Description |
ByteString |
The bytes of the paths at the given index.
|
getPathsCount()
public int getPathsCount()
Optional. List of paths served by this API.
repeated string paths = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
The count of paths.
|
getPathsList()
public ProtocolStringList getPathsList()
Optional. List of paths served by this API.
repeated string paths = 5 [(.google.api.field_behavior) = OPTIONAL];
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getUpdateTime()
public Timestamp getUpdateTime()
Output only. Last update timestamp.
.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
Timestamp |
The updateTime.
|
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Last update timestamp.
.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCreateTime()
public boolean hasCreateTime()
Output only. Creation timestamp.
.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the createTime field is set.
|
hasDocumentation()
public boolean hasDocumentation()
Optional. Documentation of the external API.
.google.cloud.apihub.v1.Documentation documentation = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the documentation field is set.
|
hasUpdateTime()
public boolean hasUpdateTime()
Output only. Last update timestamp.
.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the updateTime field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
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.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ExternalApi.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ExternalApi.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public ExternalApi.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
