com.google.cloud.filestore.v1beta1.InstanceOrBuilder 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.2
package com.google.cloud.filestore.v1beta1;
public interface InstanceOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.filestore.v1beta1.Instance)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Output only. The resource name of the instance, in the format
* `projects/{project_id}/locations/{location_id}/instances/{instance_id}`.
*
*
* string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The name.
*/
java.lang.String getName();
/**
*
*
*
* Output only. The resource name of the instance, in the format
* `projects/{project_id}/locations/{location_id}/instances/{instance_id}`.
*
*
* string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* The description of the instance (2048 characters or less).
*
*
* string description = 2;
*
* @return The description.
*/
java.lang.String getDescription();
/**
*
*
*
* The description of the instance (2048 characters or less).
*
*
* string description = 2;
*
* @return The bytes for description.
*/
com.google.protobuf.ByteString getDescriptionBytes();
/**
*
*
*
* Output only. The instance state.
*
*
*
* .google.cloud.filestore.v1beta1.Instance.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The enum numeric value on the wire for state.
*/
int getStateValue();
/**
*
*
*
* Output only. The instance state.
*
*
*
* .google.cloud.filestore.v1beta1.Instance.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The state.
*/
com.google.cloud.filestore.v1beta1.Instance.State getState();
/**
*
*
*
* Output only. Additional information about the instance state, if available.
*
*
* string status_message = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The statusMessage.
*/
java.lang.String getStatusMessage();
/**
*
*
*
* Output only. Additional information about the instance state, if available.
*
*
* string status_message = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The bytes for statusMessage.
*/
com.google.protobuf.ByteString getStatusMessageBytes();
/**
*
*
*
* Output only. The time when the instance 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 instance 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 instance was created.
*
*
* .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();
/**
*
*
*
* The service tier of the instance.
*
*
* .google.cloud.filestore.v1beta1.Instance.Tier tier = 8;
*
* @return The enum numeric value on the wire for tier.
*/
int getTierValue();
/**
*
*
*
* The service tier of the instance.
*
*
* .google.cloud.filestore.v1beta1.Instance.Tier tier = 8;
*
* @return The tier.
*/
com.google.cloud.filestore.v1beta1.Instance.Tier getTier();
/**
*
*
*
* Resource labels to represent user provided metadata.
*
*
* map<string, string> labels = 9;
*/
int getLabelsCount();
/**
*
*
*
* Resource labels to represent user provided metadata.
*
*
* map<string, string> labels = 9;
*/
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 = 9;
*/
java.util.Map getLabelsMap();
/**
*
*
*
* Resource labels to represent user provided metadata.
*
*
* map<string, string> labels = 9;
*/
/* 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 = 9;
*/
java.lang.String getLabelsOrThrow(java.lang.String key);
/**
*
*
*
* File system shares on the instance.
* For this version, only a single file share is supported.
*
*
* repeated .google.cloud.filestore.v1beta1.FileShareConfig file_shares = 10;
*/
java.util.List getFileSharesList();
/**
*
*
*
* File system shares on the instance.
* For this version, only a single file share is supported.
*
*
* repeated .google.cloud.filestore.v1beta1.FileShareConfig file_shares = 10;
*/
com.google.cloud.filestore.v1beta1.FileShareConfig getFileShares(int index);
/**
*
*
*
* File system shares on the instance.
* For this version, only a single file share is supported.
*
*
* repeated .google.cloud.filestore.v1beta1.FileShareConfig file_shares = 10;
*/
int getFileSharesCount();
/**
*
*
*
* File system shares on the instance.
* For this version, only a single file share is supported.
*
*
* repeated .google.cloud.filestore.v1beta1.FileShareConfig file_shares = 10;
*/
java.util.List
getFileSharesOrBuilderList();
/**
*
*
*
* File system shares on the instance.
* For this version, only a single file share is supported.
*
*
* repeated .google.cloud.filestore.v1beta1.FileShareConfig file_shares = 10;
*/
com.google.cloud.filestore.v1beta1.FileShareConfigOrBuilder getFileSharesOrBuilder(int index);
/**
*
*
*
* VPC networks to which the instance is connected.
* For this version, only a single network is supported.
*
*
* repeated .google.cloud.filestore.v1beta1.NetworkConfig networks = 11;
*/
java.util.List getNetworksList();
/**
*
*
*
* VPC networks to which the instance is connected.
* For this version, only a single network is supported.
*
*
* repeated .google.cloud.filestore.v1beta1.NetworkConfig networks = 11;
*/
com.google.cloud.filestore.v1beta1.NetworkConfig getNetworks(int index);
/**
*
*
*
* VPC networks to which the instance is connected.
* For this version, only a single network is supported.
*
*
* repeated .google.cloud.filestore.v1beta1.NetworkConfig networks = 11;
*/
int getNetworksCount();
/**
*
*
*
* VPC networks to which the instance is connected.
* For this version, only a single network is supported.
*
*
* repeated .google.cloud.filestore.v1beta1.NetworkConfig networks = 11;
*/
java.util.List
getNetworksOrBuilderList();
/**
*
*
*
* VPC networks to which the instance is connected.
* For this version, only a single network is supported.
*
*
* repeated .google.cloud.filestore.v1beta1.NetworkConfig networks = 11;
*/
com.google.cloud.filestore.v1beta1.NetworkConfigOrBuilder getNetworksOrBuilder(int index);
/**
*
*
*
* Server-specified ETag for the instance resource to prevent simultaneous
* updates from overwriting each other.
*
*
* string etag = 12;
*
* @return The etag.
*/
java.lang.String getEtag();
/**
*
*
*
* Server-specified ETag for the instance resource to prevent simultaneous
* updates from overwriting each other.
*
*
* string etag = 12;
*
* @return The bytes for etag.
*/
com.google.protobuf.ByteString getEtagBytes();
/**
*
*
*
* Output only. Reserved for future use.
*
*
*
* .google.protobuf.BoolValue satisfies_pzs = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the satisfiesPzs field is set.
*/
boolean hasSatisfiesPzs();
/**
*
*
*
* Output only. Reserved for future use.
*
*
*
* .google.protobuf.BoolValue satisfies_pzs = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The satisfiesPzs.
*/
com.google.protobuf.BoolValue getSatisfiesPzs();
/**
*
*
*
* Output only. Reserved for future use.
*
*
*
* .google.protobuf.BoolValue satisfies_pzs = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.BoolValueOrBuilder getSatisfiesPzsOrBuilder();
/**
*
*
*
* Output only. Reserved for future use.
*
*
* bool satisfies_pzi = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The satisfiesPzi.
*/
boolean getSatisfiesPzi();
/**
*
*
*
* KMS key name used for data encryption.
*
*
* string kms_key_name = 14;
*
* @return The kmsKeyName.
*/
java.lang.String getKmsKeyName();
/**
*
*
*
* KMS key name used for data encryption.
*
*
* string kms_key_name = 14;
*
* @return The bytes for kmsKeyName.
*/
com.google.protobuf.ByteString getKmsKeyNameBytes();
/**
*
*
*
* Output only. Field indicates all the reasons the instance is in "SUSPENDED"
* state.
*
*
*
* repeated .google.cloud.filestore.v1beta1.Instance.SuspensionReason suspension_reasons = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return A list containing the suspensionReasons.
*/
java.util.List
getSuspensionReasonsList();
/**
*
*
*
* Output only. Field indicates all the reasons the instance is in "SUSPENDED"
* state.
*
*
*
* repeated .google.cloud.filestore.v1beta1.Instance.SuspensionReason suspension_reasons = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The count of suspensionReasons.
*/
int getSuspensionReasonsCount();
/**
*
*
*
* Output only. Field indicates all the reasons the instance is in "SUSPENDED"
* state.
*
*
*
* repeated .google.cloud.filestore.v1beta1.Instance.SuspensionReason suspension_reasons = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @param index The index of the element to return.
* @return The suspensionReasons at the given index.
*/
com.google.cloud.filestore.v1beta1.Instance.SuspensionReason getSuspensionReasons(int index);
/**
*
*
*
* Output only. Field indicates all the reasons the instance is in "SUSPENDED"
* state.
*
*
*
* repeated .google.cloud.filestore.v1beta1.Instance.SuspensionReason suspension_reasons = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return A list containing the enum numeric values on the wire for suspensionReasons.
*/
java.util.List getSuspensionReasonsValueList();
/**
*
*
*
* Output only. Field indicates all the reasons the instance is in "SUSPENDED"
* state.
*
*
*
* repeated .google.cloud.filestore.v1beta1.Instance.SuspensionReason suspension_reasons = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @param index The index of the value to return.
* @return The enum numeric value on the wire of suspensionReasons at the given index.
*/
int getSuspensionReasonsValue(int index);
/**
*
*
*
* Output only. The max capacity of the instance.
*
*
* int64 max_capacity_gb = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The maxCapacityGb.
*/
long getMaxCapacityGb();
/**
*
*
*
* Output only. The increase/decrease capacity step size.
*
*
* int64 capacity_step_size_gb = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The capacityStepSizeGb.
*/
long getCapacityStepSizeGb();
/**
*
*
*
* The max number of shares allowed.
*
*
* int64 max_share_count = 18;
*
* @return The maxShareCount.
*/
long getMaxShareCount();
/**
*
*
*
* The storage capacity of the instance in gigabytes (GB = 1024^3 bytes).
* This capacity can be increased up to `max_capacity_gb` GB in multipliers
* of `capacity_step_size_gb` GB.
*
*
* int64 capacity_gb = 19;
*
* @return The capacityGb.
*/
long getCapacityGb();
/**
*
*
*
* Indicates whether this instance uses a multi-share configuration with which
* it can have more than one file-share or none at all. File-shares are added,
* updated and removed through the separate file-share APIs.
*
*
* bool multi_share_enabled = 20;
*
* @return The multiShareEnabled.
*/
boolean getMultiShareEnabled();
/**
*
*
*
* Immutable. The protocol indicates the access protocol for all shares in the
* instance. This field is immutable and it cannot be changed after the
* instance has been created. Default value: `NFS_V3`.
*
*
*
* .google.cloud.filestore.v1beta1.Instance.FileProtocol protocol = 21 [(.google.api.field_behavior) = IMMUTABLE];
*
*
* @return The enum numeric value on the wire for protocol.
*/
int getProtocolValue();
/**
*
*
*
* Immutable. The protocol indicates the access protocol for all shares in the
* instance. This field is immutable and it cannot be changed after the
* instance has been created. Default value: `NFS_V3`.
*
*
*
* .google.cloud.filestore.v1beta1.Instance.FileProtocol protocol = 21 [(.google.api.field_behavior) = IMMUTABLE];
*
*
* @return The protocol.
*/
com.google.cloud.filestore.v1beta1.Instance.FileProtocol getProtocol();
/**
*
*
*
* Directory Services configuration for Kerberos-based authentication.
* Should only be set if protocol is "NFS_V4_1".
*
*
* .google.cloud.filestore.v1beta1.DirectoryServicesConfig directory_services = 24;
*
* @return Whether the directoryServices field is set.
*/
boolean hasDirectoryServices();
/**
*
*
*
* Directory Services configuration for Kerberos-based authentication.
* Should only be set if protocol is "NFS_V4_1".
*
*
* .google.cloud.filestore.v1beta1.DirectoryServicesConfig directory_services = 24;
*
* @return The directoryServices.
*/
com.google.cloud.filestore.v1beta1.DirectoryServicesConfig getDirectoryServices();
/**
*
*
*
* Directory Services configuration for Kerberos-based authentication.
* Should only be set if protocol is "NFS_V4_1".
*
*
* .google.cloud.filestore.v1beta1.DirectoryServicesConfig directory_services = 24;
*/
com.google.cloud.filestore.v1beta1.DirectoryServicesConfigOrBuilder
getDirectoryServicesOrBuilder();
}