com.google.cloud.notebooks.v1.LocalDiskOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-notebooks-v1 Show documentation
Show all versions of proto-google-cloud-notebooks-v1 Show documentation
Proto library for google-cloud-notebooks
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/notebooks/v1/runtime.proto
// Protobuf Java Version: 3.25.3
package com.google.cloud.notebooks.v1;
public interface LocalDiskOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.notebooks.v1.LocalDisk)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Optional. Output only. Specifies whether the disk will be auto-deleted when the
* instance is deleted (but not when the disk is detached from the instance).
*
*
* bool auto_delete = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The autoDelete.
*/
boolean getAutoDelete();
/**
*
*
*
* Optional. Output only. Indicates that this is a boot disk. The virtual machine
* will use the first partition of the disk for its root filesystem.
*
*
* bool boot = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The boot.
*/
boolean getBoot();
/**
*
*
*
* Optional. Output only. Specifies a unique device name
* of your choice that is reflected into the
* `/dev/disk/by-id/google-*` tree of a Linux operating system running within
* the instance. This name can be used to reference the device for mounting,
* resizing, and so on, from within the instance.
*
* If not specified, the server chooses a default device name to apply to this
* disk, in the form persistent-disk-x, where x is a number assigned by Google
* Compute Engine. This field is only applicable for persistent disks.
*
*
* string device_name = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The deviceName.
*/
java.lang.String getDeviceName();
/**
*
*
*
* Optional. Output only. Specifies a unique device name
* of your choice that is reflected into the
* `/dev/disk/by-id/google-*` tree of a Linux operating system running within
* the instance. This name can be used to reference the device for mounting,
* resizing, and so on, from within the instance.
*
* If not specified, the server chooses a default device name to apply to this
* disk, in the form persistent-disk-x, where x is a number assigned by Google
* Compute Engine. This field is only applicable for persistent disks.
*
*
* string device_name = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The bytes for deviceName.
*/
com.google.protobuf.ByteString getDeviceNameBytes();
/**
*
*
*
* Output only. Indicates a list of features to enable on the guest operating system.
* Applicable only for bootable images. Read Enabling guest operating
* system features to see a list of available options.
*
*
*
* repeated .google.cloud.notebooks.v1.LocalDisk.RuntimeGuestOsFeature guest_os_features = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
java.util.List
getGuestOsFeaturesList();
/**
*
*
*
* Output only. Indicates a list of features to enable on the guest operating system.
* Applicable only for bootable images. Read Enabling guest operating
* system features to see a list of available options.
*
*
*
* repeated .google.cloud.notebooks.v1.LocalDisk.RuntimeGuestOsFeature guest_os_features = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.cloud.notebooks.v1.LocalDisk.RuntimeGuestOsFeature getGuestOsFeatures(int index);
/**
*
*
*
* Output only. Indicates a list of features to enable on the guest operating system.
* Applicable only for bootable images. Read Enabling guest operating
* system features to see a list of available options.
*
*
*
* repeated .google.cloud.notebooks.v1.LocalDisk.RuntimeGuestOsFeature guest_os_features = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
int getGuestOsFeaturesCount();
/**
*
*
*
* Output only. Indicates a list of features to enable on the guest operating system.
* Applicable only for bootable images. Read Enabling guest operating
* system features to see a list of available options.
*
*
*
* repeated .google.cloud.notebooks.v1.LocalDisk.RuntimeGuestOsFeature guest_os_features = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
java.util.List
getGuestOsFeaturesOrBuilderList();
/**
*
*
*
* Output only. Indicates a list of features to enable on the guest operating system.
* Applicable only for bootable images. Read Enabling guest operating
* system features to see a list of available options.
*
*
*
* repeated .google.cloud.notebooks.v1.LocalDisk.RuntimeGuestOsFeature guest_os_features = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.cloud.notebooks.v1.LocalDisk.RuntimeGuestOsFeatureOrBuilder
getGuestOsFeaturesOrBuilder(int index);
/**
*
*
*
* Output only. A zero-based index to this disk, where 0 is reserved for the
* boot disk. If you have many disks attached to an instance, each disk would
* have a unique index number.
*
*
* int32 index = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The index.
*/
int getIndex();
/**
*
*
*
* 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 instance.
*
* This property is mutually exclusive with the source property; you can only
* define one or the other, but not both.
*
*
*
* .google.cloud.notebooks.v1.LocalDiskInitializeParams initialize_params = 6 [(.google.api.field_behavior) = INPUT_ONLY];
*
*
* @return Whether the initializeParams field is set.
*/
boolean hasInitializeParams();
/**
*
*
*
* 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 instance.
*
* This property is mutually exclusive with the source property; you can only
* define one or the other, but not both.
*
*
*
* .google.cloud.notebooks.v1.LocalDiskInitializeParams initialize_params = 6 [(.google.api.field_behavior) = INPUT_ONLY];
*
*
* @return The initializeParams.
*/
com.google.cloud.notebooks.v1.LocalDiskInitializeParams getInitializeParams();
/**
*
*
*
* 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 instance.
*
* This property is mutually exclusive with the source property; you can only
* define one or the other, but not both.
*
*
*
* .google.cloud.notebooks.v1.LocalDiskInitializeParams initialize_params = 6 [(.google.api.field_behavior) = INPUT_ONLY];
*
*/
com.google.cloud.notebooks.v1.LocalDiskInitializeParamsOrBuilder getInitializeParamsOrBuilder();
/**
*
*
*
* Specifies the disk interface to use for attaching this disk, which is
* either SCSI or NVME. The default is SCSI. Persistent disks must always use
* SCSI and the request will fail if you attempt to attach a persistent disk
* in any other format than SCSI. Local SSDs can use either NVME or SCSI. For
* performance characteristics of SCSI over NVMe, see Local SSD performance.
* Valid values:
*
* * `NVME`
* * `SCSI`
*
*
* string interface = 7;
*
* @return The interface.
*/
java.lang.String getInterface();
/**
*
*
*
* Specifies the disk interface to use for attaching this disk, which is
* either SCSI or NVME. The default is SCSI. Persistent disks must always use
* SCSI and the request will fail if you attempt to attach a persistent disk
* in any other format than SCSI. Local SSDs can use either NVME or SCSI. For
* performance characteristics of SCSI over NVMe, see Local SSD performance.
* Valid values:
*
* * `NVME`
* * `SCSI`
*
*
* string interface = 7;
*
* @return The bytes for interface.
*/
com.google.protobuf.ByteString getInterfaceBytes();
/**
*
*
*
* Output only. Type of the resource. Always compute#attachedDisk for attached disks.
*
*
* string kind = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The kind.
*/
java.lang.String getKind();
/**
*
*
*
* Output only. Type of the resource. Always compute#attachedDisk for attached disks.
*
*
* string kind = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The bytes for kind.
*/
com.google.protobuf.ByteString getKindBytes();
/**
*
*
*
* Output only. Any valid publicly visible licenses.
*
*
* repeated string licenses = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return A list containing the licenses.
*/
java.util.List getLicensesList();
/**
*
*
*
* Output only. Any valid publicly visible licenses.
*
*
* repeated string licenses = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The count of licenses.
*/
int getLicensesCount();
/**
*
*
*
* Output only. Any valid publicly visible licenses.
*
*
* repeated string licenses = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @param index The index of the element to return.
* @return The licenses at the given index.
*/
java.lang.String getLicenses(int index);
/**
*
*
*
* Output only. Any valid publicly visible licenses.
*
*
* repeated string licenses = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @param index The index of the value to return.
* @return The bytes of the licenses at the given index.
*/
com.google.protobuf.ByteString getLicensesBytes(int index);
/**
*
*
*
* The mode in which to attach this disk, either `READ_WRITE` or `READ_ONLY`.
* If not specified, the default is to attach the disk in `READ_WRITE` mode.
* Valid values:
*
* * `READ_ONLY`
* * `READ_WRITE`
*
*
* string mode = 10;
*
* @return The mode.
*/
java.lang.String getMode();
/**
*
*
*
* The mode in which to attach this disk, either `READ_WRITE` or `READ_ONLY`.
* If not specified, the default is to attach the disk in `READ_WRITE` mode.
* Valid values:
*
* * `READ_ONLY`
* * `READ_WRITE`
*
*
* string mode = 10;
*
* @return The bytes for mode.
*/
com.google.protobuf.ByteString getModeBytes();
/**
*
*
*
* Specifies a valid partial or full URL to an existing Persistent Disk
* resource.
*
*
* string source = 11;
*
* @return The source.
*/
java.lang.String getSource();
/**
*
*
*
* Specifies a valid partial or full URL to an existing Persistent Disk
* resource.
*
*
* string source = 11;
*
* @return The bytes for source.
*/
com.google.protobuf.ByteString getSourceBytes();
/**
*
*
*
* Specifies the type of the disk, either `SCRATCH` or `PERSISTENT`. If not
* specified, the default is `PERSISTENT`.
* Valid values:
*
* * `PERSISTENT`
* * `SCRATCH`
*
*
* string type = 12;
*
* @return The type.
*/
java.lang.String getType();
/**
*
*
*
* Specifies the type of the disk, either `SCRATCH` or `PERSISTENT`. If not
* specified, the default is `PERSISTENT`.
* Valid values:
*
* * `PERSISTENT`
* * `SCRATCH`
*
*
* string type = 12;
*
* @return The bytes for type.
*/
com.google.protobuf.ByteString getTypeBytes();
}