Class LocalDiskInitializeParams (1.43.0)

public final class LocalDiskInitializeParams extends GeneratedMessageV3 implements LocalDiskInitializeParamsOrBuilder

Input only. Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new runtime. This property is mutually exclusive with the source property; you can only define one or the other, but not both.

Protobuf type google.cloud.notebooks.v1.LocalDiskInitializeParams

Static Fields

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

DISK_NAME_FIELD_NUMBER

public static final int DISK_NAME_FIELD_NUMBER
Field Value
Type Description
int

DISK_SIZE_GB_FIELD_NUMBER

public static final int DISK_SIZE_GB_FIELD_NUMBER
Field Value
Type Description
int

DISK_TYPE_FIELD_NUMBER

public static final int DISK_TYPE_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static LocalDiskInitializeParams getDefaultInstance()
Returns
Type Description
LocalDiskInitializeParams

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static LocalDiskInitializeParams.Builder newBuilder()
Returns
Type Description
LocalDiskInitializeParams.Builder

newBuilder(LocalDiskInitializeParams prototype)

public static LocalDiskInitializeParams.Builder newBuilder(LocalDiskInitializeParams prototype)
Parameter
Name Description
prototype LocalDiskInitializeParams
Returns
Type Description
LocalDiskInitializeParams.Builder

parseDelimitedFrom(InputStream input)

public static LocalDiskInitializeParams parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
LocalDiskInitializeParams
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static LocalDiskInitializeParams parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LocalDiskInitializeParams
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static LocalDiskInitializeParams parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
LocalDiskInitializeParams
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static LocalDiskInitializeParams parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LocalDiskInitializeParams
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static LocalDiskInitializeParams parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
LocalDiskInitializeParams
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static LocalDiskInitializeParams parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LocalDiskInitializeParams
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static LocalDiskInitializeParams parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
LocalDiskInitializeParams
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static LocalDiskInitializeParams parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LocalDiskInitializeParams
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static LocalDiskInitializeParams parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
LocalDiskInitializeParams
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static LocalDiskInitializeParams parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LocalDiskInitializeParams
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static LocalDiskInitializeParams parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
LocalDiskInitializeParams
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static LocalDiskInitializeParams parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LocalDiskInitializeParams
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<LocalDiskInitializeParams> parser()
Returns
Type Description
Parser<LocalDiskInitializeParams>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Optional. Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public LocalDiskInitializeParams getDefaultInstanceForType()
Returns
Type Description
LocalDiskInitializeParams

getDescription()

public String getDescription()

Optional. Provide this property when creating the disk.

string description = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. Provide this property when creating the disk.

string description = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getDiskName()

public String getDiskName()

Optional. Specifies the disk name. If not specified, the default is to use the name of the instance. If the disk with the instance name exists already in the given zone/region, a new name will be automatically generated.

string disk_name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The diskName.

getDiskNameBytes()

public ByteString getDiskNameBytes()

Optional. Specifies the disk name. If not specified, the default is to use the name of the instance. If the disk with the instance name exists already in the given zone/region, a new name will be automatically generated.

string disk_name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for diskName.

getDiskSizeGb()

public long getDiskSizeGb()

Optional. Specifies the size of the disk in base-2 GB. If not specified, the disk will be the same size as the image (usually 10GB). If specified, the size must be equal to or larger than 10GB. Default 100 GB.

int64 disk_size_gb = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The diskSizeGb.

getDiskType()

public LocalDiskInitializeParams.DiskType getDiskType()

Input only. The type of the boot disk attached to this instance, defaults to standard persistent disk (PD_STANDARD).

.google.cloud.notebooks.v1.LocalDiskInitializeParams.DiskType disk_type = 4 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
LocalDiskInitializeParams.DiskType

The diskType.

getDiskTypeValue()

public int getDiskTypeValue()

Input only. The type of the boot disk attached to this instance, defaults to standard persistent disk (PD_STANDARD).

.google.cloud.notebooks.v1.LocalDiskInitializeParams.DiskType disk_type = 4 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for diskType.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Optional. Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Optional. Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Optional. Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Optional. Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getParserForType()

public Parser<LocalDiskInitializeParams> getParserForType()
Returns
Type Description
Parser<LocalDiskInitializeParams>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public LocalDiskInitializeParams.Builder newBuilderForType()
Returns
Type Description
LocalDiskInitializeParams.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected LocalDiskInitializeParams.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
LocalDiskInitializeParams.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public LocalDiskInitializeParams.Builder toBuilder()
Returns
Type Description
LocalDiskInitializeParams.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException