Class protos.google.container.v1beta1.IPAllocationPolicy (5.1.0)

Represents a IPAllocationPolicy.

Package

@google-cloud/container

Constructors

(constructor)(properties)

constructor(properties?: google.container.v1beta1.IIPAllocationPolicy);

Constructs a new IPAllocationPolicy.

Parameter
Name Description
properties IIPAllocationPolicy

Properties to set

Properties

additionalPodRangesConfig

public additionalPodRangesConfig?: (google.container.v1beta1.IAdditionalPodRangesConfig|null);

IPAllocationPolicy additionalPodRangesConfig.

allowRouteOverlap

public allowRouteOverlap: boolean;

IPAllocationPolicy allowRouteOverlap.

clusterIpv4Cidr

public clusterIpv4Cidr: string;

IPAllocationPolicy clusterIpv4Cidr.

clusterIpv4CidrBlock

public clusterIpv4CidrBlock: string;

IPAllocationPolicy clusterIpv4CidrBlock.

clusterSecondaryRangeName

public clusterSecondaryRangeName: string;

IPAllocationPolicy clusterSecondaryRangeName.

createSubnetwork

public createSubnetwork: boolean;

IPAllocationPolicy createSubnetwork.

defaultPodIpv4RangeUtilization

public defaultPodIpv4RangeUtilization: number;

IPAllocationPolicy defaultPodIpv4RangeUtilization.

ipv6AccessType

public ipv6AccessType: (google.container.v1beta1.IPAllocationPolicy.IPv6AccessType|keyof typeof google.container.v1beta1.IPAllocationPolicy.IPv6AccessType);

IPAllocationPolicy ipv6AccessType.

nodeIpv4Cidr

public nodeIpv4Cidr: string;

IPAllocationPolicy nodeIpv4Cidr.

nodeIpv4CidrBlock

public nodeIpv4CidrBlock: string;

IPAllocationPolicy nodeIpv4CidrBlock.

podCidrOverprovisionConfig

public podCidrOverprovisionConfig?: (google.container.v1beta1.IPodCIDROverprovisionConfig|null);

IPAllocationPolicy podCidrOverprovisionConfig.

servicesIpv4Cidr

public servicesIpv4Cidr: string;

IPAllocationPolicy servicesIpv4Cidr.

servicesIpv4CidrBlock

public servicesIpv4CidrBlock: string;

IPAllocationPolicy servicesIpv4CidrBlock.

servicesIpv6CidrBlock

public servicesIpv6CidrBlock: string;

IPAllocationPolicy servicesIpv6CidrBlock.

servicesSecondaryRangeName

public servicesSecondaryRangeName: string;

IPAllocationPolicy servicesSecondaryRangeName.

stackType

public stackType: (google.container.v1beta1.IPAllocationPolicy.StackType|keyof typeof google.container.v1beta1.IPAllocationPolicy.StackType);

IPAllocationPolicy stackType.

subnetIpv6CidrBlock

public subnetIpv6CidrBlock: string;

IPAllocationPolicy subnetIpv6CidrBlock.

subnetworkName

public subnetworkName: string;

IPAllocationPolicy subnetworkName.

tpuIpv4CidrBlock

public tpuIpv4CidrBlock: string;

IPAllocationPolicy tpuIpv4CidrBlock.

useIpAliases

public useIpAliases: boolean;

IPAllocationPolicy useIpAliases.

useRoutes

public useRoutes: boolean;

IPAllocationPolicy useRoutes.

Methods

create(properties)

public static create(properties?: google.container.v1beta1.IIPAllocationPolicy): google.container.v1beta1.IPAllocationPolicy;

Creates a new IPAllocationPolicy instance using the specified properties.

Parameter
Name Description
properties IIPAllocationPolicy

Properties to set
Returns
Type Description
IPAllocationPolicy

IPAllocationPolicy instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.container.v1beta1.IPAllocationPolicy;

Decodes a IPAllocationPolicy 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
IPAllocationPolicy

IPAllocationPolicy

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.container.v1beta1.IPAllocationPolicy;

Decodes a IPAllocationPolicy message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from
Returns
Type Description
IPAllocationPolicy

IPAllocationPolicy

encode(message, writer)

public static encode(message: google.container.v1beta1.IIPAllocationPolicy, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified IPAllocationPolicy message. Does not implicitly messages.

Parameters
Name Description
message IIPAllocationPolicy

IPAllocationPolicy 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.container.v1beta1.IIPAllocationPolicy, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified IPAllocationPolicy message, length delimited. Does not implicitly messages.

Parameters
Name Description
message IIPAllocationPolicy

IPAllocationPolicy 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.container.v1beta1.IPAllocationPolicy;

Creates a IPAllocationPolicy 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
IPAllocationPolicy

IPAllocationPolicy

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for IPAllocationPolicy

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 IPAllocationPolicy to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.container.v1beta1.IPAllocationPolicy, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a IPAllocationPolicy message. Also converts values to other types if specified.

Parameters
Name Description
message IPAllocationPolicy

IPAllocationPolicy
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 IPAllocationPolicy message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify
Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not