Class: ConnectivityRule
connectivityrule.v1.ConnectivityRule
Represents a ConnectivityRule.
Implements
Constructors
constructor
• new ConnectivityRule(properties?): ConnectivityRule
Constructs a new ConnectivityRule.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IConnectivityRule | Properties to set |
Returns
Properties
asyncOperationId
• asyncOperationId: string
The id of the async operation that is creating/updating/deleting the connectivity rule, if any.
Implementation of
IConnectivityRule.asyncOperationId
createdTime
• Optional createdTime: null | ITimestamp
The date and time when the connectivity rule was created.
Implementation of
id
• id: string
The id of the private connectivity rule.
Implementation of
resourceVersion
• resourceVersion: string
The current version of the connectivity rule specification. The next update operation will have to include this version.
Implementation of
IConnectivityRule.resourceVersion
spec
• Optional spec: null | IConnectivityRuleSpec
The connectivity rule specification.
Implementation of
state
• state: ResourceState
ConnectivityRule state.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this ConnectivityRule to JSON.
Returns
Object
JSON object
create
▸ create(properties?): ConnectivityRule
Creates a new ConnectivityRule instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IConnectivityRule | Properties to set |
Returns
ConnectivityRule instance
decode
▸ decode(reader, length?): ConnectivityRule
Decodes a ConnectivityRule message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
ConnectivityRule
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): ConnectivityRule
Decodes a ConnectivityRule message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
ConnectivityRule
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
encode
▸ encode(message, writer?): Writer
Encodes the specified ConnectivityRule message. Does not implicitly temporal.api.cloud.connectivityrule.v1.ConnectivityRule.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IConnectivityRule | ConnectivityRule message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified ConnectivityRule message, length delimited. Does not implicitly temporal.api.cloud.connectivityrule.v1.ConnectivityRule.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IConnectivityRule | ConnectivityRule message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): ConnectivityRule
Creates a ConnectivityRule message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
ConnectivityRule
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for ConnectivityRule
Parameters
| Name | Type | Description |
|---|---|---|
typeUrlPrefix? | string | your custom typeUrlPrefix(default "type.googleapis.com") |
Returns
string
The default type url
toObject
▸ toObject(message, options?): Object
Creates a plain object from a ConnectivityRule message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | ConnectivityRule | ConnectivityRule |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object