Google Cloud Storage Control V2 Client - Class StorageLayout (0.2.1)

Reference documentation and code samples for the Google Cloud Storage Control V2 Client class StorageLayout.

The storage layout configuration of a bucket.

Generated from protobuf message google.storage.control.v2.StorageLayout

Namespace

Google \ Cloud \ Storage \ Control \ V2

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Output only. The name of the StorageLayout resource. Format: `projects/{project}/buckets/{bucket}/storageLayout`
`↳ location`	`string` Output only. The location of the bucket.
`↳ location_type`	`string` Output only. The location type of the bucket (region, dual-region, multi-region, etc).
`↳ custom_placement_config`	`Google\Cloud\Storage\Control\V2\StorageLayout\CustomPlacementConfig` Output only. The data placement configuration for custom dual region. If there is no configuration, this is not a custom dual region bucket.
`↳ hierarchical_namespace`	`Google\Cloud\Storage\Control\V2\StorageLayout\HierarchicalNamespace` Output only. The bucket's hierarchical namespace configuration. If there is no configuration, the hierarchical namespace is disabled.

getName

Output only. The name of the StorageLayout resource.

Format: projects/{project}/buckets/{bucket}/storageLayout

Returns
Type	Description
`string`

setName

Output only. The name of the StorageLayout resource.

Format: projects/{project}/buckets/{bucket}/storageLayout

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getLocation

Output only. The location of the bucket.

Returns
Type	Description
`string`

setLocation

Output only. The location of the bucket.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getLocationType

Output only. The location type of the bucket (region, dual-region, multi-region, etc).

Returns
Type	Description
`string`

setLocationType

Output only. The location type of the bucket (region, dual-region, multi-region, etc).

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCustomPlacementConfig

Output only. The data placement configuration for custom dual region. If there is no configuration, this is not a custom dual region bucket.

Returns
Type	Description
`Google\Cloud\Storage\Control\V2\StorageLayout\CustomPlacementConfig\|null`

hasCustomPlacementConfig

clearCustomPlacementConfig

setCustomPlacementConfig

Output only. The data placement configuration for custom dual region. If there is no configuration, this is not a custom dual region bucket.

Parameter
Name	Description
`var`	`Google\Cloud\Storage\Control\V2\StorageLayout\CustomPlacementConfig`

Returns
Type	Description
`$this`

getHierarchicalNamespace

Output only. The bucket's hierarchical namespace configuration. If there is no configuration, the hierarchical namespace is disabled.

Returns
Type	Description
`Google\Cloud\Storage\Control\V2\StorageLayout\HierarchicalNamespace\|null`

hasHierarchicalNamespace

clearHierarchicalNamespace

setHierarchicalNamespace

Output only. The bucket's hierarchical namespace configuration. If there is no configuration, the hierarchical namespace is disabled.

Parameter
Name	Description
`var`	`Google\Cloud\Storage\Control\V2\StorageLayout\HierarchicalNamespace`

Returns
Type	Description
`$this`