Package com.google.cloud.apihub.v1
Interface SpecOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
Spec,Spec.Builder
@Generated
public interface SpecOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptionbooleancontainsAttributes(String key) Optional.Deprecated.intOptional.Optional.getAttributesOrDefault(String key, AttributeValues defaultValue) Optional.Optional.Optional.Optional.com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.Output only.Output only.Required.com.google.protobuf.ByteStringRequired.Optional.Optional.Optional.Optional.getName()Identifier.com.google.protobuf.ByteStringIdentifier.Optional.intOptional.getSourceMetadata(int index) Output only.intOutput only.Output only.getSourceMetadataOrBuilder(int index) Output only.List<? extends SourceMetadataOrBuilder>Output only.Optional.com.google.protobuf.ByteStringOptional.Required.Required.com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.booleanOptional.booleanOutput only.booleanOutput only.booleanOptional.booleanOptional.booleanRequired.booleanOutput only.Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitializedMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getName
String 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:
- The name.
-
getNameBytes
com.google.protobuf.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:
- The bytes for name.
-
getDisplayName
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:
- The displayName.
-
getDisplayNameBytes
com.google.protobuf.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:
- The bytes for displayName.
-
hasSpecType
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:
- Whether the specType field is set.
-
getSpecType
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];- Returns:
- The specType.
-
getSpecTypeOrBuilder
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]; -
hasContents
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:
- Whether the contents field is set.
-
getContents
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];- Returns:
- The contents.
-
getContentsOrBuilder
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]; -
hasDetails
boolean hasDetails()Output only. Details parsed from the spec.
.google.cloud.apihub.v1.SpecDetails details = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- Whether the details field is set.
-
getDetails
SpecDetails getDetails()Output only. Details parsed from the spec.
.google.cloud.apihub.v1.SpecDetails details = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The details.
-
getDetailsOrBuilder
SpecDetailsOrBuilder getDetailsOrBuilder()Output only. Details parsed from the spec.
.google.cloud.apihub.v1.SpecDetails details = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
getSourceUri
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:
- The sourceUri.
-
getSourceUriBytes
com.google.protobuf.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:
- The bytes for sourceUri.
-
hasCreateTime
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:
- Whether the createTime field is set.
-
getCreateTime
com.google.protobuf.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:
- The createTime.
-
getCreateTimeOrBuilder
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()Output only. The time at which the spec was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
hasUpdateTime
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:
- Whether the updateTime field is set.
-
getUpdateTime
com.google.protobuf.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:
- The updateTime.
-
getUpdateTimeOrBuilder
com.google.protobuf.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]; -
hasLintResponse
boolean hasLintResponse()Optional. The lint response for the spec.
.google.cloud.apihub.v1.LintResponse lint_response = 9 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- Whether the lintResponse field is set.
-
getLintResponse
LintResponse getLintResponse()Optional. The lint response for the spec.
.google.cloud.apihub.v1.LintResponse lint_response = 9 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The lintResponse.
-
getLintResponseOrBuilder
LintResponseOrBuilder getLintResponseOrBuilder()Optional. The lint response for the spec.
.google.cloud.apihub.v1.LintResponse lint_response = 9 [(.google.api.field_behavior) = OPTIONAL]; -
getAttributesCount
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]; -
containsAttributes
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]; -
getAttributes
Deprecated.UsegetAttributesMap()instead. -
getAttributesMap
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
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
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]; -
hasDocumentation
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:
- Whether the documentation field is set.
-
getDocumentation
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];- Returns:
- The documentation.
-
getDocumentationOrBuilder
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]; -
getParsingModeValue
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:
- The enum numeric value on the wire for parsingMode.
-
getParsingMode
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];- Returns:
- The parsingMode.
-
getSourceMetadataList
List<SourceMetadata> getSourceMetadataList()Output only. The list of sources and metadata from the sources of the spec.
repeated .google.cloud.apihub.v1.SourceMetadata source_metadata = 13 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
getSourceMetadata
Output only. The list of sources and metadata from the sources of the spec.
repeated .google.cloud.apihub.v1.SourceMetadata source_metadata = 13 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
getSourceMetadataCount
int getSourceMetadataCount()Output only. The list of sources and metadata from the sources of the spec.
repeated .google.cloud.apihub.v1.SourceMetadata source_metadata = 13 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
getSourceMetadataOrBuilderList
List<? extends SourceMetadataOrBuilder> getSourceMetadataOrBuilderList()Output only. The list of sources and metadata from the sources of the spec.
repeated .google.cloud.apihub.v1.SourceMetadata source_metadata = 13 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
getSourceMetadataOrBuilder
Output only. The list of sources and metadata from the sources of the spec.
repeated .google.cloud.apihub.v1.SourceMetadata source_metadata = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
-