Interface ApiSpecOrBuilder (0.14.1)

public interface ApiSpecOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsAnnotations(String key)

public abstract 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;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`boolean`

containsLabels(String key)

public abstract 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;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`boolean`

getAnnotations()

public abstract Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns
Type	Description
`Map<String,String>`

getAnnotationsCount()

public abstract int getAnnotationsCount()

map<string, string> annotations = 15;

Returns
Type	Description
`int`

getAnnotationsMap()

public abstract Map<String,String> getAnnotationsMap()

map<string, string> annotations = 15;

Returns
Type	Description
`Map<String,String>`

getAnnotationsOrDefault(String key, String defaultValue)

public abstract String getAnnotationsOrDefault(String key, String defaultValue)

map<string, string> annotations = 15;

Parameters
Name	Description
`key`	`String`
`defaultValue`	`String`

Returns
Type	Description
`String`

getAnnotationsOrThrow(String key)

public abstract String getAnnotationsOrThrow(String key)

map<string, string> annotations = 15;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`String`

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. Creation timestamp; when the spec resource was created.

.google.protobuf.Timestamp create_time = 5;

Returns
Type	Description
`Timestamp`	The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Creation timestamp; when the spec resource was created.

.google.protobuf.Timestamp create_time = 5;

Returns
Type	Description
`TimestampOrBuilder`

getDescription()

public abstract String getDescription()

A detailed description.

string description = 3;

Returns
Type	Description
`String`	The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

A detailed description.

string description = 3;

Returns
Type	Description
`ByteString`	The bytes for description.

getFilename()

public abstract String getFilename()

A possibly-hierarchical name used to refer to the spec from other specs.

string filename = 2;

Returns
Type	Description
`String`	The filename.

getFilenameBytes()

public abstract ByteString getFilenameBytes()

A possibly-hierarchical name used to refer to the spec from other specs.

string filename = 2;

Returns
Type	Description
`ByteString`	The bytes for filename.

getHash()

public abstract String 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;

Returns
Type	Description
`String`	The hash.

getHashBytes()

public abstract 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;

Returns
Type	Description
`ByteString`	The bytes for hash.

getLabels()

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
`Map<String,String>`

getLabelsCount()

public abstract int getLabelsCount()

map<string, string> labels = 14;

Returns
Type	Description
`int`

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

map<string, string> labels = 14;

Returns
Type	Description
`Map<String,String>`

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

map<string, string> labels = 14;

Parameters
Name	Description
`key`	`String`
`defaultValue`	`String`

Returns
Type	Description
`String`

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

map<string, string> labels = 14;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`String`

getMimeType()

public abstract 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;

Returns
Type	Description
`String`	The mimeType.

getMimeTypeBytes()

public abstract ByteString getMimeTypeBytes()

string mime_type = 8;

Returns
Type	Description
`ByteString`	The bytes for mimeType.

getName()

public abstract String getName()

Resource name.

string name = 1;

Returns
Type	Description
`String`	The name.

getNameBytes()

public abstract ByteString getNameBytes()

Resource name.

string name = 1;

Returns
Type	Description
`ByteString`	The bytes for name.

getRevisionCreateTime()

public abstract Timestamp getRevisionCreateTime()

Output only. Revision creation timestamp; when the represented revision was created.

.google.protobuf.Timestamp revision_create_time = 6;

Returns
Type	Description
`Timestamp`	The revisionCreateTime.

getRevisionCreateTimeOrBuilder()

public abstract TimestampOrBuilder getRevisionCreateTimeOrBuilder()

Output only. Revision creation timestamp; when the represented revision was created.

.google.protobuf.Timestamp revision_create_time = 6;

Returns
Type	Description
`TimestampOrBuilder`

getRevisionId()

public abstract 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;

Returns
Type	Description
`String`	The revisionId.

getRevisionIdBytes()

public abstract 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;

Returns
Type	Description
`ByteString`	The bytes for revisionId.

getRevisionUpdateTime()

public abstract Timestamp getRevisionUpdateTime()

Output only. Last update timestamp: when the represented revision was last modified.

.google.protobuf.Timestamp revision_update_time = 7;

Returns
Type	Description
`Timestamp`	The revisionUpdateTime.

getRevisionUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getRevisionUpdateTimeOrBuilder()

Output only. Last update timestamp: when the represented revision was last modified.

.google.protobuf.Timestamp revision_update_time = 7;

Returns
Type	Description
`TimestampOrBuilder`

getSizeBytes()

public abstract 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;

Returns
Type	Description
`int`	The sizeBytes.

getSourceUri()

public abstract 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;

Returns
Type	Description
`String`	The sourceUri.

getSourceUriBytes()

public abstract ByteString getSourceUriBytes()

string source_uri = 11;

Returns
Type	Description
`ByteString`	The bytes for sourceUri.

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. Creation timestamp; when the spec resource was created.

.google.protobuf.Timestamp create_time = 5;

Returns
Type	Description
`boolean`	Whether the createTime field is set.

hasRevisionCreateTime()

public abstract boolean hasRevisionCreateTime()

Output only. Revision creation timestamp; when the represented revision was created.

.google.protobuf.Timestamp revision_create_time = 6;

Returns
Type	Description
`boolean`	Whether the revisionCreateTime field is set.

hasRevisionUpdateTime()

public abstract boolean hasRevisionUpdateTime()

Output only. Last update timestamp: when the represented revision was last modified.

.google.protobuf.Timestamp revision_update_time = 7;

Returns
Type	Description
`boolean`	Whether the revisionUpdateTime field is set.