com.google.cloud.filestore.v1beta1.ShareOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-filestore-v1beta1 Show documentation
Show all versions of proto-google-cloud-filestore-v1beta1 Show documentation
Proto library for google-cloud-filestore
/*
* 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/filestore/v1beta1/cloud_filestore_service.proto
// Protobuf Java Version: 3.25.3
package com.google.cloud.filestore.v1beta1;
public interface ShareOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.filestore.v1beta1.Share)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Output only. The resource name of the share, in the format
* `projects/{project_id}/locations/{location_id}/instances/{instance_id}/shares/{share_id}`.
*
*
* string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The name.
*/
java.lang.String getName();
/**
*
*
*
* Output only. The resource name of the share, in the format
* `projects/{project_id}/locations/{location_id}/instances/{instance_id}/shares/{share_id}`.
*
*
* string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* The mount name of the share. Must be 63 characters or less and consist of
* uppercase or lowercase letters, numbers, and underscores.
*
*
* string mount_name = 2;
*
* @return The mountName.
*/
java.lang.String getMountName();
/**
*
*
*
* The mount name of the share. Must be 63 characters or less and consist of
* uppercase or lowercase letters, numbers, and underscores.
*
*
* string mount_name = 2;
*
* @return The bytes for mountName.
*/
com.google.protobuf.ByteString getMountNameBytes();
/**
*
*
*
* A description of the share with 2048 characters or less. Requests with
* longer descriptions will be rejected.
*
*
* string description = 3;
*
* @return The description.
*/
java.lang.String getDescription();
/**
*
*
*
* A description of the share with 2048 characters or less. Requests with
* longer descriptions will be rejected.
*
*
* string description = 3;
*
* @return The bytes for description.
*/
com.google.protobuf.ByteString getDescriptionBytes();
/**
*
*
*
* File share capacity in gigabytes (GB). Filestore defines 1 GB as
* 1024^3 bytes. Must be greater than 0.
*
*
* int64 capacity_gb = 4;
*
* @return The capacityGb.
*/
long getCapacityGb();
/**
*
*
*
* Nfs Export Options.
* There is a limit of 10 export options per file share.
*
*
* repeated .google.cloud.filestore.v1beta1.NfsExportOptions nfs_export_options = 5;
*/
java.util.List getNfsExportOptionsList();
/**
*
*
*
* Nfs Export Options.
* There is a limit of 10 export options per file share.
*
*
* repeated .google.cloud.filestore.v1beta1.NfsExportOptions nfs_export_options = 5;
*/
com.google.cloud.filestore.v1beta1.NfsExportOptions getNfsExportOptions(int index);
/**
*
*
*
* Nfs Export Options.
* There is a limit of 10 export options per file share.
*
*
* repeated .google.cloud.filestore.v1beta1.NfsExportOptions nfs_export_options = 5;
*/
int getNfsExportOptionsCount();
/**
*
*
*
* Nfs Export Options.
* There is a limit of 10 export options per file share.
*
*
* repeated .google.cloud.filestore.v1beta1.NfsExportOptions nfs_export_options = 5;
*/
java.util.List
getNfsExportOptionsOrBuilderList();
/**
*
*
*
* Nfs Export Options.
* There is a limit of 10 export options per file share.
*
*
* repeated .google.cloud.filestore.v1beta1.NfsExportOptions nfs_export_options = 5;
*/
com.google.cloud.filestore.v1beta1.NfsExportOptionsOrBuilder getNfsExportOptionsOrBuilder(
int index);
/**
*
*
*
* Output only. The share state.
*
*
*
* .google.cloud.filestore.v1beta1.Share.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The enum numeric value on the wire for state.
*/
int getStateValue();
/**
*
*
*
* Output only. The share state.
*
*
*
* .google.cloud.filestore.v1beta1.Share.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The state.
*/
com.google.cloud.filestore.v1beta1.Share.State getState();
/**
*
*
*
* Output only. The time when the share was created.
*
*
* .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the createTime field is set.
*/
boolean hasCreateTime();
/**
*
*
*
* Output only. The time when the share was created.
*
*
* .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The createTime.
*/
com.google.protobuf.Timestamp getCreateTime();
/**
*
*
*
* Output only. The time when the share was created.
*
*
* .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();
/**
*
*
*
* Resource labels to represent user provided metadata.
*
*
* map<string, string> labels = 8;
*/
int getLabelsCount();
/**
*
*
*
* Resource labels to represent user provided metadata.
*
*
* map<string, string> labels = 8;
*/
boolean containsLabels(java.lang.String key);
/** Use {@link #getLabelsMap()} instead. */
@java.lang.Deprecated
java.util.Map getLabels();
/**
*
*
*
* Resource labels to represent user provided metadata.
*
*
* map<string, string> labels = 8;
*/
java.util.Map getLabelsMap();
/**
*
*
*
* Resource labels to represent user provided metadata.
*
*
* map<string, string> labels = 8;
*/
/* nullable */
java.lang.String getLabelsOrDefault(
java.lang.String key,
/* nullable */
java.lang.String defaultValue);
/**
*
*
*
* Resource labels to represent user provided metadata.
*
*
* map<string, string> labels = 8;
*/
java.lang.String getLabelsOrThrow(java.lang.String key);
/**
*
*
*
* Immutable. Full name of the Cloud Filestore Backup resource that this
* Share is restored from, in the format of
* projects/{project_id}/locations/{location_id}/backups/{backup_id}.
* Empty, if the Share is created from scratch and not restored from a
* backup.
*
*
*
* string backup = 9 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
*
*
* @return Whether the backup field is set.
*/
boolean hasBackup();
/**
*
*
*
* Immutable. Full name of the Cloud Filestore Backup resource that this
* Share is restored from, in the format of
* projects/{project_id}/locations/{location_id}/backups/{backup_id}.
* Empty, if the Share is created from scratch and not restored from a
* backup.
*
*
*
* string backup = 9 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
*
*
* @return The backup.
*/
java.lang.String getBackup();
/**
*
*
*
* Immutable. Full name of the Cloud Filestore Backup resource that this
* Share is restored from, in the format of
* projects/{project_id}/locations/{location_id}/backups/{backup_id}.
* Empty, if the Share is created from scratch and not restored from a
* backup.
*
*
*
* string backup = 9 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
*
*
* @return The bytes for backup.
*/
com.google.protobuf.ByteString getBackupBytes();
com.google.cloud.filestore.v1beta1.Share.SourceCase getSourceCase();
}