public final class Spec extends GeneratedMessageV3 implements SpecOrBuilder
Represents a spec associated with an API version in the API
Hub. Note that specs of various types can be uploaded, however
parsing of details is supported for OpenAPI spec currently.
Protobuf type google.cloud.apihub.v1.Spec
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 |
|
CONTENTS_FIELD_NUMBER
public static final int CONTENTS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DETAILS_FIELD_NUMBER
public static final int DETAILS_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 |
|
LINT_RESPONSE_FIELD_NUMBER
public static final int LINT_RESPONSE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PARSING_MODE_FIELD_NUMBER
public static final int PARSING_MODE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SOURCE_URI_FIELD_NUMBER
public static final int SOURCE_URI_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SPEC_TYPE_FIELD_NUMBER
public static final int SPEC_TYPE_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 Spec getDefaultInstance()
| Returns |
| Type |
Description |
Spec |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Spec.Builder newBuilder()
newBuilder(Spec prototype)
public static Spec.Builder newBuilder(Spec prototype)
| Parameter |
| Name |
Description |
prototype |
Spec
|
public static Spec parseDelimitedFrom(InputStream input)
| Returns |
| Type |
Description |
Spec |
|
public static Spec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Spec |
|
parseFrom(byte[] data)
public static Spec parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
| Returns |
| Type |
Description |
Spec |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Spec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Spec |
|
parseFrom(ByteString data)
public static Spec parseFrom(ByteString data)
| Returns |
| Type |
Description |
Spec |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Spec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Spec |
|
public static Spec parseFrom(CodedInputStream input)
| Returns |
| Type |
Description |
Spec |
|
public static Spec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Spec |
|
public static Spec parseFrom(InputStream input)
| Returns |
| Type |
Description |
Spec |
|
public static Spec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Spec |
|
parseFrom(ByteBuffer data)
public static Spec parseFrom(ByteBuffer data)
| Returns |
| Type |
Description |
Spec |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Spec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Spec |
|
parser()
public static Parser<Spec> parser()
Methods
containsAttributes(String key)
public boolean containsAttributes(String key)
Optional. The list of user defined attributes associated with the spec.
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 = 10 [(.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 spec.
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 = 10 [(.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 spec.
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 = 10 [(.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 spec.
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 = 10 [(.google.api.field_behavior) = OPTIONAL];
getAttributesOrThrow(String key)
public AttributeValues getAttributesOrThrow(String key)
Optional. The list of user defined attributes associated with the spec.
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 = 10 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
key |
String
|
getContents()
public SpecContents getContents()
Optional. Input only. The contents of the uploaded spec.
.google.cloud.apihub.v1.SpecContents contents = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY];
getContentsOrBuilder()
public SpecContentsOrBuilder getContentsOrBuilder()
Optional. Input only. The contents of the uploaded spec.
.google.cloud.apihub.v1.SpecContents contents = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY];
getCreateTime()
public Timestamp getCreateTime()
Output only. The time at which the spec was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
Timestamp |
The createTime.
|
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The time at which the spec was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public Spec getDefaultInstanceForType()
| Returns |
| Type |
Description |
Spec |
|
getDetails()
public SpecDetails getDetails()
Output only. Details parsed from the spec.
.google.cloud.apihub.v1.SpecDetails details = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDetailsOrBuilder()
public SpecDetailsOrBuilder getDetailsOrBuilder()
Output only. Details parsed from the spec.
.google.cloud.apihub.v1.SpecDetails details = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDisplayName()
public String getDisplayName()
Required. The display name of the spec.
This can contain the file name of the spec.
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 spec.
This can contain the file name of the spec.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
ByteString |
The bytes for displayName.
|
getDocumentation()
public Documentation getDocumentation()
Optional. The documentation of the spec.
For OpenAPI spec, this will be populated from externalDocs in OpenAPI
spec.
.google.cloud.apihub.v1.Documentation documentation = 11 [(.google.api.field_behavior) = OPTIONAL];
getDocumentationOrBuilder()
public DocumentationOrBuilder getDocumentationOrBuilder()
Optional. The documentation of the spec.
For OpenAPI spec, this will be populated from externalDocs in OpenAPI
spec.
.google.cloud.apihub.v1.Documentation documentation = 11 [(.google.api.field_behavior) = OPTIONAL];
getLintResponse()
public LintResponse getLintResponse()
Optional. The lint response for the spec.
.google.cloud.apihub.v1.LintResponse lint_response = 9 [(.google.api.field_behavior) = OPTIONAL];
getLintResponseOrBuilder()
public LintResponseOrBuilder getLintResponseOrBuilder()
Optional. The lint response for the spec.
.google.cloud.apihub.v1.LintResponse lint_response = 9 [(.google.api.field_behavior) = OPTIONAL];
getName()
Identifier. The name of the spec.
Format:
projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns |
| Type |
Description |
String |
The name.
|
getNameBytes()
public ByteString getNameBytes()
Identifier. The name of the spec.
Format:
projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
getParserForType()
public Parser<Spec> getParserForType()
Overrides
getParsingMode()
public Spec.ParsingMode getParsingMode()
Optional. Input only. Enum specifying the parsing mode for OpenAPI
Specification (OAS) parsing.
.google.cloud.apihub.v1.Spec.ParsingMode parsing_mode = 12 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY];
getParsingModeValue()
public int getParsingModeValue()
Optional. Input only. Enum specifying the parsing mode for OpenAPI
Specification (OAS) parsing.
.google.cloud.apihub.v1.Spec.ParsingMode parsing_mode = 12 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for parsingMode.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getSourceUri()
public String getSourceUri()
Optional. The URI of the spec source in case file is uploaded
from an external version control system.
string source_uri = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The sourceUri.
|
getSourceUriBytes()
public ByteString getSourceUriBytes()
Optional. The URI of the spec source in case file is uploaded
from an external version control system.
string source_uri = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for sourceUri.
|
getSpecType()
public AttributeValues getSpecType()
Required. The type of spec.
The value should be one of the allowed values defined for
projects/{project}/locations/{location}/attributes/system-spec-type
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.
Note, this field is mandatory if content is provided.
.google.cloud.apihub.v1.AttributeValues spec_type = 3 [(.google.api.field_behavior) = REQUIRED];
getSpecTypeOrBuilder()
public AttributeValuesOrBuilder getSpecTypeOrBuilder()
Required. The type of spec.
The value should be one of the allowed values defined for
projects/{project}/locations/{location}/attributes/system-spec-type
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.
Note, this field is mandatory if content is provided.
.google.cloud.apihub.v1.AttributeValues spec_type = 3 [(.google.api.field_behavior) = REQUIRED];
getUpdateTime()
public Timestamp getUpdateTime()
Output only. The time at which the spec was last updated.
.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
Timestamp |
The updateTime.
|
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. The time at which the spec was last updated.
.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasContents()
public boolean hasContents()
Optional. Input only. The contents of the uploaded spec.
.google.cloud.apihub.v1.SpecContents contents = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the contents field is set.
|
hasCreateTime()
public boolean hasCreateTime()
Output only. The time at which the spec was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the createTime field is set.
|
hasDetails()
public boolean hasDetails()
Output only. Details parsed from the spec.
.google.cloud.apihub.v1.SpecDetails details = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the details field is set.
|
hasDocumentation()
public boolean hasDocumentation()
Optional. The documentation of the spec.
For OpenAPI spec, this will be populated from externalDocs in OpenAPI
spec.
.google.cloud.apihub.v1.Documentation documentation = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the documentation field is set.
|
hasLintResponse()
public boolean hasLintResponse()
Optional. The lint response for the spec.
.google.cloud.apihub.v1.LintResponse lint_response = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the lintResponse field is set.
|
hasSpecType()
public boolean hasSpecType()
Required. The type of spec.
The value should be one of the allowed values defined for
projects/{project}/locations/{location}/attributes/system-spec-type
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.
Note, this field is mandatory if content is provided.
.google.cloud.apihub.v1.AttributeValues spec_type = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
boolean |
Whether the specType field is set.
|
hasUpdateTime()
public boolean hasUpdateTime()
Output only. The time at which the spec 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.
|
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 Spec.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Spec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public Spec.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
