Represents a NodePool.
Package
@google-cloud/containerConstructors
(constructor)(properties)
constructor(properties?: google.container.v1.INodePool);
Constructs a new NodePool.
Parameter | |
---|---|
Name | Description |
properties |
INodePool
Properties to set |
Properties
autoscaling
public autoscaling?: (google.container.v1.INodePoolAutoscaling|null);
NodePool autoscaling.
bestEffortProvisioning
public bestEffortProvisioning?: (google.container.v1.IBestEffortProvisioning|null);
NodePool bestEffortProvisioning.
conditions
public conditions: google.container.v1.IStatusCondition[];
NodePool conditions.
config
public config?: (google.container.v1.INodeConfig|null);
NodePool config.
etag
public etag: string;
NodePool etag.
initialNodeCount
public initialNodeCount: number;
NodePool initialNodeCount.
instanceGroupUrls
public instanceGroupUrls: string[];
NodePool instanceGroupUrls.
locations
public locations: string[];
NodePool locations.
management
public management?: (google.container.v1.INodeManagement|null);
NodePool management.
maxPodsConstraint
public maxPodsConstraint?: (google.container.v1.IMaxPodsConstraint|null);
NodePool maxPodsConstraint.
name
public name: string;
NodePool name.
networkConfig
public networkConfig?: (google.container.v1.INodeNetworkConfig|null);
NodePool networkConfig.
placementPolicy
public placementPolicy?: (google.container.v1.NodePool.IPlacementPolicy|null);
NodePool placementPolicy.
podIpv4CidrSize
public podIpv4CidrSize: number;
NodePool podIpv4CidrSize.
selfLink
public selfLink: string;
NodePool selfLink.
status
public status: (google.container.v1.NodePool.Status|keyof typeof google.container.v1.NodePool.Status);
NodePool status.
statusMessage
public statusMessage: string;
NodePool statusMessage.
updateInfo
public updateInfo?: (google.container.v1.NodePool.IUpdateInfo|null);
NodePool updateInfo.
upgradeSettings
public upgradeSettings?: (google.container.v1.NodePool.IUpgradeSettings|null);
NodePool upgradeSettings.
version
public version: string;
NodePool version.
Methods
create(properties)
public static create(properties?: google.container.v1.INodePool): google.container.v1.NodePool;
Creates a new NodePool instance using the specified properties.
Parameter | |
---|---|
Name | Description |
properties |
INodePool
Properties to set |
Returns | |
---|---|
Type | Description |
NodePool | NodePool instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.container.v1.NodePool;
Decodes a NodePool 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 |
NodePool | NodePool |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.container.v1.NodePool;
Decodes a NodePool message from the specified reader or buffer, length delimited.
Parameter | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
Returns | |
---|---|
Type | Description |
NodePool | NodePool |
encode(message, writer)
public static encode(message: google.container.v1.INodePool, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified NodePool message. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
INodePool
NodePool 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.v1.INodePool, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified NodePool message, length delimited. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
INodePool
NodePool 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.v1.NodePool;
Creates a NodePool 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 |
NodePool | NodePool |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;
Gets the default type url for NodePool
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 NodePool to JSON.
Returns | |
---|---|
Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.container.v1.NodePool, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from a NodePool message. Also converts values to other types if specified.
Parameters | |
---|---|
Name | Description |
message |
NodePool
NodePool |
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 NodePool message.
Parameter | |
---|---|
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Returns | |
---|---|
Type | Description |
(string|null) |
|