Constructor
new Api(propertiesopt)
Constructs a new Api.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.apihub.v1.IApi |
<optional> |
Properties to set |
- Implements:
-
- IApi
Members
apiStyle
Api apiStyle.
attributes
Api attributes.
businessUnit
Api businessUnit.
createTime
Api createTime.
description
Api description.
displayName
Api displayName.
documentation
Api documentation.
maturityLevel
Api maturityLevel.
name
Api name.
owner
Api owner.
selectedVersion
Api selectedVersion.
targetUser
Api targetUser.
team
Api team.
updateTime
Api updateTime.
versions
Api versions.
Methods
toJSON() → {Object.<string, *>}
Converts this Api to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(static) create(propertiesopt) → {google.cloud.apihub.v1.Api}
Creates a new Api instance using the specified properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.apihub.v1.IApi |
<optional> |
Properties to set |
Returns:
| Type | Description |
|---|---|
| google.cloud.apihub.v1.Api |
Api instance |
(static) decode(reader, lengthopt) → {google.cloud.apihub.v1.Api}
Decodes an Api 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.Api |
Api |
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.Api}
Decodes an Api 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.Api |
Api |
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 Api message. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.apihub.v1.IApi |
Api 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 Api message, length delimited. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.apihub.v1.IApi |
Api 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.Api}
Creates an Api 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.Api |
Api |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for Api
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 an Api message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.apihub.v1.Api |
Api |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies an Api message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
| Type | Description |
|---|---|
| string | null |
|