Represents a PscConnection.
Package
@google-cloud/network-connectivityConstructors
(constructor)(properties)
constructor(properties?: google.cloud.networkconnectivity.v1.ServiceConnectionPolicy.IPscConnection);Constructs a new PscConnection.
| Parameter | |
|---|---|
| Name | Description |
properties |
IPscConnection
Properties to set |
Properties
consumerAddress
public consumerAddress: string;PscConnection consumerAddress.
consumerForwardingRule
public consumerForwardingRule: string;PscConnection consumerForwardingRule.
consumerTargetProject
public consumerTargetProject: string;PscConnection consumerTargetProject.
error
public error?: (google.rpc.IStatus|null);PscConnection error.
errorInfo
public errorInfo?: (google.rpc.IErrorInfo|null);PscConnection errorInfo.
errorType
public errorType: (google.cloud.networkconnectivity.v1.ConnectionErrorType|keyof typeof google.cloud.networkconnectivity.v1.ConnectionErrorType);PscConnection errorType.
gceOperation
public gceOperation: string;PscConnection gceOperation.
ipVersion
public ipVersion?: (google.cloud.networkconnectivity.v1.IPVersion|keyof typeof google.cloud.networkconnectivity.v1.IPVersion|null);PscConnection ipVersion.
producerInstanceId
public producerInstanceId: string;PscConnection producerInstanceId.
producerInstanceMetadata
public producerInstanceMetadata: { [k: string]: string };PscConnection producerInstanceMetadata.
pscConnectionId
public pscConnectionId: string;PscConnection pscConnectionId.
selectedSubnetwork
public selectedSubnetwork: string;PscConnection selectedSubnetwork.
serviceClass
public serviceClass: string;PscConnection serviceClass.
state
public state: (google.cloud.networkconnectivity.v1.ServiceConnectionPolicy.State|keyof typeof google.cloud.networkconnectivity.v1.ServiceConnectionPolicy.State);PscConnection state.
Methods
create(properties)
public static create(properties?: google.cloud.networkconnectivity.v1.ServiceConnectionPolicy.IPscConnection): google.cloud.networkconnectivity.v1.ServiceConnectionPolicy.PscConnection;Creates a new PscConnection instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IPscConnection
Properties to set |
| Returns | |
|---|---|
| Type | Description |
PscConnection |
PscConnection instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.networkconnectivity.v1.ServiceConnectionPolicy.PscConnection;Decodes a PscConnection message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
PscConnection |
PscConnection |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.networkconnectivity.v1.ServiceConnectionPolicy.PscConnection;Decodes a PscConnection message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
PscConnection |
PscConnection |
encode(message, writer)
public static encode(message: google.cloud.networkconnectivity.v1.ServiceConnectionPolicy.IPscConnection, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified PscConnection message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IPscConnection
PscConnection message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.networkconnectivity.v1.ServiceConnectionPolicy.IPscConnection, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified PscConnection message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IPscConnection
PscConnection message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.networkconnectivity.v1.ServiceConnectionPolicy.PscConnection;Creates a PscConnection message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
PscConnection |
PscConnection |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for PscConnection
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this PscConnection to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.networkconnectivity.v1.ServiceConnectionPolicy.PscConnection, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a PscConnection message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
PscConnection
PscConnection |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a PscConnection message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|