- 1.58.0 (latest)
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.1
- 1.11.0
- 1.9.1
- 1.8.1
- 1.7.2
- 1.6.0-beta
public final class NodeGroup extends GeneratedMessageV3 implements NodeGroupOrBuilder
Represents a sole-tenant Node Group resource. A sole-tenant node is a physical server that is dedicated to hosting VM instances only for your specific project. Use sole-tenant nodes to keep your instances physically separated from instances in other projects, or to group your instances together on the same host hardware. For more information, read Sole-tenant nodes.
Protobuf type google.cloud.compute.v1.NodeGroup
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > NodeGroupImplements
NodeGroupOrBuilderStatic Fields
AUTOSCALING_POLICY_FIELD_NUMBER
public static final int AUTOSCALING_POLICY_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
CREATION_TIMESTAMP_FIELD_NUMBER
public static final int CREATION_TIMESTAMP_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
FINGERPRINT_FIELD_NUMBER
public static final int FINGERPRINT_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
ID_FIELD_NUMBER
public static final int ID_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
KIND_FIELD_NUMBER
public static final int KIND_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
LOCATION_HINT_FIELD_NUMBER
public static final int LOCATION_HINT_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
MAINTENANCE_POLICY_FIELD_NUMBER
public static final int MAINTENANCE_POLICY_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
MAINTENANCE_WINDOW_FIELD_NUMBER
public static final int MAINTENANCE_WINDOW_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
NODE_TEMPLATE_FIELD_NUMBER
public static final int NODE_TEMPLATE_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
SELF_LINK_FIELD_NUMBER
public static final int SELF_LINK_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
SHARE_SETTINGS_FIELD_NUMBER
public static final int SHARE_SETTINGS_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
SIZE_FIELD_NUMBER
public static final int SIZE_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
STATUS_FIELD_NUMBER
public static final int STATUS_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
ZONE_FIELD_NUMBER
public static final int ZONE_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
Static Methods
getDefaultInstance()
public static NodeGroup getDefaultInstance()
Returns | |
---|---|
Type | Description |
NodeGroup |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
newBuilder()
public static NodeGroup.Builder newBuilder()
Returns | |
---|---|
Type | Description |
NodeGroup.Builder |
newBuilder(NodeGroup prototype)
public static NodeGroup.Builder newBuilder(NodeGroup prototype)
Parameter | |
---|---|
Name | Description |
prototype | NodeGroup |
Returns | |
---|---|
Type | Description |
NodeGroup.Builder |
parseDelimitedFrom(InputStream input)
public static NodeGroup parseDelimitedFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input | InputStream |
Returns | |
---|---|
Type | Description |
NodeGroup |
Exceptions | |
---|---|
Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static NodeGroup parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
NodeGroup |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(byte[] data)
public static NodeGroup parseFrom(byte[] data)
Parameter | |
---|---|
Name | Description |
data | byte[] |
Returns | |
---|---|
Type | Description |
NodeGroup |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static NodeGroup parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data | byte[] |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
NodeGroup |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static NodeGroup parseFrom(ByteString data)
Parameter | |
---|---|
Name | Description |
data | ByteString |
Returns | |
---|---|
Type | Description |
NodeGroup |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static NodeGroup parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data | ByteString |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
NodeGroup |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static NodeGroup parseFrom(CodedInputStream input)
Parameter | |
---|---|
Name | Description |
input | CodedInputStream |
Returns | |
---|---|
Type | Description |
NodeGroup |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static NodeGroup parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
NodeGroup |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input)
public static NodeGroup parseFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input | InputStream |
Returns | |
---|---|
Type | Description |
NodeGroup |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static NodeGroup parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
NodeGroup |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static NodeGroup parseFrom(ByteBuffer data)
Parameter | |
---|---|
Name | Description |
data | ByteBuffer |
Returns | |
---|---|
Type | Description |
NodeGroup |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static NodeGroup parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data | ByteBuffer |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
NodeGroup |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<NodeGroup> parser()
Returns | |
---|---|
Type | Description |
Parser<NodeGroup> |
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter | |
---|---|
Name | Description |
obj | Object |
Returns | |
---|---|
Type | Description |
boolean |
getAutoscalingPolicy()
public NodeGroupAutoscalingPolicy getAutoscalingPolicy()
Specifies how autoscaling should behave.
optional .google.cloud.compute.v1.NodeGroupAutoscalingPolicy autoscaling_policy = 221950041;
Returns | |
---|---|
Type | Description |
NodeGroupAutoscalingPolicy | The autoscalingPolicy. |
getAutoscalingPolicyOrBuilder()
public NodeGroupAutoscalingPolicyOrBuilder getAutoscalingPolicyOrBuilder()
Specifies how autoscaling should behave.
optional .google.cloud.compute.v1.NodeGroupAutoscalingPolicy autoscaling_policy = 221950041;
Returns | |
---|---|
Type | Description |
NodeGroupAutoscalingPolicyOrBuilder |
getCreationTimestamp()
public String getCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
Returns | |
---|---|
Type | Description |
String | The creationTimestamp. |
getCreationTimestampBytes()
public ByteString getCreationTimestampBytes()
[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for creationTimestamp. |
getDefaultInstanceForType()
public NodeGroup getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
NodeGroup |
getDescription()
public String getDescription()
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
Returns | |
---|---|
Type | Description |
String | The description. |
getDescriptionBytes()
public ByteString getDescriptionBytes()
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for description. |
getFingerprint()
public String getFingerprint()
optional string fingerprint = 234678500;
Returns | |
---|---|
Type | Description |
String | The fingerprint. |
getFingerprintBytes()
public ByteString getFingerprintBytes()
optional string fingerprint = 234678500;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for fingerprint. |
getId()
public long getId()
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;
Returns | |
---|---|
Type | Description |
long | The id. |
getKind()
public String getKind()
[Output Only] The type of the resource. Always compute#nodeGroup for node group.
optional string kind = 3292052;
Returns | |
---|---|
Type | Description |
String | The kind. |
getKindBytes()
public ByteString getKindBytes()
[Output Only] The type of the resource. Always compute#nodeGroup for node group.
optional string kind = 3292052;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for kind. |
getLocationHint()
public String getLocationHint()
An opaque location hint used to place the Node close to other resources. This field is for use by internal tools that use the public API. The location hint here on the NodeGroup overrides any location_hint present in the NodeTemplate.
optional string location_hint = 350519505;
Returns | |
---|---|
Type | Description |
String | The locationHint. |
getLocationHintBytes()
public ByteString getLocationHintBytes()
An opaque location hint used to place the Node close to other resources. This field is for use by internal tools that use the public API. The location hint here on the NodeGroup overrides any location_hint present in the NodeTemplate.
optional string location_hint = 350519505;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for locationHint. |
getMaintenancePolicy()
public String getMaintenancePolicy()
Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT. For more information, see Maintenance policies. Check the MaintenancePolicy enum for the list of possible values.
optional string maintenance_policy = 528327646;
Returns | |
---|---|
Type | Description |
String | The maintenancePolicy. |
getMaintenancePolicyBytes()
public ByteString getMaintenancePolicyBytes()
Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT. For more information, see Maintenance policies. Check the MaintenancePolicy enum for the list of possible values.
optional string maintenance_policy = 528327646;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for maintenancePolicy. |
getMaintenanceWindow()
public NodeGroupMaintenanceWindow getMaintenanceWindow()
optional .google.cloud.compute.v1.NodeGroupMaintenanceWindow maintenance_window = 186374812;
Returns | |
---|---|
Type | Description |
NodeGroupMaintenanceWindow | The maintenanceWindow. |
getMaintenanceWindowOrBuilder()
public NodeGroupMaintenanceWindowOrBuilder getMaintenanceWindowOrBuilder()
optional .google.cloud.compute.v1.NodeGroupMaintenanceWindow maintenance_window = 186374812;
Returns | |
---|---|
Type | Description |
NodeGroupMaintenanceWindowOrBuilder |
getName()
public String getName()
The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z?
which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
optional string name = 3373707;
Returns | |
---|---|
Type | Description |
String | The name. |
getNameBytes()
public ByteString getNameBytes()
The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z?
which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
optional string name = 3373707;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for name. |
getNodeTemplate()
public String getNodeTemplate()
URL of the node template to create the node group from.
optional string node_template = 323154455;
Returns | |
---|---|
Type | Description |
String | The nodeTemplate. |
getNodeTemplateBytes()
public ByteString getNodeTemplateBytes()
URL of the node template to create the node group from.
optional string node_template = 323154455;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for nodeTemplate. |
getParserForType()
public Parser<NodeGroup> getParserForType()
Returns | |
---|---|
Type | Description |
Parser<NodeGroup> |
getSelfLink()
public String getSelfLink()
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
Returns | |
---|---|
Type | Description |
String | The selfLink. |
getSelfLinkBytes()
public ByteString getSelfLinkBytes()
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for selfLink. |
getSerializedSize()
public int getSerializedSize()
Returns | |
---|---|
Type | Description |
int |
getShareSettings()
public ShareSettings getShareSettings()
Share-settings for the node group
optional .google.cloud.compute.v1.ShareSettings share_settings = 266668163;
Returns | |
---|---|
Type | Description |
ShareSettings | The shareSettings. |
getShareSettingsOrBuilder()
public ShareSettingsOrBuilder getShareSettingsOrBuilder()
Share-settings for the node group
optional .google.cloud.compute.v1.ShareSettings share_settings = 266668163;
Returns | |
---|---|
Type | Description |
ShareSettingsOrBuilder |
getSize()
public int getSize()
[Output Only] The total number of nodes in the node group.
optional int32 size = 3530753;
Returns | |
---|---|
Type | Description |
int | The size. |
getStatus()
public String getStatus()
Check the Status enum for the list of possible values.
optional string status = 181260274;
Returns | |
---|---|
Type | Description |
String | The status. |
getStatusBytes()
public ByteString getStatusBytes()
Check the Status enum for the list of possible values.
optional string status = 181260274;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for status. |
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns | |
---|---|
Type | Description |
UnknownFieldSet |
getZone()
public String getZone()
[Output Only] The name of the zone where the node group resides, such as us-central1-a.
optional string zone = 3744684;
Returns | |
---|---|
Type | Description |
String | The zone. |
getZoneBytes()
public ByteString getZoneBytes()
[Output Only] The name of the zone where the node group resides, such as us-central1-a.
optional string zone = 3744684;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for zone. |
hasAutoscalingPolicy()
public boolean hasAutoscalingPolicy()
Specifies how autoscaling should behave.
optional .google.cloud.compute.v1.NodeGroupAutoscalingPolicy autoscaling_policy = 221950041;
Returns | |
---|---|
Type | Description |
boolean | Whether the autoscalingPolicy field is set. |
hasCreationTimestamp()
public boolean hasCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
Returns | |
---|---|
Type | Description |
boolean | Whether the creationTimestamp field is set. |
hasDescription()
public boolean hasDescription()
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
Returns | |
---|---|
Type | Description |
boolean | Whether the description field is set. |
hasFingerprint()
public boolean hasFingerprint()
optional string fingerprint = 234678500;
Returns | |
---|---|
Type | Description |
boolean | Whether the fingerprint field is set. |
hasId()
public boolean hasId()
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;
Returns | |
---|---|
Type | Description |
boolean | Whether the id field is set. |
hasKind()
public boolean hasKind()
[Output Only] The type of the resource. Always compute#nodeGroup for node group.
optional string kind = 3292052;
Returns | |
---|---|
Type | Description |
boolean | Whether the kind field is set. |
hasLocationHint()
public boolean hasLocationHint()
An opaque location hint used to place the Node close to other resources. This field is for use by internal tools that use the public API. The location hint here on the NodeGroup overrides any location_hint present in the NodeTemplate.
optional string location_hint = 350519505;
Returns | |
---|---|
Type | Description |
boolean | Whether the locationHint field is set. |
hasMaintenancePolicy()
public boolean hasMaintenancePolicy()
Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT. For more information, see Maintenance policies. Check the MaintenancePolicy enum for the list of possible values.
optional string maintenance_policy = 528327646;
Returns | |
---|---|
Type | Description |
boolean | Whether the maintenancePolicy field is set. |
hasMaintenanceWindow()
public boolean hasMaintenanceWindow()
optional .google.cloud.compute.v1.NodeGroupMaintenanceWindow maintenance_window = 186374812;
Returns | |
---|---|
Type | Description |
boolean | Whether the maintenanceWindow field is set. |
hasName()
public boolean hasName()
The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z?
which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
optional string name = 3373707;
Returns | |
---|---|
Type | Description |
boolean | Whether the name field is set. |
hasNodeTemplate()
public boolean hasNodeTemplate()
URL of the node template to create the node group from.
optional string node_template = 323154455;
Returns | |
---|---|
Type | Description |
boolean | Whether the nodeTemplate field is set. |
hasSelfLink()
public boolean hasSelfLink()
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
Returns | |
---|---|
Type | Description |
boolean | Whether the selfLink field is set. |
hasShareSettings()
public boolean hasShareSettings()
Share-settings for the node group
optional .google.cloud.compute.v1.ShareSettings share_settings = 266668163;
Returns | |
---|---|
Type | Description |
boolean | Whether the shareSettings field is set. |
hasSize()
public boolean hasSize()
[Output Only] The total number of nodes in the node group.
optional int32 size = 3530753;
Returns | |
---|---|
Type | Description |
boolean | Whether the size field is set. |
hasStatus()
public boolean hasStatus()
Check the Status enum for the list of possible values.
optional string status = 181260274;
Returns | |
---|---|
Type | Description |
boolean | Whether the status field is set. |
hasZone()
public boolean hasZone()
[Output Only] The name of the zone where the node group resides, such as us-central1-a.
optional string zone = 3744684;
Returns | |
---|---|
Type | Description |
boolean | Whether the zone field is set. |
hashCode()
public int hashCode()
Returns | |
---|---|
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
newBuilderForType()
public NodeGroup.Builder newBuilderForType()
Returns | |
---|---|
Type | Description |
NodeGroup.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected NodeGroup.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter | |
---|---|
Name | Description |
parent | BuilderParent |
Returns | |
---|---|
Type | Description |
NodeGroup.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter | |
---|---|
Name | Description |
unused | UnusedPrivateParameter |
Returns | |
---|---|
Type | Description |
Object |
toBuilder()
public NodeGroup.Builder toBuilder()
Returns | |
---|---|
Type | Description |
NodeGroup.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter | |
---|---|
Name | Description |
output | CodedOutputStream |
Exceptions | |
---|---|
Type | Description |
IOException |