Google Cloud Parallelstore V1beta Client - Class Instance (0.5.0)

Version 0.5.0

• 0.8.1 (latest)
• 0.8.0
• 0.7.1
• 0.6.1
• 0.5.0
• 0.4.0
• 0.3.1
• 0.2.0
• 0.1.1

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Reference documentation and code samples for the Google Cloud Parallelstore V1beta Client class Instance.

A Parallelstore instance.

Generated from protobuf message google.cloud.parallelstore.v1beta.Instance

Namespace

Google \ Cloud \ Parallelstore \ V1beta

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ name	string Identifier. The resource name of the instance, in the format projects/{project}/locations/{location}/instances/{instance_id}
↳ description	string Optional. The description of the instance. 2048 characters or less.
↳ state	int Output only. The instance state.
↳ create_time	Google\Protobuf\Timestamp Output only. The time when the instance was created.
↳ update_time	Google\Protobuf\Timestamp Output only. The time when the instance was updated.
↳ labels	array|Google\Protobuf\Internal\MapField 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. Cloud Labels can be used to filter collections of resources. They can be used to control how resource metrics are aggregated. And they can be used as arguments to policy management rules (e.g. route, firewall, load balancing, etc.). * Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z][a-z0-9_-]{0,62}. * Label values must be between 0 and 63 characters long and must conform to the regular expression [a-z0-9_-]{0,63}. * No more than 64 labels can be associated with a given resource. See https://goo.gl/xmQnxf for more information on and examples of labels. If you plan to use labels in your own code, please note that additional characters may be allowed in the future. Therefore, you are advised to use an internal label representation, such as JSON, which doesn't rely upon specific characters being disallowed. For example, representing labels as the string: name + "" + value would prove problematic if we were to allow "" in a future release.
↳ capacity_gib	int|string Required. Immutable. Storage capacity of Parallelstore instance in Gibibytes (GiB).
↳ daos_version	string Output only. The version of DAOS software running in the instance
↳ access_points	array Output only. List of access_points. Contains a list of IPv4 addresses used for client side configuration.
↳ network	string Optional. Immutable. The name of the Google Compute Engine VPC network to which the instance is connected.
↳ reserved_ip_range	string Optional. Immutable. Contains the id of the allocated IP address range associated with the private service access connection for example, "test-default" associated with IP range 10.0.0.0/29. If no range id is provided all ranges will be considered.
↳ effective_reserved_ip_range	string Output only. Immutable. Contains the id of the allocated IP address range associated with the private service access connection for example, "test-default" associated with IP range 10.0.0.0/29. This field is populated by the service and and contains the value currently used by the service.
↳ file_stripe_level	int Optional. Stripe level for files. MIN better suited for small size files. MAX higher throughput performance for larger files.
↳ directory_stripe_level	int Optional. Stripe level for directories. MIN when directory has a small number of files. MAX when directory has a large number of files.

getName

Identifier. The resource name of the instance, in the format projects/{project}/locations/{location}/instances/{instance_id}

Returns
Type	Description
string

setName

Identifier. The resource name of the instance, in the format projects/{project}/locations/{location}/instances/{instance_id}

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getDescription

Optional. The description of the instance. 2048 characters or less.

Returns
Type	Description
string

setDescription

Optional. The description of the instance. 2048 characters or less.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getState

Output only. The instance state.

Returns
Type	Description
int

setState

Output only. The instance state.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getCreateTime

Output only. The time when the instance was created.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time when the instance was created.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getUpdateTime

Output only. The time when the instance was updated.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The time when the instance was updated.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getLabels

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. Cloud Labels can be used to filter collections of resources. They can be used to control how resource metrics are aggregated. And they can be used as arguments to policy management rules (e.g. route, firewall, load balancing, etc.).

• Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z][a-z0-9_-]{0,62}.
  • Label values must be between 0 and 63 characters long and must conform to the regular expression [a-z0-9_-]{0,63}.
  • No more than 64 labels can be associated with a given resource. See https://goo.gl/xmQnxf for more information on and examples of labels. If you plan to use labels in your own code, please note that additional characters may be allowed in the future. Therefore, you are advised to use an internal label representation, such as JSON, which doesn't rely upon specific characters being disallowed. For example, representing labels as the string: name + "" + value would prove problematic if we were to allow "" in a future release.

Returns
Type	Description
Google\Protobuf\Internal\MapField

setLabels

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. Cloud Labels can be used to filter collections of resources. They can be used to control how resource metrics are aggregated. And they can be used as arguments to policy management rules (e.g. route, firewall, load balancing, etc.).

• Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z][a-z0-9_-]{0,62}.
  • Label values must be between 0 and 63 characters long and must conform to the regular expression [a-z0-9_-]{0,63}.
  • No more than 64 labels can be associated with a given resource. See https://goo.gl/xmQnxf for more information on and examples of labels. If you plan to use labels in your own code, please note that additional characters may be allowed in the future. Therefore, you are advised to use an internal label representation, such as JSON, which doesn't rely upon specific characters being disallowed. For example, representing labels as the string: name + "" + value would prove problematic if we were to allow "" in a future release.

Parameter
Name	Description
var	array|Google\Protobuf\Internal\MapField

Returns
Type	Description
$this

getCapacityGib

Required. Immutable. Storage capacity of Parallelstore instance in Gibibytes (GiB).

Returns
Type	Description
int|string

setCapacityGib

Required. Immutable. Storage capacity of Parallelstore instance in Gibibytes (GiB).

Parameter
Name	Description
var	int|string

Returns
Type	Description
$this

getDaosVersion

Output only. The version of DAOS software running in the instance

Returns
Type	Description
string

setDaosVersion

Output only. The version of DAOS software running in the instance

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getAccessPoints

Output only. List of access_points.

Contains a list of IPv4 addresses used for client side configuration.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setAccessPoints

Output only. List of access_points.

Contains a list of IPv4 addresses used for client side configuration.

Parameter
Name	Description
var	string[]

Returns
Type	Description
$this

getNetwork

Optional. Immutable. The name of the Google Compute Engine VPC network to which the instance is connected.

Returns
Type	Description
string

setNetwork

Optional. Immutable. The name of the Google Compute Engine VPC network to which the instance is connected.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getReservedIpRange

Optional. Immutable. Contains the id of the allocated IP address range associated with the private service access connection for example, "test-default" associated with IP range 10.0.0.0/29. If no range id is provided all ranges will be considered.

Returns
Type	Description
string

setReservedIpRange

Optional. Immutable. Contains the id of the allocated IP address range associated with the private service access connection for example, "test-default" associated with IP range 10.0.0.0/29. If no range id is provided all ranges will be considered.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getEffectiveReservedIpRange

Output only. Immutable. Contains the id of the allocated IP address range associated with the private service access connection for example, "test-default" associated with IP range 10.0.0.0/29. This field is populated by the service and and contains the value currently used by the service.

Returns
Type	Description
string

setEffectiveReservedIpRange

Output only. Immutable. Contains the id of the allocated IP address range associated with the private service access connection for example, "test-default" associated with IP range 10.0.0.0/29. This field is populated by the service and and contains the value currently used by the service.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getFileStripeLevel

Optional. Stripe level for files.

MIN better suited for small size files. MAX higher throughput performance for larger files.

Returns
Type	Description
int

setFileStripeLevel

Optional. Stripe level for files.

MIN better suited for small size files. MAX higher throughput performance for larger files.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getDirectoryStripeLevel

Optional. Stripe level for directories.

MIN when directory has a small number of files. MAX when directory has a large number of files.

Returns
Type	Description
int

setDirectoryStripeLevel

Optional. Stripe level for directories.

MIN when directory has a small number of files. MAX when directory has a large number of files.

Parameter
Name	Description
var	int

Returns
Type	Description
$this