Represents a Cluster.
Package
@google-cloud/dataproc!Constructors
(constructor)(properties)
constructor(properties?: google.cloud.dataproc.v1beta2.ICluster);Constructs a new Cluster.
| Type | Name | Description |
|---|---|---|
| ICluster | properties |
Properties to set |
Properties
clusterName
public clusterName: string;Cluster clusterName.
| Type | Description |
|---|---|
| string |
clusterUuid
public clusterUuid: string;Cluster clusterUuid.
| Type | Description |
|---|---|
| string |
config
public config?: (google.cloud.dataproc.v1beta2.IClusterConfig|null);Cluster config.
| Type | Description |
|---|---|
| (google.cloud.dataproc.v1beta2.IClusterConfig|null) |
labels
public labels: { [k: string]: string };Cluster labels.
| Type | Description |
|---|---|
| { [k: string]: string } |
metrics
public metrics?: (google.cloud.dataproc.v1beta2.IClusterMetrics|null);Cluster metrics.
| Type | Description |
|---|---|
| (google.cloud.dataproc.v1beta2.IClusterMetrics|null) |
projectId
public projectId: string;Cluster projectId.
| Type | Description |
|---|---|
| string |
status
public status?: (google.cloud.dataproc.v1beta2.IClusterStatus|null);Cluster status.
| Type | Description |
|---|---|
| (google.cloud.dataproc.v1beta2.IClusterStatus|null) |
statusHistory
public statusHistory: google.cloud.dataproc.v1beta2.IClusterStatus[];Cluster statusHistory.
| Type | Description |
|---|---|
| google.cloud.dataproc.v1beta2.IClusterStatus[] |
Methods
create(properties)
public static create(properties?: google.cloud.dataproc.v1beta2.ICluster): google.cloud.dataproc.v1beta2.Cluster;Creates a new Cluster instance using the specified properties.
| Type | Name | Description |
|---|---|---|
| ICluster | properties |
Properties to set |
| Type | Description |
|---|---|
| google.cloud.dataproc.v1beta2.Cluster | Cluster instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.dataproc.v1beta2.Cluster;Decodes a Cluster message from the specified reader or buffer.
| Type | Name | Description |
|---|---|---|
| ($protobuf.Reader|Uint8Array) | reader |
Reader or buffer to decode from |
| number | length |
Message length if known beforehand |
| Type | Description |
|---|---|
| google.cloud.dataproc.v1beta2.Cluster | Cluster |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.dataproc.v1beta2.Cluster;Decodes a Cluster message from the specified reader or buffer, length delimited.
| Type | Name | Description |
|---|---|---|
| ($protobuf.Reader|Uint8Array) | reader |
Reader or buffer to decode from |
| Type | Description |
|---|---|
| google.cloud.dataproc.v1beta2.Cluster | Cluster |
encode(message, writer)
public static encode(message: google.cloud.dataproc.v1beta2.ICluster, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Cluster message. Does not implicitly messages.
| Type | Name | Description |
|---|---|---|
| ICluster | message |
Cluster message or plain object to encode |
| $protobuf.Writer | writer |
Writer to encode to |
| Type | Description |
|---|---|
| $protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.dataproc.v1beta2.ICluster, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Cluster message, length delimited. Does not implicitly messages.
| Type | Name | Description |
|---|---|---|
| ICluster | message |
Cluster message or plain object to encode |
| $protobuf.Writer | writer |
Writer to encode to |
| Type | Description |
|---|---|
| $protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.dataproc.v1beta2.Cluster;Creates a Cluster message from a plain object. Also converts values to their respective internal types.
| Type | Name | Description |
|---|---|---|
| { [k: string]: any } | object |
Plain object |
| Type | Description |
|---|---|
| google.cloud.dataproc.v1beta2.Cluster | Cluster |
toJSON()
public toJSON(): { [k: string]: any };Converts this Cluster to JSON.
| Type | Description |
|---|---|
| { [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.dataproc.v1beta2.Cluster, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a Cluster message. Also converts values to other types if specified.
| Type | Name | Description |
|---|---|---|
| google.cloud.dataproc.v1beta2.Cluster | message |
Cluster |
| $protobuf.IConversionOptions | options |
Conversion options |
| Type | Description |
|---|---|
| { [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a Cluster message.
| Type | Name | Description |
|---|---|---|
| { [k: string]: any } | message |
Plain object to verify |
| Type | Description |
|---|---|
| (string|null) |
|