Represents an InternalRange.
Package
@google-cloud/network-connectivityConstructors
(constructor)(properties)
constructor(properties?: google.cloud.networkconnectivity.v1.IInternalRange);Constructs a new InternalRange.
| Parameter | |
|---|---|
| Name | Description |
properties |
IInternalRange
Properties to set |
Properties
allocationOptions
public allocationOptions?: (google.cloud.networkconnectivity.v1.InternalRange.IAllocationOptions|null);InternalRange allocationOptions.
createTime
public createTime?: (google.protobuf.ITimestamp|null);InternalRange createTime.
description
public description: string;InternalRange description.
excludeCidrRanges
public excludeCidrRanges: string[];InternalRange excludeCidrRanges.
immutable
public immutable: boolean;InternalRange immutable.
ipCidrRange
public ipCidrRange: string;InternalRange ipCidrRange.
labels
public labels: { [k: string]: string };InternalRange labels.
migration
public migration?: (google.cloud.networkconnectivity.v1.InternalRange.IMigration|null);InternalRange migration.
name
public name: string;InternalRange name.
network
public network: string;InternalRange network.
overlaps
public overlaps: google.cloud.networkconnectivity.v1.InternalRange.Overlap[];InternalRange overlaps.
peering
public peering: (google.cloud.networkconnectivity.v1.InternalRange.Peering|keyof typeof google.cloud.networkconnectivity.v1.InternalRange.Peering);InternalRange peering.
prefixLength
public prefixLength: number;InternalRange prefixLength.
targetCidrRange
public targetCidrRange: string[];InternalRange targetCidrRange.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);InternalRange updateTime.
usage
public usage: (google.cloud.networkconnectivity.v1.InternalRange.Usage|keyof typeof google.cloud.networkconnectivity.v1.InternalRange.Usage);InternalRange usage.
users
public users: string[];InternalRange users.
Methods
create(properties)
public static create(properties?: google.cloud.networkconnectivity.v1.IInternalRange): google.cloud.networkconnectivity.v1.InternalRange;Creates a new InternalRange instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IInternalRange
Properties to set |
| Returns | |
|---|---|
| Type | Description |
InternalRange |
InternalRange instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.networkconnectivity.v1.InternalRange;Decodes an InternalRange 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 |
InternalRange |
InternalRange |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.networkconnectivity.v1.InternalRange;Decodes an InternalRange message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
InternalRange |
InternalRange |
encode(message, writer)
public static encode(message: google.cloud.networkconnectivity.v1.IInternalRange, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified InternalRange message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IInternalRange
InternalRange 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.IInternalRange, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified InternalRange message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IInternalRange
InternalRange 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.InternalRange;Creates an InternalRange 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 |
InternalRange |
InternalRange |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for InternalRange
| 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 InternalRange to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.networkconnectivity.v1.InternalRange, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from an InternalRange message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
InternalRange
InternalRange |
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 an InternalRange message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|