Constructor
new Spec(propertiesopt)
Constructs a new Spec.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.apihub.v1.ISpec |
<optional> |
Properties to set |
- Implements:
-
- ISpec
Members
attributes
Spec attributes.
contents
Spec contents.
createTime
Spec createTime.
details
Spec details.
displayName
Spec displayName.
documentation
Spec documentation.
lintResponse
Spec lintResponse.
name
Spec name.
parsingMode
Spec parsingMode.
sourceUri
Spec sourceUri.
specType
Spec specType.
updateTime
Spec updateTime.
ParsingMode
ParsingMode enum.
Properties:
| Name | Type | Description |
|---|---|---|
PARSING_MODE_UNSPECIFIED |
number |
PARSING_MODE_UNSPECIFIED value |
RELAXED |
number |
RELAXED value |
STRICT |
number |
STRICT value |
Methods
toJSON() → {Object.<string, *>}
Converts this Spec to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(static) create(propertiesopt) → {google.cloud.apihub.v1.Spec}
Creates a new Spec instance using the specified properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.apihub.v1.ISpec |
<optional> |
Properties to set |
Returns:
| Type | Description |
|---|---|
| google.cloud.apihub.v1.Spec |
Spec instance |
(static) decode(reader, lengthopt) → {google.cloud.apihub.v1.Spec}
Decodes a Spec message from the specified reader or buffer.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
|
length |
number |
<optional> |
Message length if known beforehand |
Returns:
| Type | Description |
|---|---|
| google.cloud.apihub.v1.Spec |
Spec |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) decodeDelimited(reader) → {google.cloud.apihub.v1.Spec}
Decodes a Spec message from the specified reader or buffer, length delimited.
Parameters:
| Name | Type | Description |
|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
Returns:
| Type | Description |
|---|---|
| google.cloud.apihub.v1.Spec |
Spec |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) encode(message, writeropt) → {$protobuf.Writer}
Encodes the specified Spec message. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.apihub.v1.ISpec |
Spec message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}
Encodes the specified Spec message, length delimited. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.apihub.v1.ISpec |
Spec message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) fromObject(object) → {google.cloud.apihub.v1.Spec}
Creates a Spec message from a plain object. Also converts values to their respective internal types.
Parameters:
| Name | Type | Description |
|---|---|---|
object |
Object.<string, *> |
Plain object |
Returns:
| Type | Description |
|---|---|
| google.cloud.apihub.v1.Spec |
Spec |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for Spec
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
typeUrlPrefix |
string |
<optional> |
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns:
| Type | Description |
|---|---|
| string |
The default type url |
(static) toObject(message, optionsopt) → {Object.<string, *>}
Creates a plain object from a Spec message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.apihub.v1.Spec |
Spec |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies a Spec message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
| Type | Description |
|---|---|
| string | null |
|