public static final class ExternalApi.Builder extends GeneratedMessageV3.Builder<ExternalApi.Builder> 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
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ExternalApi.BuilderImplements
ExternalApiOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addAllEndpoints(Iterable<String> values)
public ExternalApi.Builder addAllEndpoints(Iterable<String> values)
Optional. List of endpoints on which this API is accessible.
repeated string endpoints = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
values |
Iterable<String> The endpoints to add. |
Returns | |
---|---|
Type | Description |
ExternalApi.Builder |
This builder for chaining. |
addAllPaths(Iterable<String> values)
public ExternalApi.Builder addAllPaths(Iterable<String> values)
Optional. List of paths served by this API.
repeated string paths = 5 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
values |
Iterable<String> The paths to add. |
Returns | |
---|---|
Type | Description |
ExternalApi.Builder |
This builder for chaining. |
addEndpoints(String value)
public ExternalApi.Builder addEndpoints(String value)
Optional. List of endpoints on which this API is accessible.
repeated string endpoints = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
String The endpoints to add. |
Returns | |
---|---|
Type | Description |
ExternalApi.Builder |
This builder for chaining. |
addEndpointsBytes(ByteString value)
public ExternalApi.Builder addEndpointsBytes(ByteString value)
Optional. List of endpoints on which this API is accessible.
repeated string endpoints = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes of the endpoints to add. |
Returns | |
---|---|
Type | Description |
ExternalApi.Builder |
This builder for chaining. |
addPaths(String value)
public ExternalApi.Builder addPaths(String value)
Optional. List of paths served by this API.
repeated string paths = 5 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
String The paths to add. |
Returns | |
---|---|
Type | Description |
ExternalApi.Builder |
This builder for chaining. |
addPathsBytes(ByteString value)
public ExternalApi.Builder addPathsBytes(ByteString value)
Optional. List of paths served by this API.
repeated string paths = 5 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes of the paths to add. |
Returns | |
---|---|
Type | Description |
ExternalApi.Builder |
This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ExternalApi.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
ExternalApi.Builder |
build()
public ExternalApi build()
Returns | |
---|---|
Type | Description |
ExternalApi |
buildPartial()
public ExternalApi buildPartial()
Returns | |
---|---|
Type | Description |
ExternalApi |
clear()
public ExternalApi.Builder clear()
Returns | |
---|---|
Type | Description |
ExternalApi.Builder |
clearAttributes()
public ExternalApi.Builder clearAttributes()
Returns | |
---|---|
Type | Description |
ExternalApi.Builder |
clearCreateTime()
public ExternalApi.Builder clearCreateTime()
Output only. Creation timestamp.
.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
ExternalApi.Builder |
clearDescription()
public ExternalApi.Builder clearDescription()
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 |
ExternalApi.Builder |
This builder for chaining. |
clearDisplayName()
public ExternalApi.Builder clearDisplayName()
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 |
ExternalApi.Builder |
This builder for chaining. |
clearDocumentation()
public ExternalApi.Builder clearDocumentation()
Optional. Documentation of the external API.
.google.cloud.apihub.v1.Documentation documentation = 6 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ExternalApi.Builder |
clearEndpoints()
public ExternalApi.Builder clearEndpoints()
Optional. List of endpoints on which this API is accessible.
repeated string endpoints = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ExternalApi.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public ExternalApi.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
ExternalApi.Builder |
clearName()
public ExternalApi.Builder clearName()
Identifier. Format:
projects/{project}/locations/{location}/externalApi/{externalApi}
.
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
Returns | |
---|---|
Type | Description |
ExternalApi.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ExternalApi.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
ExternalApi.Builder |
clearPaths()
public ExternalApi.Builder clearPaths()
Optional. List of paths served by this API.
repeated string paths = 5 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ExternalApi.Builder |
This builder for chaining. |
clearUpdateTime()
public ExternalApi.Builder clearUpdateTime()
Output only. Last update timestamp.
.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
ExternalApi.Builder |
clone()
public ExternalApi.Builder clone()
Returns | |
---|---|
Type | Description |
ExternalApi.Builder |
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 |
Returns | |
---|---|
Type | Description |
boolean |
getAttributes() (deprecated)
public Map<String,AttributeValues> getAttributes()
Use #getAttributesMap() instead.
Returns | |
---|---|
Type | Description |
Map<String,AttributeValues> |
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];
Returns | |
---|---|
Type | Description |
Map<String,AttributeValues> |
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];
Parameters | |
---|---|
Name | Description |
key |
String |
defaultValue |
AttributeValues |
Returns | |
---|---|
Type | Description |
AttributeValues |
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 |
Returns | |
---|---|
Type | Description |
AttributeValues |
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. |
getCreateTimeBuilder()
public Timestamp.Builder getCreateTimeBuilder()
Output only. Creation timestamp.
.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Builder |
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Creation timestamp.
.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
TimestampOrBuilder |
getDefaultInstanceForType()
public ExternalApi getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
ExternalApi |
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. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
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];
Returns | |
---|---|
Type | Description |
Documentation |
The documentation. |
getDocumentationBuilder()
public Documentation.Builder getDocumentationBuilder()
Optional. Documentation of the external API.
.google.cloud.apihub.v1.Documentation documentation = 6 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Documentation.Builder |
getDocumentationOrBuilder()
public DocumentationOrBuilder getDocumentationOrBuilder()
Optional. Documentation of the external API.
.google.cloud.apihub.v1.Documentation documentation = 6 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
DocumentationOrBuilder |
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];
Returns | |
---|---|
Type | Description |
ProtocolStringList |
A list containing the endpoints. |
getMutableAttributes() (deprecated)
public Map<String,AttributeValues> getMutableAttributes()
Use alternate mutation accessors instead.
Returns | |
---|---|
Type | Description |
Map<String,AttributeValues> |
getName()
public String 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. |
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];
Returns | |
---|---|
Type | Description |
ProtocolStringList |
A list containing the paths. |
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. |
getUpdateTimeBuilder()
public Timestamp.Builder getUpdateTimeBuilder()
Output only. Last update timestamp.
.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Builder |
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Last update timestamp.
.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
TimestampOrBuilder |
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter | |
---|---|
Name | Description |
number |
int |
Returns | |
---|---|
Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter | |
---|---|
Name | Description |
number |
int |
Returns | |
---|---|
Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeCreateTime(Timestamp value)
public ExternalApi.Builder mergeCreateTime(Timestamp value)
Output only. Creation timestamp.
.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
ExternalApi.Builder |
mergeDocumentation(Documentation value)
public ExternalApi.Builder mergeDocumentation(Documentation value)
Optional. Documentation of the external API.
.google.cloud.apihub.v1.Documentation documentation = 6 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
Documentation |
Returns | |
---|---|
Type | Description |
ExternalApi.Builder |
mergeFrom(ExternalApi other)
public ExternalApi.Builder mergeFrom(ExternalApi other)
Parameter | |
---|---|
Name | Description |
other |
ExternalApi |
Returns | |
---|---|
Type | Description |
ExternalApi.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ExternalApi.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
ExternalApi.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public ExternalApi.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
ExternalApi.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ExternalApi.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
ExternalApi.Builder |
mergeUpdateTime(Timestamp value)
public ExternalApi.Builder mergeUpdateTime(Timestamp value)
Output only. Last update timestamp.
.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
ExternalApi.Builder |
putAllAttributes(Map<String,AttributeValues> values)
public ExternalApi.Builder putAllAttributes(Map<String,AttributeValues> values)
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 |
values |
Map<String,AttributeValues> |
Returns | |
---|---|
Type | Description |
ExternalApi.Builder |
putAttributes(String key, AttributeValues value)
public ExternalApi.Builder putAttributes(String key, AttributeValues value)
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];
Parameters | |
---|---|
Name | Description |
key |
String |
value |
AttributeValues |
Returns | |
---|---|
Type | Description |
ExternalApi.Builder |
putAttributesBuilderIfAbsent(String key)
public AttributeValues.Builder putAttributesBuilderIfAbsent(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 |
Returns | |
---|---|
Type | Description |
AttributeValues.Builder |
removeAttributes(String key)
public ExternalApi.Builder removeAttributes(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 |
Returns | |
---|---|
Type | Description |
ExternalApi.Builder |
setCreateTime(Timestamp value)
public ExternalApi.Builder setCreateTime(Timestamp value)
Output only. Creation timestamp.
.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
ExternalApi.Builder |
setCreateTime(Timestamp.Builder builderForValue)
public ExternalApi.Builder setCreateTime(Timestamp.Builder builderForValue)
Output only. Creation timestamp.
.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
ExternalApi.Builder |
setDescription(String value)
public ExternalApi.Builder setDescription(String value)
Optional. Description of the external API. Max length is 2000 characters (Unicode Code Points).
string description = 3 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
String The description to set. |
Returns | |
---|---|
Type | Description |
ExternalApi.Builder |
This builder for chaining. |
setDescriptionBytes(ByteString value)
public ExternalApi.Builder setDescriptionBytes(ByteString value)
Optional. Description of the external API. Max length is 2000 characters (Unicode Code Points).
string description = 3 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for description to set. |
Returns | |
---|---|
Type | Description |
ExternalApi.Builder |
This builder for chaining. |
setDisplayName(String value)
public ExternalApi.Builder setDisplayName(String value)
Required. Display name of the external API. Max length is 63 characters (Unicode Code Points).
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
String The displayName to set. |
Returns | |
---|---|
Type | Description |
ExternalApi.Builder |
This builder for chaining. |
setDisplayNameBytes(ByteString value)
public ExternalApi.Builder setDisplayNameBytes(ByteString value)
Required. Display name of the external API. Max length is 63 characters (Unicode Code Points).
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for displayName to set. |
Returns | |
---|---|
Type | Description |
ExternalApi.Builder |
This builder for chaining. |
setDocumentation(Documentation value)
public ExternalApi.Builder setDocumentation(Documentation value)
Optional. Documentation of the external API.
.google.cloud.apihub.v1.Documentation documentation = 6 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
Documentation |
Returns | |
---|---|
Type | Description |
ExternalApi.Builder |
setDocumentation(Documentation.Builder builderForValue)
public ExternalApi.Builder setDocumentation(Documentation.Builder builderForValue)
Optional. Documentation of the external API.
.google.cloud.apihub.v1.Documentation documentation = 6 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
builderForValue |
Documentation.Builder |
Returns | |
---|---|
Type | Description |
ExternalApi.Builder |
setEndpoints(int index, String value)
public ExternalApi.Builder setEndpoints(int index, String value)
Optional. List of endpoints on which this API is accessible.
repeated string endpoints = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameters | |
---|---|
Name | Description |
index |
int The index to set the value at. |
value |
String The endpoints to set. |
Returns | |
---|---|
Type | Description |
ExternalApi.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public ExternalApi.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
ExternalApi.Builder |
setName(String value)
public ExternalApi.Builder setName(String value)
Identifier. Format:
projects/{project}/locations/{location}/externalApi/{externalApi}
.
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
Parameter | |
---|---|
Name | Description |
value |
String The name to set. |
Returns | |
---|---|
Type | Description |
ExternalApi.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public ExternalApi.Builder setNameBytes(ByteString value)
Identifier. Format:
projects/{project}/locations/{location}/externalApi/{externalApi}
.
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for name to set. |
Returns | |
---|---|
Type | Description |
ExternalApi.Builder |
This builder for chaining. |
setPaths(int index, String value)
public ExternalApi.Builder setPaths(int index, String value)
Optional. List of paths served by this API.
repeated string paths = 5 [(.google.api.field_behavior) = OPTIONAL];
Parameters | |
---|---|
Name | Description |
index |
int The index to set the value at. |
value |
String The paths to set. |
Returns | |
---|---|
Type | Description |
ExternalApi.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ExternalApi.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
ExternalApi.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final ExternalApi.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
ExternalApi.Builder |
setUpdateTime(Timestamp value)
public ExternalApi.Builder setUpdateTime(Timestamp value)
Output only. Last update timestamp.
.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
ExternalApi.Builder |
setUpdateTime(Timestamp.Builder builderForValue)
public ExternalApi.Builder setUpdateTime(Timestamp.Builder builderForValue)
Output only. Last update timestamp.
.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
ExternalApi.Builder |