public final class ApiSpec extends GeneratedMessageV3 implements ApiSpecOrBuilder
Describes a version of an API in a structured way.
ApiSpecs provide formal descriptions that consumers can use to use a version.
ApiSpec resources are intended to be fully-resolved descriptions of an
ApiVersion. When specs consist of multiple files, these should be bundled
together (e.g., in a zip archive) and stored as a unit. Multiple specs can
exist to provide representations in different API description formats.
Synchronization of these representations would be provided by tooling and
background services.
Protobuf type google.cloud.apigeeregistry.v1.ApiSpec
Static Fields
ANNOTATIONS_FIELD_NUMBER
public static final int ANNOTATIONS_FIELD_NUMBER
Field Value
CONTENTS_FIELD_NUMBER
public static final int CONTENTS_FIELD_NUMBER
Field Value
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value
FILENAME_FIELD_NUMBER
public static final int FILENAME_FIELD_NUMBER
Field Value
HASH_FIELD_NUMBER
public static final int HASH_FIELD_NUMBER
Field Value
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
Field Value
MIME_TYPE_FIELD_NUMBER
public static final int MIME_TYPE_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
REVISION_CREATE_TIME_FIELD_NUMBER
public static final int REVISION_CREATE_TIME_FIELD_NUMBER
Field Value
REVISION_ID_FIELD_NUMBER
public static final int REVISION_ID_FIELD_NUMBER
Field Value
REVISION_UPDATE_TIME_FIELD_NUMBER
public static final int REVISION_UPDATE_TIME_FIELD_NUMBER
Field Value
SIZE_BYTES_FIELD_NUMBER
public static final int SIZE_BYTES_FIELD_NUMBER
Field Value
SOURCE_URI_FIELD_NUMBER
public static final int SOURCE_URI_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static ApiSpec getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static ApiSpec.Builder newBuilder()
Returns
newBuilder(ApiSpec prototype)
public static ApiSpec.Builder newBuilder(ApiSpec prototype)
Parameter
Returns
public static ApiSpec parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static ApiSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static ApiSpec parseFrom(byte[] data)
Parameter
| Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ApiSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static ApiSpec parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ApiSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ApiSpec parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static ApiSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ApiSpec parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static ApiSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static ApiSpec parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ApiSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<ApiSpec> parser()
Returns
Methods
containsAnnotations(String key)
public boolean containsAnnotations(String key)
Annotations attach non-identifying metadata to resources.
Annotation keys and values are less restricted than those of labels, but
should be generally used for small values of broad interest. Larger, topic-
specific metadata should be stored in Artifacts.
map<string, string> annotations = 15;
containsLabels(String key)
public boolean containsLabels(String key)
Labels attach identifying metadata to resources. Identifying metadata can
be used to filter list operations.
Label keys and values can be no longer than 64 characters
(Unicode codepoints), can only contain lowercase letters, numeric
characters, underscores and dashes. International characters are allowed.
No more than 64 user labels can be associated with one resource (System
labels are excluded).
See https://goo.gl/xmQnxf for more information and examples of labels.
System reserved label keys are prefixed with
apigeeregistry.googleapis.com/ and cannot be changed.
map<string, string> labels = 14;
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getAnnotations()
public Map<String,String> getAnnotations()
Returns
getAnnotationsCount()
public int getAnnotationsCount()
Annotations attach non-identifying metadata to resources.
Annotation keys and values are less restricted than those of labels, but
should be generally used for small values of broad interest. Larger, topic-
specific metadata should be stored in Artifacts.
map<string, string> annotations = 15;
getAnnotationsMap()
public Map<String,String> getAnnotationsMap()
Annotations attach non-identifying metadata to resources.
Annotation keys and values are less restricted than those of labels, but
should be generally used for small values of broad interest. Larger, topic-
specific metadata should be stored in Artifacts.
map<string, string> annotations = 15;
getAnnotationsOrDefault(String key, String defaultValue)
public String getAnnotationsOrDefault(String key, String defaultValue)
Annotations attach non-identifying metadata to resources.
Annotation keys and values are less restricted than those of labels, but
should be generally used for small values of broad interest. Larger, topic-
specific metadata should be stored in Artifacts.
map<string, string> annotations = 15;
getAnnotationsOrThrow(String key)
public String getAnnotationsOrThrow(String key)
Annotations attach non-identifying metadata to resources.
Annotation keys and values are less restricted than those of labels, but
should be generally used for small values of broad interest. Larger, topic-
specific metadata should be stored in Artifacts.
map<string, string> annotations = 15;
getContents()
public ByteString getContents()
Input only. The contents of the spec.
Provided by API callers when specs are created or updated.
To access the contents of a spec, use GetApiSpecContents.
bytes contents = 12 [(.google.api.field_behavior) = INPUT_ONLY];
getCreateTime()
public Timestamp getCreateTime()
Output only. Creation timestamp; when the spec resource was created.
.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Creation timestamp; when the spec resource was created.
.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public ApiSpec getDefaultInstanceForType()
Returns
getDescription()
public String getDescription()
A detailed description.
string description = 3;
| Type | Description |
String | The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
A detailed description.
string description = 3;
| Type | Description |
ByteString | The bytes for description.
|
getFilename()
public String getFilename()
A possibly-hierarchical name used to refer to the spec from other specs.
string filename = 2;
| Type | Description |
String | The filename.
|
getFilenameBytes()
public ByteString getFilenameBytes()
A possibly-hierarchical name used to refer to the spec from other specs.
string filename = 2;
getHash()
Output only. A SHA-256 hash of the spec's contents. If the spec is gzipped, this is
the hash of the uncompressed spec.
string hash = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
String | The hash.
|
getHashBytes()
public ByteString getHashBytes()
Output only. A SHA-256 hash of the spec's contents. If the spec is gzipped, this is
the hash of the uncompressed spec.
string hash = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
getLabels()
public Map<String,String> getLabels()
Returns
getLabelsCount()
public int getLabelsCount()
Labels attach identifying metadata to resources. Identifying metadata can
be used to filter list operations.
Label keys and values can be no longer than 64 characters
(Unicode codepoints), can only contain lowercase letters, numeric
characters, underscores and dashes. International characters are allowed.
No more than 64 user labels can be associated with one resource (System
labels are excluded).
See https://goo.gl/xmQnxf for more information and examples of labels.
System reserved label keys are prefixed with
apigeeregistry.googleapis.com/ and cannot be changed.
map<string, string> labels = 14;
getLabelsMap()
public Map<String,String> getLabelsMap()
Labels attach identifying metadata to resources. Identifying metadata can
be used to filter list operations.
Label keys and values can be no longer than 64 characters
(Unicode codepoints), can only contain lowercase letters, numeric
characters, underscores and dashes. International characters are allowed.
No more than 64 user labels can be associated with one resource (System
labels are excluded).
See https://goo.gl/xmQnxf for more information and examples of labels.
System reserved label keys are prefixed with
apigeeregistry.googleapis.com/ and cannot be changed.
map<string, string> labels = 14;
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
Labels attach identifying metadata to resources. Identifying metadata can
be used to filter list operations.
Label keys and values can be no longer than 64 characters
(Unicode codepoints), can only contain lowercase letters, numeric
characters, underscores and dashes. International characters are allowed.
No more than 64 user labels can be associated with one resource (System
labels are excluded).
See https://goo.gl/xmQnxf for more information and examples of labels.
System reserved label keys are prefixed with
apigeeregistry.googleapis.com/ and cannot be changed.
map<string, string> labels = 14;
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
Labels attach identifying metadata to resources. Identifying metadata can
be used to filter list operations.
Label keys and values can be no longer than 64 characters
(Unicode codepoints), can only contain lowercase letters, numeric
characters, underscores and dashes. International characters are allowed.
No more than 64 user labels can be associated with one resource (System
labels are excluded).
See https://goo.gl/xmQnxf for more information and examples of labels.
System reserved label keys are prefixed with
apigeeregistry.googleapis.com/ and cannot be changed.
map<string, string> labels = 14;
getMimeType()
public String getMimeType()
A style (format) descriptor for this spec that is specified as a Media Type
(https://en.wikipedia.org/wiki/Media_type). Possible values include
application/vnd.apigee.proto, application/vnd.apigee.openapi, and
application/vnd.apigee.graphql, with possible suffixes representing
compression types. These hypothetical names are defined in the vendor tree
defined in RFC6838 (https://tools.ietf.org/html/rfc6838) and are not final.
Content types can specify compression. Currently only GZip compression is
supported (indicated with "+gzip").
string mime_type = 8;
| Type | Description |
String | The mimeType.
|
getMimeTypeBytes()
public ByteString getMimeTypeBytes()
A style (format) descriptor for this spec that is specified as a Media Type
(https://en.wikipedia.org/wiki/Media_type). Possible values include
application/vnd.apigee.proto, application/vnd.apigee.openapi, and
application/vnd.apigee.graphql, with possible suffixes representing
compression types. These hypothetical names are defined in the vendor tree
defined in RFC6838 (https://tools.ietf.org/html/rfc6838) and are not final.
Content types can specify compression. Currently only GZip compression is
supported (indicated with "+gzip").
string mime_type = 8;
getName()
Resource name.
string name = 1;
| Type | Description |
String | The name.
|
getNameBytes()
public ByteString getNameBytes()
Resource name.
string name = 1;
getParserForType()
public Parser<ApiSpec> getParserForType()
Returns
Overrides
getRevisionCreateTime()
public Timestamp getRevisionCreateTime()
Output only. Revision creation timestamp; when the represented revision was created.
.google.protobuf.Timestamp revision_create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
Timestamp | The revisionCreateTime.
|
getRevisionCreateTimeOrBuilder()
public TimestampOrBuilder getRevisionCreateTimeOrBuilder()
Output only. Revision creation timestamp; when the represented revision was created.
.google.protobuf.Timestamp revision_create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
getRevisionId()
public String getRevisionId()
Output only. Immutable. The revision ID of the spec.
A new revision is committed whenever the spec contents are changed.
The format is an 8-character hexadecimal string.
string revision_id = 4 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
String | The revisionId.
|
getRevisionIdBytes()
public ByteString getRevisionIdBytes()
Output only. Immutable. The revision ID of the spec.
A new revision is committed whenever the spec contents are changed.
The format is an 8-character hexadecimal string.
string revision_id = 4 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
ByteString | The bytes for revisionId.
|
getRevisionUpdateTime()
public Timestamp getRevisionUpdateTime()
Output only. Last update timestamp: when the represented revision was last modified.
.google.protobuf.Timestamp revision_update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
Timestamp | The revisionUpdateTime.
|
getRevisionUpdateTimeOrBuilder()
public TimestampOrBuilder getRevisionUpdateTimeOrBuilder()
Output only. Last update timestamp: when the represented revision was last modified.
.google.protobuf.Timestamp revision_update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getSizeBytes()
public int getSizeBytes()
Output only. The size of the spec file in bytes. If the spec is gzipped, this is the
size of the uncompressed spec.
int32 size_bytes = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
int | The sizeBytes.
|
getSourceUri()
public String getSourceUri()
The original source URI of the spec (if one exists).
This is an external location that can be used for reference purposes
but which may not be authoritative since this external resource may
change after the spec is retrieved.
string source_uri = 11;
| Type | Description |
String | The sourceUri.
|
getSourceUriBytes()
public ByteString getSourceUriBytes()
The original source URI of the spec (if one exists).
This is an external location that can be used for reference purposes
but which may not be authoritative since this external resource may
change after the spec is retrieved.
string source_uri = 11;
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hasCreateTime()
public boolean hasCreateTime()
Output only. Creation timestamp; when the spec resource was created.
.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
boolean | Whether the createTime field is set.
|
hasRevisionCreateTime()
public boolean hasRevisionCreateTime()
Output only. Revision creation timestamp; when the represented revision was created.
.google.protobuf.Timestamp revision_create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
boolean | Whether the revisionCreateTime field is set.
|
hasRevisionUpdateTime()
public boolean hasRevisionUpdateTime()
Output only. Last update timestamp: when the represented revision was last modified.
.google.protobuf.Timestamp revision_update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
boolean | Whether the revisionUpdateTime field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public ApiSpec.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ApiSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public ApiSpec.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
