Class: ConnectivityRuleSpec
connectivityrule.v1.ConnectivityRuleSpec
The connectivity rule specification passed in on create/update operations.
Implements
Constructors
constructor
• new ConnectivityRuleSpec(properties?): ConnectivityRuleSpec
Constructs a new ConnectivityRuleSpec.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IConnectivityRuleSpec | Properties to set |
Returns
Properties
connectionType
• Optional connectionType: "publicRule" | "privateRule"
ConnectivityRuleSpec connectionType.
privateRule
• Optional privateRule: null | IPrivateConnectivityRule
This allows access via specific private vpc.
Implementation of
IConnectivityRuleSpec.privateRule
publicRule
• Optional publicRule: null | IPublicConnectivityRule
This allows access via public internet.
Implementation of
IConnectivityRuleSpec.publicRule
Methods
toJSON
▸ toJSON(): Object
Converts this ConnectivityRuleSpec to JSON.
Returns
Object
JSON object
create
▸ create(properties?): ConnectivityRuleSpec
Creates a new ConnectivityRuleSpec instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IConnectivityRuleSpec | Properties to set |
Returns
ConnectivityRuleSpec instance
decode
▸ decode(reader, length?): ConnectivityRuleSpec
Decodes a ConnectivityRuleSpec 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
ConnectivityRuleSpec
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): ConnectivityRuleSpec
Decodes a ConnectivityRuleSpec message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
ConnectivityRuleSpec
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 ConnectivityRuleSpec message. Does not implicitly temporal.api.cloud.connectivityrule.v1.ConnectivityRuleSpec.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IConnectivityRuleSpec | ConnectivityRuleSpec message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified ConnectivityRuleSpec message, length delimited. Does not implicitly temporal.api.cloud.connectivityrule.v1.ConnectivityRuleSpec.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IConnectivityRuleSpec | ConnectivityRuleSpec message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): ConnectivityRuleSpec
Creates a ConnectivityRuleSpec message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
ConnectivityRuleSpec
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for ConnectivityRuleSpec
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 ConnectivityRuleSpec message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | ConnectivityRuleSpec | ConnectivityRuleSpec |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object