public static final class Api.Builder extends GeneratedMessageV3.Builder<Api.Builder> implements ApiOrBuilder
An API resource in the API Hub.
Protobuf type google.cloud.apihub.v1.Api
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Api.BuilderImplements
ApiOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addAllVersions(Iterable<String> values)
public Api.Builder addAllVersions(Iterable<String> values)
Output only. The list of versions present in an API resource.
Note: An API resource can be associated with more than 1 version.
Format is
projects/{project}/locations/{location}/apis/{api}/versions/{version}
repeated string versions = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
Parameter | |
---|---|
Name | Description |
values |
Iterable<String> The versions to add. |
Returns | |
---|---|
Type | Description |
Api.Builder |
This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Api.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
Api.Builder |
addVersions(String value)
public Api.Builder addVersions(String value)
Output only. The list of versions present in an API resource.
Note: An API resource can be associated with more than 1 version.
Format is
projects/{project}/locations/{location}/apis/{api}/versions/{version}
repeated string versions = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
Parameter | |
---|---|
Name | Description |
value |
String The versions to add. |
Returns | |
---|---|
Type | Description |
Api.Builder |
This builder for chaining. |
addVersionsBytes(ByteString value)
public Api.Builder addVersionsBytes(ByteString value)
Output only. The list of versions present in an API resource.
Note: An API resource can be associated with more than 1 version.
Format is
projects/{project}/locations/{location}/apis/{api}/versions/{version}
repeated string versions = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes of the versions to add. |
Returns | |
---|---|
Type | Description |
Api.Builder |
This builder for chaining. |
build()
public Api build()
Returns | |
---|---|
Type | Description |
Api |
buildPartial()
public Api buildPartial()
Returns | |
---|---|
Type | Description |
Api |
clear()
public Api.Builder clear()
Returns | |
---|---|
Type | Description |
Api.Builder |
clearApiStyle()
public Api.Builder clearApiStyle()
Optional. The style of the API.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-api-style
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues api_style = 14 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Api.Builder |
clearAttributes()
public Api.Builder clearAttributes()
Returns | |
---|---|
Type | Description |
Api.Builder |
clearBusinessUnit()
public Api.Builder clearBusinessUnit()
Optional. The business unit owning the API.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-business-unit
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues business_unit = 11 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Api.Builder |
clearCreateTime()
public Api.Builder clearCreateTime()
Output only. The time at which the API resource was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Api.Builder |
clearDescription()
public Api.Builder clearDescription()
Optional. The description of the API resource.
string description = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Api.Builder |
This builder for chaining. |
clearDisplayName()
public Api.Builder clearDisplayName()
Required. The display name of the API resource.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
Api.Builder |
This builder for chaining. |
clearDocumentation()
public Api.Builder clearDocumentation()
Optional. The documentation for the API resource.
.google.cloud.apihub.v1.Documentation documentation = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Api.Builder |
clearField(Descriptors.FieldDescriptor field)
public Api.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
Api.Builder |
clearMaturityLevel()
public Api.Builder clearMaturityLevel()
Optional. The maturity level of the API.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-maturity-level
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues maturity_level = 12 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Api.Builder |
clearName()
public Api.Builder clearName()
Identifier. The name of the API resource in the API Hub.
Format:
projects/{project}/locations/{location}/apis/{api}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
Returns | |
---|---|
Type | Description |
Api.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Api.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
Api.Builder |
clearOwner()
public Api.Builder clearOwner()
Optional. Owner details for the API resource.
.google.cloud.apihub.v1.Owner owner = 5 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Api.Builder |
clearSelectedVersion()
public Api.Builder clearSelectedVersion()
Optional. The selected version for an API resource.
This can be used when special handling is needed on client side for
particular version of the API. Format is
projects/{project}/locations/{location}/apis/{api}/versions/{version}
string selected_version = 15 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
Api.Builder |
This builder for chaining. |
clearTargetUser()
public Api.Builder clearTargetUser()
Optional. The target users for the API.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-target-user
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues target_user = 9 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Api.Builder |
clearTeam()
public Api.Builder clearTeam()
Optional. The team owning the API.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-team
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues team = 10 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Api.Builder |
clearUpdateTime()
public Api.Builder clearUpdateTime()
Output only. The time at which the API resource was last updated.
.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Api.Builder |
clearVersions()
public Api.Builder clearVersions()
Output only. The list of versions present in an API resource.
Note: An API resource can be associated with more than 1 version.
Format is
projects/{project}/locations/{location}/apis/{api}/versions/{version}
repeated string versions = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
Api.Builder |
This builder for chaining. |
clone()
public Api.Builder clone()
Returns | |
---|---|
Type | Description |
Api.Builder |
containsAttributes(String key)
public boolean containsAttributes(String key)
Optional. The list of user defined attributes associated with the API
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 = 13 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
key |
String |
Returns | |
---|---|
Type | Description |
boolean |
getApiStyle()
public AttributeValues getApiStyle()
Optional. The style of the API.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-api-style
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues api_style = 14 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
AttributeValues |
The apiStyle. |
getApiStyleBuilder()
public AttributeValues.Builder getApiStyleBuilder()
Optional. The style of the API.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-api-style
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues api_style = 14 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
AttributeValues.Builder |
getApiStyleOrBuilder()
public AttributeValuesOrBuilder getApiStyleOrBuilder()
Optional. The style of the API.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-api-style
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues api_style = 14 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
AttributeValuesOrBuilder |
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 API
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 = 13 [(.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 API
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 = 13 [(.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 API
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 = 13 [(.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 API
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 = 13 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
key |
String |
Returns | |
---|---|
Type | Description |
AttributeValues |
getBusinessUnit()
public AttributeValues getBusinessUnit()
Optional. The business unit owning the API.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-business-unit
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues business_unit = 11 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
AttributeValues |
The businessUnit. |
getBusinessUnitBuilder()
public AttributeValues.Builder getBusinessUnitBuilder()
Optional. The business unit owning the API.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-business-unit
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues business_unit = 11 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
AttributeValues.Builder |
getBusinessUnitOrBuilder()
public AttributeValuesOrBuilder getBusinessUnitOrBuilder()
Optional. The business unit owning the API.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-business-unit
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues business_unit = 11 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
AttributeValuesOrBuilder |
getCreateTime()
public Timestamp getCreateTime()
Output only. The time at which the API resource was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Timestamp |
The createTime. |
getCreateTimeBuilder()
public Timestamp.Builder getCreateTimeBuilder()
Output only. The time at which the API resource was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Builder |
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The time at which the API resource was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
TimestampOrBuilder |
getDefaultInstanceForType()
public Api getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
Api |
getDescription()
public String getDescription()
Optional. The description of the API resource.
string description = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
String |
The description. |
getDescriptionBytes()
public ByteString getDescriptionBytes()
Optional. The description of the API resource.
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. The display name of the API resource.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
String |
The displayName. |
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
Required. The display name of the API resource.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for displayName. |
getDocumentation()
public Documentation getDocumentation()
Optional. The documentation for the API resource.
.google.cloud.apihub.v1.Documentation documentation = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Documentation |
The documentation. |
getDocumentationBuilder()
public Documentation.Builder getDocumentationBuilder()
Optional. The documentation for the API resource.
.google.cloud.apihub.v1.Documentation documentation = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Documentation.Builder |
getDocumentationOrBuilder()
public DocumentationOrBuilder getDocumentationOrBuilder()
Optional. The documentation for the API resource.
.google.cloud.apihub.v1.Documentation documentation = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
DocumentationOrBuilder |
getMaturityLevel()
public AttributeValues getMaturityLevel()
Optional. The maturity level of the API.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-maturity-level
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues maturity_level = 12 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
AttributeValues |
The maturityLevel. |
getMaturityLevelBuilder()
public AttributeValues.Builder getMaturityLevelBuilder()
Optional. The maturity level of the API.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-maturity-level
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues maturity_level = 12 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
AttributeValues.Builder |
getMaturityLevelOrBuilder()
public AttributeValuesOrBuilder getMaturityLevelOrBuilder()
Optional. The maturity level of the API.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-maturity-level
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues maturity_level = 12 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
AttributeValuesOrBuilder |
getMutableAttributes() (deprecated)
public Map<String,AttributeValues> getMutableAttributes()
Use alternate mutation accessors instead.
Returns | |
---|---|
Type | Description |
Map<String,AttributeValues> |
getName()
public String getName()
Identifier. The name of the API resource in the API Hub.
Format:
projects/{project}/locations/{location}/apis/{api}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
Returns | |
---|---|
Type | Description |
String |
The name. |
getNameBytes()
public ByteString getNameBytes()
Identifier. The name of the API resource in the API Hub.
Format:
projects/{project}/locations/{location}/apis/{api}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for name. |
getOwner()
public Owner getOwner()
Optional. Owner details for the API resource.
.google.cloud.apihub.v1.Owner owner = 5 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Owner |
The owner. |
getOwnerBuilder()
public Owner.Builder getOwnerBuilder()
Optional. Owner details for the API resource.
.google.cloud.apihub.v1.Owner owner = 5 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Owner.Builder |
getOwnerOrBuilder()
public OwnerOrBuilder getOwnerOrBuilder()
Optional. Owner details for the API resource.
.google.cloud.apihub.v1.Owner owner = 5 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
OwnerOrBuilder |
getSelectedVersion()
public String getSelectedVersion()
Optional. The selected version for an API resource.
This can be used when special handling is needed on client side for
particular version of the API. Format is
projects/{project}/locations/{location}/apis/{api}/versions/{version}
string selected_version = 15 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
String |
The selectedVersion. |
getSelectedVersionBytes()
public ByteString getSelectedVersionBytes()
Optional. The selected version for an API resource.
This can be used when special handling is needed on client side for
particular version of the API. Format is
projects/{project}/locations/{location}/apis/{api}/versions/{version}
string selected_version = 15 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for selectedVersion. |
getTargetUser()
public AttributeValues getTargetUser()
Optional. The target users for the API.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-target-user
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues target_user = 9 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
AttributeValues |
The targetUser. |
getTargetUserBuilder()
public AttributeValues.Builder getTargetUserBuilder()
Optional. The target users for the API.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-target-user
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues target_user = 9 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
AttributeValues.Builder |
getTargetUserOrBuilder()
public AttributeValuesOrBuilder getTargetUserOrBuilder()
Optional. The target users for the API.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-target-user
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues target_user = 9 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
AttributeValuesOrBuilder |
getTeam()
public AttributeValues getTeam()
Optional. The team owning the API.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-team
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues team = 10 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
AttributeValues |
The team. |
getTeamBuilder()
public AttributeValues.Builder getTeamBuilder()
Optional. The team owning the API.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-team
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues team = 10 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
AttributeValues.Builder |
getTeamOrBuilder()
public AttributeValuesOrBuilder getTeamOrBuilder()
Optional. The team owning the API.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-team
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues team = 10 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
AttributeValuesOrBuilder |
getUpdateTime()
public Timestamp getUpdateTime()
Output only. The time at which the API resource was last updated.
.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Timestamp |
The updateTime. |
getUpdateTimeBuilder()
public Timestamp.Builder getUpdateTimeBuilder()
Output only. The time at which the API resource was last updated.
.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Builder |
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. The time at which the API resource was last updated.
.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
TimestampOrBuilder |
getVersions(int index)
public String getVersions(int index)
Output only. The list of versions present in an API resource.
Note: An API resource can be associated with more than 1 version.
Format is
projects/{project}/locations/{location}/apis/{api}/versions/{version}
repeated string versions = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
Parameter | |
---|---|
Name | Description |
index |
int The index of the element to return. |
Returns | |
---|---|
Type | Description |
String |
The versions at the given index. |
getVersionsBytes(int index)
public ByteString getVersionsBytes(int index)
Output only. The list of versions present in an API resource.
Note: An API resource can be associated with more than 1 version.
Format is
projects/{project}/locations/{location}/apis/{api}/versions/{version}
repeated string versions = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
Parameter | |
---|---|
Name | Description |
index |
int The index of the value to return. |
Returns | |
---|---|
Type | Description |
ByteString |
The bytes of the versions at the given index. |
getVersionsCount()
public int getVersionsCount()
Output only. The list of versions present in an API resource.
Note: An API resource can be associated with more than 1 version.
Format is
projects/{project}/locations/{location}/apis/{api}/versions/{version}
repeated string versions = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
int |
The count of versions. |
getVersionsList()
public ProtocolStringList getVersionsList()
Output only. The list of versions present in an API resource.
Note: An API resource can be associated with more than 1 version.
Format is
projects/{project}/locations/{location}/apis/{api}/versions/{version}
repeated string versions = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
ProtocolStringList |
A list containing the versions. |
hasApiStyle()
public boolean hasApiStyle()
Optional. The style of the API.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-api-style
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues api_style = 14 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
boolean |
Whether the apiStyle field is set. |
hasBusinessUnit()
public boolean hasBusinessUnit()
Optional. The business unit owning the API.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-business-unit
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues business_unit = 11 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
boolean |
Whether the businessUnit field is set. |
hasCreateTime()
public boolean hasCreateTime()
Output only. The time at which the API resource was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
boolean |
Whether the createTime field is set. |
hasDocumentation()
public boolean hasDocumentation()
Optional. The documentation for the API resource.
.google.cloud.apihub.v1.Documentation documentation = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
boolean |
Whether the documentation field is set. |
hasMaturityLevel()
public boolean hasMaturityLevel()
Optional. The maturity level of the API.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-maturity-level
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues maturity_level = 12 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
boolean |
Whether the maturityLevel field is set. |
hasOwner()
public boolean hasOwner()
Optional. Owner details for the API resource.
.google.cloud.apihub.v1.Owner owner = 5 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
boolean |
Whether the owner field is set. |
hasTargetUser()
public boolean hasTargetUser()
Optional. The target users for the API.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-target-user
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues target_user = 9 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
boolean |
Whether the targetUser field is set. |
hasTeam()
public boolean hasTeam()
Optional. The team owning the API.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-team
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues team = 10 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
boolean |
Whether the team field is set. |
hasUpdateTime()
public boolean hasUpdateTime()
Output only. The time at which the API resource was last updated.
.google.protobuf.Timestamp update_time = 8 [(.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 |
mergeApiStyle(AttributeValues value)
public Api.Builder mergeApiStyle(AttributeValues value)
Optional. The style of the API.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-api-style
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues api_style = 14 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
AttributeValues |
Returns | |
---|---|
Type | Description |
Api.Builder |
mergeBusinessUnit(AttributeValues value)
public Api.Builder mergeBusinessUnit(AttributeValues value)
Optional. The business unit owning the API.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-business-unit
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues business_unit = 11 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
AttributeValues |
Returns | |
---|---|
Type | Description |
Api.Builder |
mergeCreateTime(Timestamp value)
public Api.Builder mergeCreateTime(Timestamp value)
Output only. The time at which the API resource was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
Api.Builder |
mergeDocumentation(Documentation value)
public Api.Builder mergeDocumentation(Documentation value)
Optional. The documentation for the API resource.
.google.cloud.apihub.v1.Documentation documentation = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
Documentation |
Returns | |
---|---|
Type | Description |
Api.Builder |
mergeFrom(Api other)
public Api.Builder mergeFrom(Api other)
Parameter | |
---|---|
Name | Description |
other |
Api |
Returns | |
---|---|
Type | Description |
Api.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Api.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Api.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public Api.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
Api.Builder |
mergeMaturityLevel(AttributeValues value)
public Api.Builder mergeMaturityLevel(AttributeValues value)
Optional. The maturity level of the API.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-maturity-level
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues maturity_level = 12 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
AttributeValues |
Returns | |
---|---|
Type | Description |
Api.Builder |
mergeOwner(Owner value)
public Api.Builder mergeOwner(Owner value)
Optional. Owner details for the API resource.
.google.cloud.apihub.v1.Owner owner = 5 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
Owner |
Returns | |
---|---|
Type | Description |
Api.Builder |
mergeTargetUser(AttributeValues value)
public Api.Builder mergeTargetUser(AttributeValues value)
Optional. The target users for the API.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-target-user
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues target_user = 9 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
AttributeValues |
Returns | |
---|---|
Type | Description |
Api.Builder |
mergeTeam(AttributeValues value)
public Api.Builder mergeTeam(AttributeValues value)
Optional. The team owning the API.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-team
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues team = 10 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
AttributeValues |
Returns | |
---|---|
Type | Description |
Api.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Api.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
Api.Builder |
mergeUpdateTime(Timestamp value)
public Api.Builder mergeUpdateTime(Timestamp value)
Output only. The time at which the API resource was last updated.
.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
Api.Builder |
putAllAttributes(Map<String,AttributeValues> values)
public Api.Builder putAllAttributes(Map<String,AttributeValues> values)
Optional. The list of user defined attributes associated with the API
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 = 13 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
values |
Map<String,AttributeValues> |
Returns | |
---|---|
Type | Description |
Api.Builder |
putAttributes(String key, AttributeValues value)
public Api.Builder putAttributes(String key, AttributeValues value)
Optional. The list of user defined attributes associated with the API
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 = 13 [(.google.api.field_behavior) = OPTIONAL];
Parameters | |
---|---|
Name | Description |
key |
String |
value |
AttributeValues |
Returns | |
---|---|
Type | Description |
Api.Builder |
putAttributesBuilderIfAbsent(String key)
public AttributeValues.Builder putAttributesBuilderIfAbsent(String key)
Optional. The list of user defined attributes associated with the API
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 = 13 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
key |
String |
Returns | |
---|---|
Type | Description |
AttributeValues.Builder |
removeAttributes(String key)
public Api.Builder removeAttributes(String key)
Optional. The list of user defined attributes associated with the API
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 = 13 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
key |
String |
Returns | |
---|---|
Type | Description |
Api.Builder |
setApiStyle(AttributeValues value)
public Api.Builder setApiStyle(AttributeValues value)
Optional. The style of the API.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-api-style
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues api_style = 14 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
AttributeValues |
Returns | |
---|---|
Type | Description |
Api.Builder |
setApiStyle(AttributeValues.Builder builderForValue)
public Api.Builder setApiStyle(AttributeValues.Builder builderForValue)
Optional. The style of the API.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-api-style
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues api_style = 14 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
builderForValue |
AttributeValues.Builder |
Returns | |
---|---|
Type | Description |
Api.Builder |
setBusinessUnit(AttributeValues value)
public Api.Builder setBusinessUnit(AttributeValues value)
Optional. The business unit owning the API.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-business-unit
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues business_unit = 11 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
AttributeValues |
Returns | |
---|---|
Type | Description |
Api.Builder |
setBusinessUnit(AttributeValues.Builder builderForValue)
public Api.Builder setBusinessUnit(AttributeValues.Builder builderForValue)
Optional. The business unit owning the API.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-business-unit
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues business_unit = 11 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
builderForValue |
AttributeValues.Builder |
Returns | |
---|---|
Type | Description |
Api.Builder |
setCreateTime(Timestamp value)
public Api.Builder setCreateTime(Timestamp value)
Output only. The time at which the API resource was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
Api.Builder |
setCreateTime(Timestamp.Builder builderForValue)
public Api.Builder setCreateTime(Timestamp.Builder builderForValue)
Output only. The time at which the API resource was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
Api.Builder |
setDescription(String value)
public Api.Builder setDescription(String value)
Optional. The description of the API resource.
string description = 3 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
String The description to set. |
Returns | |
---|---|
Type | Description |
Api.Builder |
This builder for chaining. |
setDescriptionBytes(ByteString value)
public Api.Builder setDescriptionBytes(ByteString value)
Optional. The description of the API resource.
string description = 3 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for description to set. |
Returns | |
---|---|
Type | Description |
Api.Builder |
This builder for chaining. |
setDisplayName(String value)
public Api.Builder setDisplayName(String value)
Required. The display name of the API resource.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
String The displayName to set. |
Returns | |
---|---|
Type | Description |
Api.Builder |
This builder for chaining. |
setDisplayNameBytes(ByteString value)
public Api.Builder setDisplayNameBytes(ByteString value)
Required. The display name of the API resource.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for displayName to set. |
Returns | |
---|---|
Type | Description |
Api.Builder |
This builder for chaining. |
setDocumentation(Documentation value)
public Api.Builder setDocumentation(Documentation value)
Optional. The documentation for the API resource.
.google.cloud.apihub.v1.Documentation documentation = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
Documentation |
Returns | |
---|---|
Type | Description |
Api.Builder |
setDocumentation(Documentation.Builder builderForValue)
public Api.Builder setDocumentation(Documentation.Builder builderForValue)
Optional. The documentation for the API resource.
.google.cloud.apihub.v1.Documentation documentation = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
builderForValue |
Documentation.Builder |
Returns | |
---|---|
Type | Description |
Api.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public Api.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
Api.Builder |
setMaturityLevel(AttributeValues value)
public Api.Builder setMaturityLevel(AttributeValues value)
Optional. The maturity level of the API.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-maturity-level
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues maturity_level = 12 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
AttributeValues |
Returns | |
---|---|
Type | Description |
Api.Builder |
setMaturityLevel(AttributeValues.Builder builderForValue)
public Api.Builder setMaturityLevel(AttributeValues.Builder builderForValue)
Optional. The maturity level of the API.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-maturity-level
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues maturity_level = 12 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
builderForValue |
AttributeValues.Builder |
Returns | |
---|---|
Type | Description |
Api.Builder |
setName(String value)
public Api.Builder setName(String value)
Identifier. The name of the API resource in the API Hub.
Format:
projects/{project}/locations/{location}/apis/{api}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
Parameter | |
---|---|
Name | Description |
value |
String The name to set. |
Returns | |
---|---|
Type | Description |
Api.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public Api.Builder setNameBytes(ByteString value)
Identifier. The name of the API resource in the API Hub.
Format:
projects/{project}/locations/{location}/apis/{api}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for name to set. |
Returns | |
---|---|
Type | Description |
Api.Builder |
This builder for chaining. |
setOwner(Owner value)
public Api.Builder setOwner(Owner value)
Optional. Owner details for the API resource.
.google.cloud.apihub.v1.Owner owner = 5 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
Owner |
Returns | |
---|---|
Type | Description |
Api.Builder |
setOwner(Owner.Builder builderForValue)
public Api.Builder setOwner(Owner.Builder builderForValue)
Optional. Owner details for the API resource.
.google.cloud.apihub.v1.Owner owner = 5 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
builderForValue |
Owner.Builder |
Returns | |
---|---|
Type | Description |
Api.Builder |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Api.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
Api.Builder |
setSelectedVersion(String value)
public Api.Builder setSelectedVersion(String value)
Optional. The selected version for an API resource.
This can be used when special handling is needed on client side for
particular version of the API. Format is
projects/{project}/locations/{location}/apis/{api}/versions/{version}
string selected_version = 15 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
Parameter | |
---|---|
Name | Description |
value |
String The selectedVersion to set. |
Returns | |
---|---|
Type | Description |
Api.Builder |
This builder for chaining. |
setSelectedVersionBytes(ByteString value)
public Api.Builder setSelectedVersionBytes(ByteString value)
Optional. The selected version for an API resource.
This can be used when special handling is needed on client side for
particular version of the API. Format is
projects/{project}/locations/{location}/apis/{api}/versions/{version}
string selected_version = 15 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for selectedVersion to set. |
Returns | |
---|---|
Type | Description |
Api.Builder |
This builder for chaining. |
setTargetUser(AttributeValues value)
public Api.Builder setTargetUser(AttributeValues value)
Optional. The target users for the API.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-target-user
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues target_user = 9 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
AttributeValues |
Returns | |
---|---|
Type | Description |
Api.Builder |
setTargetUser(AttributeValues.Builder builderForValue)
public Api.Builder setTargetUser(AttributeValues.Builder builderForValue)
Optional. The target users for the API.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-target-user
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues target_user = 9 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
builderForValue |
AttributeValues.Builder |
Returns | |
---|---|
Type | Description |
Api.Builder |
setTeam(AttributeValues value)
public Api.Builder setTeam(AttributeValues value)
Optional. The team owning the API.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-team
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues team = 10 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
AttributeValues |
Returns | |
---|---|
Type | Description |
Api.Builder |
setTeam(AttributeValues.Builder builderForValue)
public Api.Builder setTeam(AttributeValues.Builder builderForValue)
Optional. The team owning the API.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-team
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues team = 10 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
builderForValue |
AttributeValues.Builder |
Returns | |
---|---|
Type | Description |
Api.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final Api.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
Api.Builder |
setUpdateTime(Timestamp value)
public Api.Builder setUpdateTime(Timestamp value)
Output only. The time at which the API resource was last updated.
.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
Api.Builder |
setUpdateTime(Timestamp.Builder builderForValue)
public Api.Builder setUpdateTime(Timestamp.Builder builderForValue)
Output only. The time at which the API resource was last updated.
.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
Api.Builder |
setVersions(int index, String value)
public Api.Builder setVersions(int index, String value)
Output only. The list of versions present in an API resource.
Note: An API resource can be associated with more than 1 version.
Format is
projects/{project}/locations/{location}/apis/{api}/versions/{version}
repeated string versions = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
Parameters | |
---|---|
Name | Description |
index |
int The index to set the value at. |
value |
String The versions to set. |
Returns | |
---|---|
Type | Description |
Api.Builder |
This builder for chaining. |