Interface InstanceOrBuilder (0.21.0)
Stay organized with collections
Save and categorize content based on your preferences.
publicinterface InstanceOrBuilderextendsMessageOrBuilderImplements
MessageOrBuilderMethods
containsLabels(String key)
publicabstractbooleancontainsLabels(Stringkey)Optional. Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. See https://cloud.google.com/resource-manager/docs/labels-overview for details.
map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getAccessPoints(int index)
publicabstractStringgetAccessPoints(intindex)Output only. A list of IPv4 addresses used for client side configuration.
repeated string access_points = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index |
int The index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The accessPoints at the given index. |
getAccessPointsBytes(int index)
publicabstractByteStringgetAccessPointsBytes(intindex)Output only. A list of IPv4 addresses used for client side configuration.
repeated string access_points = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index |
int The index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the accessPoints at the given index. |
getAccessPointsCount()
publicabstractintgetAccessPointsCount()Output only. A list of IPv4 addresses used for client side configuration.
repeated string access_points = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
The count of accessPoints. |
getAccessPointsList()
publicabstractList<String>getAccessPointsList()Output only. A list of IPv4 addresses used for client side configuration.
repeated string access_points = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
List<String> |
A list containing the accessPoints. |
getCapacityGib()
publicabstractlonggetCapacityGib()Required. Immutable. The instance's storage capacity in Gibibytes (GiB). Allowed values are between 12000 and 100000, in multiples of 4000; e.g., 12000, 16000, 20000, ...
int64 capacity_gib = 8 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
long |
The capacityGib. |
getCreateTime()
publicabstractTimestampgetCreateTime()Output only. The time when the instance was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The createTime. |
getCreateTimeOrBuilder()
publicabstractTimestampOrBuildergetCreateTimeOrBuilder()Output only. The time when the instance was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getDaosVersion()
publicabstractStringgetDaosVersion()Output only. The version of DAOS software running in the instance.
string daos_version = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String |
The daosVersion. |
getDaosVersionBytes()
publicabstractByteStringgetDaosVersionBytes()Output only. The version of DAOS software running in the instance.
string daos_version = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for daosVersion. |
getDescription()
publicabstractStringgetDescription()Optional. The description of the instance. 2048 characters or less.
string description = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The description. |
getDescriptionBytes()
publicabstractByteStringgetDescriptionBytes()Optional. The description of the instance. 2048 characters or less.
string description = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for description. |
getDirectoryStripeLevel()
publicabstractDirectoryStripeLevelgetDirectoryStripeLevel()Optional. Stripe level for directories. Allowed values are:
DIRECTORY_STRIPE_LEVEL_MIN: recommended when directories contain a small number of files.DIRECTORY_STRIPE_LEVEL_BALANCED: balances performance for workloads involving a mix of small and large directories.DIRECTORY_STRIPE_LEVEL_MAX: recommended for directories with a large number of files.
.google.cloud.parallelstore.v1.DirectoryStripeLevel directory_stripe_level = 16 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
DirectoryStripeLevel |
The directoryStripeLevel. |
getDirectoryStripeLevelValue()
publicabstractintgetDirectoryStripeLevelValue()Optional. Stripe level for directories. Allowed values are:
DIRECTORY_STRIPE_LEVEL_MIN: recommended when directories contain a small number of files.DIRECTORY_STRIPE_LEVEL_BALANCED: balances performance for workloads involving a mix of small and large directories.DIRECTORY_STRIPE_LEVEL_MAX: recommended for directories with a large number of files.
.google.cloud.parallelstore.v1.DirectoryStripeLevel directory_stripe_level = 16 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for directoryStripeLevel. |
getEffectiveReservedIpRange()
publicabstractStringgetEffectiveReservedIpRange()Output only. Immutable. The ID of the IP address range being used by the instance's VPC network. This field is populated by the service and contains the value currently used by the service.
string effective_reserved_ip_range = 14 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The effectiveReservedIpRange. |
getEffectiveReservedIpRangeBytes()
publicabstractByteStringgetEffectiveReservedIpRangeBytes()Output only. Immutable. The ID of the IP address range being used by the instance's VPC network. This field is populated by the service and contains the value currently used by the service.
string effective_reserved_ip_range = 14 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for effectiveReservedIpRange. |
getFileStripeLevel()
publicabstractFileStripeLevelgetFileStripeLevel()Optional. Stripe level for files. Allowed values are:
FILE_STRIPE_LEVEL_MIN: offers the best performance for small size files.FILE_STRIPE_LEVEL_BALANCED: balances performance for workloads involving a mix of small and large files.FILE_STRIPE_LEVEL_MAX: higher throughput performance for larger files.
.google.cloud.parallelstore.v1.FileStripeLevel file_stripe_level = 15 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
FileStripeLevel |
The fileStripeLevel. |
getFileStripeLevelValue()
publicabstractintgetFileStripeLevelValue()Optional. Stripe level for files. Allowed values are:
FILE_STRIPE_LEVEL_MIN: offers the best performance for small size files.FILE_STRIPE_LEVEL_BALANCED: balances performance for workloads involving a mix of small and large files.FILE_STRIPE_LEVEL_MAX: higher throughput performance for larger files.
.google.cloud.parallelstore.v1.FileStripeLevel file_stripe_level = 15 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for fileStripeLevel. |
getLabels() (deprecated)
publicabstractMap<String,String>getLabels()Use #getLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getLabelsCount()
publicabstractintgetLabelsCount()Optional. Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. See https://cloud.google.com/resource-manager/docs/labels-overview for details.
map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
getLabelsMap()
publicabstractMap<String,String>getLabelsMap()Optional. Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. See https://cloud.google.com/resource-manager/docs/labels-overview for details.
map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getLabelsOrDefault(String key, String defaultValue)
publicabstractStringgetLabelsOrDefault(Stringkey,StringdefaultValue)Optional. Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. See https://cloud.google.com/resource-manager/docs/labels-overview for details.
map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getLabelsOrThrow(String key)
publicabstractStringgetLabelsOrThrow(Stringkey)Optional. Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. See https://cloud.google.com/resource-manager/docs/labels-overview for details.
map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getName()
publicabstractStringgetName() Identifier. The resource name of the instance, in the format
projects/{project}/locations/{location}/instances/{instance_id}.
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
publicabstractByteStringgetNameBytes() Identifier. The resource name of the instance, in the format
projects/{project}/locations/{location}/instances/{instance_id}.
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getNetwork()
publicabstractStringgetNetwork()Optional. Immutable. The name of the Compute Engine VPC network to which the instance is connected.
string network = 11 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The network. |
getNetworkBytes()
publicabstractByteStringgetNetworkBytes()Optional. Immutable. The name of the Compute Engine VPC network to which the instance is connected.
string network = 11 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for network. |
getReservedIpRange()
publicabstractStringgetReservedIpRange()Optional. Immutable. The ID of the IP address range being used by the instance's VPC network. See Configure a VPC network. If no ID is provided, all ranges are considered.
string reserved_ip_range = 12 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The reservedIpRange. |
getReservedIpRangeBytes()
publicabstractByteStringgetReservedIpRangeBytes()Optional. Immutable. The ID of the IP address range being used by the instance's VPC network. See Configure a VPC network. If no ID is provided, all ranges are considered.
string reserved_ip_range = 12 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for reservedIpRange. |
getState()
publicabstractInstance.StategetState()Output only. The instance state.
.google.cloud.parallelstore.v1.Instance.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Instance.State |
The state. |
getStateValue()
publicabstractintgetStateValue()Output only. The instance state.
.google.cloud.parallelstore.v1.Instance.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for state. |
getUpdateTime()
publicabstractTimestampgetUpdateTime()Output only. The time when the instance was updated.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The updateTime. |
getUpdateTimeOrBuilder()
publicabstractTimestampOrBuildergetUpdateTimeOrBuilder()Output only. The time when the instance was updated.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
hasCreateTime()
publicabstractbooleanhasCreateTime()Output only. The time when the instance was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the createTime field is set. |
hasUpdateTime()
publicabstractbooleanhasUpdateTime()Output only. The time when the instance was updated.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the updateTime field is set. |