Represents an ApiSpec.
Package
@google-cloud/apigee-registryConstructors
(constructor)(properties)
constructor(properties?: google.cloud.apigeeregistry.v1.IApiSpec);Constructs a new ApiSpec.
| Parameter | |
|---|---|
| Name | Description |
properties |
IApiSpec
Properties to set |
Properties
annotations
public annotations: { [k: string]: string };ApiSpec annotations.
contents
public contents: (Uint8Array|string);ApiSpec contents.
createTime
public createTime?: (google.protobuf.ITimestamp|null);ApiSpec createTime.
description
public description: string;ApiSpec description.
filename
public filename: string;ApiSpec filename.
hash
public hash: string;ApiSpec hash.
labels
public labels: { [k: string]: string };ApiSpec labels.
mimeType
public mimeType: string;ApiSpec mimeType.
name
public name: string;ApiSpec name.
revisionCreateTime
public revisionCreateTime?: (google.protobuf.ITimestamp|null);ApiSpec revisionCreateTime.
revisionId
public revisionId: string;ApiSpec revisionId.
revisionUpdateTime
public revisionUpdateTime?: (google.protobuf.ITimestamp|null);ApiSpec revisionUpdateTime.
sizeBytes
public sizeBytes: number;ApiSpec sizeBytes.
sourceUri
public sourceUri: string;ApiSpec sourceUri.
Methods
create(properties)
public static create(properties?: google.cloud.apigeeregistry.v1.IApiSpec): google.cloud.apigeeregistry.v1.ApiSpec;Creates a new ApiSpec instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IApiSpec
Properties to set |
| Returns | |
|---|---|
| Type | Description |
ApiSpec | ApiSpec instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.apigeeregistry.v1.ApiSpec;Decodes an ApiSpec message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
ApiSpec | ApiSpec |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.apigeeregistry.v1.ApiSpec;Decodes an ApiSpec message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
ApiSpec | ApiSpec |
encode(message, writer)
public static encode(message: google.cloud.apigeeregistry.v1.IApiSpec, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified ApiSpec message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IApiSpec
ApiSpec message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.apigeeregistry.v1.IApiSpec, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified ApiSpec message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IApiSpec
ApiSpec message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.apigeeregistry.v1.ApiSpec;Creates an ApiSpec message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
ApiSpec | ApiSpec |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for ApiSpec
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this ApiSpec to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.apigeeregistry.v1.ApiSpec, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from an ApiSpec message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
ApiSpec
ApiSpec |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies an ApiSpec message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|