Represents a Connector.
Package
@google-cloud/vpc-accessConstructors
(constructor)(properties)
constructor(properties?: google.cloud.vpcaccess.v1.IConnector);
Constructs a new Connector.
Parameter | |
---|---|
Name | Description |
properties |
IConnector
Properties to set |
Properties
connectedProjects
public connectedProjects: string[];
Connector connectedProjects.
ipCidrRange
public ipCidrRange: string;
Connector ipCidrRange.
machineType
public machineType: string;
Connector machineType.
maxInstances
public maxInstances: number;
Connector maxInstances.
maxThroughput
public maxThroughput: number;
Connector maxThroughput.
minInstances
public minInstances: number;
Connector minInstances.
minThroughput
public minThroughput: number;
Connector minThroughput.
name
public name: string;
Connector name.
network
public network: string;
Connector network.
state
public state: (google.cloud.vpcaccess.v1.Connector.State|keyof typeof google.cloud.vpcaccess.v1.Connector.State);
Connector state.
subnet
public subnet?: (google.cloud.vpcaccess.v1.Connector.ISubnet|null);
Connector subnet.
Methods
create(properties)
public static create(properties?: google.cloud.vpcaccess.v1.IConnector): google.cloud.vpcaccess.v1.Connector;
Creates a new Connector instance using the specified properties.
Parameter | |
---|---|
Name | Description |
properties |
IConnector
Properties to set |
Returns | |
---|---|
Type | Description |
Connector | Connector instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.vpcaccess.v1.Connector;
Decodes a Connector 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 |
Connector | Connector |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.vpcaccess.v1.Connector;
Decodes a Connector message from the specified reader or buffer, length delimited.
Parameter | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
Returns | |
---|---|
Type | Description |
Connector | Connector |
encode(message, writer)
public static encode(message: google.cloud.vpcaccess.v1.IConnector, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified Connector message. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IConnector
Connector 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.vpcaccess.v1.IConnector, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified Connector message, length delimited. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IConnector
Connector 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.vpcaccess.v1.Connector;
Creates a Connector 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 |
Connector | Connector |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;
Gets the default type url for Connector
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 Connector to JSON.
Returns | |
---|---|
Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.vpcaccess.v1.Connector, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from a Connector message. Also converts values to other types if specified.
Parameters | |
---|---|
Name | Description |
message |
Connector
Connector |
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 Connector message.
Parameter | |
---|---|
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Returns | |
---|---|
Type | Description |
(string|null) |
|