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