Package google.storage.control.v2

Index

StorageControl

StorageControl service includes selected control plane operations.

CreateAnywhereCache

rpc CreateAnywhereCache(CreateAnywhereCacheRequest) returns (Operation)

Creates a cache instance.

IAM Permissions:

Requires the storage.anywhereCaches.create IAM permission on the bucket.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/devstorage.full_control
  • https://www.googleapis.com/auth/devstorage.read_only
  • https://www.googleapis.com/auth/devstorage.read_write
  • https://www.googleapis.com/auth/devstorage.write_only
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only

For more information, see the Authentication Overview.
CreateFolder

rpc CreateFolder(CreateFolderRequest) returns (Folder)

Creates a folder.

IAM Permissions:

Requires the storage.folders.create IAM permission on the bucket.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/devstorage.full_control
  • https://www.googleapis.com/auth/devstorage.read_only
  • https://www.googleapis.com/auth/devstorage.read_write
  • https://www.googleapis.com/auth/devstorage.write_only
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only

For more information, see the Authentication Overview.
CreateManagedFolder

rpc CreateManagedFolder(CreateManagedFolderRequest) returns (ManagedFolder)

Creates a managed folder within a bucket.

IAM Permissions:

Requires the storage.managedFolders.create IAM permission on the bucket.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/devstorage.full_control
  • https://www.googleapis.com/auth/devstorage.read_only
  • https://www.googleapis.com/auth/devstorage.read_write
  • https://www.googleapis.com/auth/devstorage.write_only
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only

For more information, see the Authentication Overview.
DeleteFolder

rpc DeleteFolder(DeleteFolderRequest) returns (Empty)

Deletes a folder. You can only delete empty folders without child folders or objects. This method also deletes any managed folder attached to the folder that you are deleting. Deleting managed folders that are attached to folders follows the same rules and permission checks as deleting managed folders directly. For more information about deleting managed folders, see Delete a managed folder.

IAM Permissions:

You must have the following IAM permissions to use this method:

  • storage.folders.delete: This permission is needed to delete the folder.

  • storage.managedFolders.delete: If the folder you're trying to delete contains any managed folders, you'll need this permission to delete those managed folders.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/devstorage.full_control
  • https://www.googleapis.com/auth/devstorage.read_only
  • https://www.googleapis.com/auth/devstorage.read_write
  • https://www.googleapis.com/auth/devstorage.write_only
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only

For more information, see the Authentication Overview.
DeleteManagedFolder

rpc DeleteManagedFolder(DeleteManagedFolderRequest) returns (Empty)

Deletes a managed folder within a bucket.

IAM Permissions:

Requires the storage.managedFolders.delete IAM permission on the bucket. To use allowNonEmpty, the user must also have the storage.managedFolders.setIamPolicy permission.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/devstorage.full_control
  • https://www.googleapis.com/auth/devstorage.read_only
  • https://www.googleapis.com/auth/devstorage.read_write
  • https://www.googleapis.com/auth/devstorage.write_only
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only

For more information, see the Authentication Overview.
DisableAnywhereCache

rpc DisableAnywhereCache(DisableAnywhereCacheRequest) returns (AnywhereCache)

Disables a cache instance. For details, see Disable a cache.

IAM Permissions:

Requires the storage.anywhereCaches.disable IAM permission on the bucket.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/devstorage.full_control
  • https://www.googleapis.com/auth/devstorage.read_only
  • https://www.googleapis.com/auth/devstorage.read_write
  • https://www.googleapis.com/auth/devstorage.write_only
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only

For more information, see the Authentication Overview.
GetAnywhereCache

rpc GetAnywhereCache(GetAnywhereCacheRequest) returns (AnywhereCache)

Retrieves a cache instance for a specified bucket.

IAM Permissions:

Requires the storage.anywhereCaches.get IAM permission on the bucket.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/devstorage.full_control
  • https://www.googleapis.com/auth/devstorage.read_only
  • https://www.googleapis.com/auth/devstorage.read_write
  • https://www.googleapis.com/auth/devstorage.write_only
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only

For more information, see the Authentication Overview.
GetFolder

rpc GetFolder(GetFolderRequest) returns (Folder)

Retrieves the metadata of a folder.

IAM Permissions:

Requires the storage.folders.get IAM permission on the bucket.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/devstorage.full_control
  • https://www.googleapis.com/auth/devstorage.read_only
  • https://www.googleapis.com/auth/devstorage.read_write
  • https://www.googleapis.com/auth/devstorage.write_only
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only

For more information, see the Authentication Overview.
GetFolderIntelligenceConfig

rpc GetFolderIntelligenceConfig(GetFolderIntelligenceConfigRequest) returns (IntelligenceConfig)

Gets the IntelligenceConfig resource associated with your folder.

IAM Permissions:

Requires storage.intelligenceConfigs.get IAM permission on the folder.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/devstorage.full_control
  • https://www.googleapis.com/auth/devstorage.read_only
  • https://www.googleapis.com/auth/devstorage.read_write
  • https://www.googleapis.com/auth/devstorage.write_only
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only

For more information, see the Authentication Overview.
GetManagedFolder

rpc GetManagedFolder(GetManagedFolderRequest) returns (ManagedFolder)

Returns metadata for the specified managed folder.

IAM Permissions:

Requires the storage.managedFolders.get IAM permission on the bucket.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/devstorage.full_control
  • https://www.googleapis.com/auth/devstorage.read_only
  • https://www.googleapis.com/auth/devstorage.read_write
  • https://www.googleapis.com/auth/devstorage.write_only
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only

For more information, see the Authentication Overview.
GetOrganizationIntelligenceConfig

rpc GetOrganizationIntelligenceConfig(GetOrganizationIntelligenceConfigRequest) returns (IntelligenceConfig)

Gets the IntelligenceConfig resource associated with your organization.

IAM Permissions:

Requires storage.intelligenceConfigs.get IAM permission on the organization.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/devstorage.full_control
  • https://www.googleapis.com/auth/devstorage.read_only
  • https://www.googleapis.com/auth/devstorage.read_write
  • https://www.googleapis.com/auth/devstorage.write_only
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only

For more information, see the Authentication Overview.
GetProjectIntelligenceConfig

rpc GetProjectIntelligenceConfig(GetProjectIntelligenceConfigRequest) returns (IntelligenceConfig)

Gets the IntelligenceConfig resource associated with your project.

IAM Permissions:

Requires storage.intelligenceConfigs.get IAM permission on the project.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/devstorage.full_control
  • https://www.googleapis.com/auth/devstorage.read_only
  • https://www.googleapis.com/auth/devstorage.read_write
  • https://www.googleapis.com/auth/devstorage.write_only
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only

For more information, see the Authentication Overview.
GetStorageLayout

rpc GetStorageLayout(GetStorageLayoutRequest) returns (StorageLayout)

Returns the storage layout of the specified bucket.

IAM Permissions:

Requires the storage.objects.list IAM permission on the bucket.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/devstorage.full_control
  • https://www.googleapis.com/auth/devstorage.read_only
  • https://www.googleapis.com/auth/devstorage.read_write
  • https://www.googleapis.com/auth/devstorage.write_only
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only

For more information, see the Authentication Overview.
ListAnywhereCaches

rpc ListAnywhereCaches(ListAnywhereCachesRequest) returns (ListAnywhereCachesResponse)

Retrieves a list of cache instances for a specified bucket.

IAM Permissions:

Requires the storage.anywhereCaches.list IAM permission on the bucket.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/devstorage.full_control
  • https://www.googleapis.com/auth/devstorage.read_only
  • https://www.googleapis.com/auth/devstorage.read_write
  • https://www.googleapis.com/auth/devstorage.write_only
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only

For more information, see the Authentication Overview.
ListFolders

rpc ListFolders(ListFoldersRequest) returns (ListFoldersResponse)

View the folders within a bucket.

IAM Permissions:

Requires the storage.folders.list IAM permission on the bucket.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/devstorage.full_control
  • https://www.googleapis.com/auth/devstorage.read_only
  • https://www.googleapis.com/auth/devstorage.read_write
  • https://www.googleapis.com/auth/devstorage.write_only
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only

For more information, see the Authentication Overview.
ListManagedFolders

rpc ListManagedFolders(ListManagedFoldersRequest) returns (ListManagedFoldersResponse)

Retrieves a list of managed folders for a given bucket.

IAM Permissions:

Requires the storage.managedFolders.list IAM permission on the bucket.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/devstorage.full_control
  • https://www.googleapis.com/auth/devstorage.read_only
  • https://www.googleapis.com/auth/devstorage.read_write
  • https://www.googleapis.com/auth/devstorage.write_only
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only

For more information, see the Authentication Overview.
PauseAnywhereCache

rpc PauseAnywhereCache(PauseAnywhereCacheRequest) returns (AnywhereCache)

Pauses a cache instance. For details, see Pause a cache. Once paused, the cache can be unpaused using the AnywhereCaches: resume API.

IAM Permissions:

Requires the storage.anywhereCaches.pause IAM permission on the bucket.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/devstorage.full_control
  • https://www.googleapis.com/auth/devstorage.read_only
  • https://www.googleapis.com/auth/devstorage.read_write
  • https://www.googleapis.com/auth/devstorage.write_only
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only

For more information, see the Authentication Overview.
RenameFolder

rpc RenameFolder(RenameFolderRequest) returns (Operation)

Renames a folder. For details about how the rename operation works, see Rename folders.

IAM Permissions:

The authenticated user must have the following IAM permissions to use this method:

  • storage.folders.rename: This permission is needed to rename the source folder.

  • storage.folders.create: This permission is needed to create the destination folder.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/devstorage.full_control
  • https://www.googleapis.com/auth/devstorage.read_only
  • https://www.googleapis.com/auth/devstorage.read_write
  • https://www.googleapis.com/auth/devstorage.write_only
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only

For more information, see the Authentication Overview.
ResumeAnywhereCache

rpc ResumeAnywhereCache(ResumeAnywhereCacheRequest) returns (AnywhereCache)

Resumes a cache instance in a specified bucket from being paused or disabled.

IAM Permissions:

Requires the storage.anywhereCaches.resume IAM permission on the bucket.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/devstorage.full_control
  • https://www.googleapis.com/auth/devstorage.read_only
  • https://www.googleapis.com/auth/devstorage.read_write
  • https://www.googleapis.com/auth/devstorage.write_only
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only

For more information, see the Authentication Overview.
UpdateAnywhereCache

rpc UpdateAnywhereCache(UpdateAnywhereCacheRequest) returns (Operation)

Updates a cache instance. Only caches in a RUNNING state can be updated.

IAM Permissions:

Requires the storage.anywhereCaches.update IAM permission on the bucket.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/devstorage.full_control
  • https://www.googleapis.com/auth/devstorage.read_only
  • https://www.googleapis.com/auth/devstorage.read_write
  • https://www.googleapis.com/auth/devstorage.write_only
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only

For more information, see the Authentication Overview.
UpdateFolderIntelligenceConfig

rpc UpdateFolderIntelligenceConfig(UpdateFolderIntelligenceConfigRequest) returns (IntelligenceConfig)

Updates the IntelligenceConfig resource associated with your folder.

IAM Permissions:

Requires storage.intelligenceConfigs.update IAM permission on the folder.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/devstorage.full_control
  • https://www.googleapis.com/auth/devstorage.read_only
  • https://www.googleapis.com/auth/devstorage.read_write
  • https://www.googleapis.com/auth/devstorage.write_only
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only

For more information, see the Authentication Overview.
UpdateOrganizationIntelligenceConfig

rpc UpdateOrganizationIntelligenceConfig(UpdateOrganizationIntelligenceConfigRequest) returns (IntelligenceConfig)

Updates the IntelligenceConfig resource associated with your organization.

IAM Permissions:

Requires storage.intelligenceConfigs.update IAM permission on the organization.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/devstorage.full_control
  • https://www.googleapis.com/auth/devstorage.read_only
  • https://www.googleapis.com/auth/devstorage.read_write
  • https://www.googleapis.com/auth/devstorage.write_only
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only

For more information, see the Authentication Overview.
UpdateProjectIntelligenceConfig

rpc UpdateProjectIntelligenceConfig(UpdateProjectIntelligenceConfigRequest) returns (IntelligenceConfig)

Updates the IntelligenceConfig resource associated with your project.

IAM Permissions:

Requires storage.intelligenceConfigs.update IAM permission on the project.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/devstorage.full_control
  • https://www.googleapis.com/auth/devstorage.read_only
  • https://www.googleapis.com/auth/devstorage.read_write
  • https://www.googleapis.com/auth/devstorage.write_only
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only

For more information, see the Authentication Overview.

AnywhereCache

An Anywhere Cache instance.

Fields
name

string

Immutable. The resource name of the AnywhereCache instance.

Format: projects/{project}/buckets/{bucket}/anywhereCaches/{anywhere_cache}
zone

string

Immutable. The zone in which the cache instance is running. For example, us-central1-a.
ttl

Duration

Cache entry TTL (ranges between 1h to 7d). This is a cache-level config that defines how long a cache entry can live. Default ttl value (24hrs) is applied if not specified in the create request. TTL must be in whole seconds.
admission_policy

string

Cache admission policy. Valid policies includes: admit-on-first-miss and admit-on-second-miss. Defaults to admit-on-first-miss. Default value is applied if not specified in the create request.
state

string

Output only. Cache state including RUNNING, CREATING, DISABLED, and PAUSED.
create_time

Timestamp

Output only. Time when the cache instance is allocated.
update_time

Timestamp

Output only. Time when the cache instance is last updated, including creation.
pending_update

bool

Output only. True if there is an active update operation against this cache instance. Subsequential update requests will be rejected if this field is true. Output only.

CommonLongRunningOperationMetadata

The message contains metadata that is common to all Storage Control long-running operations, present in its google.longrunning.Operation messages, and accessible via metadata.common_metadata.

Fields
create_time

Timestamp

Output only. The time the operation was created.
end_time

Timestamp

Output only. The time the operation finished running.
update_time

Timestamp

Output only. The time the operation was last modified.
type

string

Output only. The type of operation invoked.
requested_cancellation

bool

Output only. Identifies whether the user has requested cancellation.
progress_percent

int32

Output only. The estimated progress of the operation in percentage [0, 100]. The value -1 means the progress is unknown.

CreateAnywhereCacheMetadata

Message returned in the metadata field of the Operation resource for CreateAnywhereCache operations.

Fields
common_metadata

CommonLongRunningOperationMetadata

Generic metadata for the long running operation.
anywhere_cache_id

string

Anywhere Cache ID.
zone

string

The zone in which the cache instance is running. For example, us-central1-a.
ttl

Duration

Anywhere Cache entry's TTL. A cache-level config that is applied to all new cache entries on admission. Default ttl value (24hrs) is applied if not specified in the create request.
admission_policy

string

Anywhere Cache entry Admission Policy in kebab-case (for example, admit-on-first-miss). Default admission policy is applied if not specified in the create request.

CreateAnywhereCacheRequest

Request message for CreateAnywhereCache.

Fields
parent

string
anywhere_cache

AnywhereCache

Required. Properties of the Anywhere Cache instance that you create. The parent bucket name is specified in the parent field. Server uses the default value of ttl or admission_policy if not specified in request.
request_id

string

Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted. This request is only idempotent if a request_id is provided.

CreateFolderRequest

Request message for CreateFolder operation. This operation is only applicable to a hierarchical namespace enabled bucket.

Fields
parent

string

Required. Name of the bucket in which the folder resides. The bucket must be a hierarchical namespace enabled bucket.
folder

Folder

Required. Properties of the new folder being created. The bucket and name fields of the folder are specified in the parent and folder_id fields, respectively. Populating those fields in folder will result in an error.
folder_id

string

Required. The full name of a folder, including all its parent folders. Folders use single '/' characters as a delimiter. The folder_id field must end with a slash (/). For example, the folder_id of books/biographies/ would create a new biographies/ folder under the books/ folder.
recursive

bool

Optional. If set to true, the request creates all the non-existing parent folders. If not set or set to false, the request fails if any parent folder doesn't exist.
request_id

string

Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted.

CreateManagedFolderRequest

Request message for CreateManagedFolder.

Fields
parent

string

Required. Name of the bucket this managed folder belongs to.
managed_folder

ManagedFolder

Required. Properties of the managed folder being created. The bucket and managed folder names are specified in the parent and managed_folder_id fields. Populating these fields in managed_folder will result in an error.
managed_folder_id

string

Required. The name of the managed folder. It uses a single / as delimiter and leading and trailing / are allowed.
request_id

string

Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted.

DeleteFolderRequest

Request message for DeleteFolder operation. This operation is only applicable to a hierarchical namespace enabled bucket.

Fields
name

string

Required. Name of the folder.

Format: projects/{project}/buckets/{bucket}/folders/{folder}
request_id

string

Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted.
if_metageneration_match

int64

If set, the method deletes the folder if its metageneration matches this value.
if_metageneration_not_match

int64

If set, the method deletes the folder if its metageneration does not match this value.

DeleteManagedFolderRequest

DeleteManagedFolder RPC request message.

Fields
name

string

Required. Name of the managed folder. Format: projects/{project}/buckets/{bucket}/managedFolders/{managedFolder}
allow_non_empty

bool
request_id

string

Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted.
if_metageneration_match

int64

If set, the method deletes the managed folder if its metageneration matches this value.
if_metageneration_not_match

int64

If set, the method deletes the managed folder if its metageneration does not match this value.

DisableAnywhereCacheRequest

Request message for DisableAnywhereCache.

Fields
name

string

Required. The name field in the request should be: projects/{project}/buckets/{bucket}/anywhereCaches/{anywhere_cache}
request_id

string

Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted. This request is only idempotent if a request_id is provided.

Folder

The Folder resource represents a folder in a Cloud Storage bucket with hierarchical namespace enabled.

Fields
name

string

Identifier. Name of the folder.

Format: projects/{project}/buckets/{bucket}/folders/{folder}
metageneration

int64

Output only. The metadata generation of the folder. Used for preconditions and for detecting changes in metadata.
create_time

Timestamp

Output only. The creation time of the folder.
update_time

Timestamp

Output only. The modification time of the folder.
pending_rename_info

PendingRenameInfo

Output only. Indicates if the folder is part of an ongoing RenameFolder operation. Contains information which can be used to query the operation status. The presence of this field also indicates all write operations are blocked for this folder, including folder, managed folder, and object operations.

GetAnywhereCacheRequest

Request message for GetAnywhereCache.

Fields
name

string

Required. The name field in the request should be: projects/{project}/buckets/{bucket}/anywhereCaches/{anywhere_cache}
request_id

string

Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted.

GetFolderIntelligenceConfigRequest

Request message to get the IntelligenceConfig resource associated with your folder.

IAM Permissions

Requires storage.intelligenceConfigs.get IAM permission on the folder.

Fields
name

string

Required. The name of the IntelligenceConfig resource associated with your folder.

Format: folders/{id}/locations/global/intelligenceConfig

GetFolderRequest

Request message for GetFolder operation. This operation is only applicable to a hierarchical namespace enabled bucket.

Fields
name

string

Required. Name of the folder.

Format: projects/{project}/buckets/{bucket}/folders/{folder}
request_id

string

Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted.
if_metageneration_match

int64

If set, the method returns the folder if its metageneration matches this value.
if_metageneration_not_match

int64

If set, the method returns the folder if its metageneration does not match this value.

GetManagedFolderRequest

Request message for GetManagedFolder.

Fields
name

string

Required. Name of the managed folder.

Format: projects/{project}/buckets/{bucket}/managedFolders/{managedFolder}
request_id

string

Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted.
if_metageneration_match

int64

If set, the method returns the managed folder if its metageneration matches this value.
if_metageneration_not_match

int64

If set, the method returns the managed folder if its metageneration does not match this value.

GetOrganizationIntelligenceConfigRequest

Request message to get the IntelligenceConfig resource associated with your organization.

IAM Permissions

Requires storage.intelligenceConfigs.get IAM permission on the organization.

Fields
name

string

Required. The name of the IntelligenceConfig resource associated with your organization.

Format: organizations/{org_id}/locations/global/intelligenceConfig

GetProjectIntelligenceConfigRequest

Request message to get the IntelligenceConfig resource associated with your project.

IAM Permissions:

Requires storage.intelligenceConfigs.get IAM permission on the project.

Fields
name

string

Required. The name of the IntelligenceConfig resource associated with your project.

Format: projects/{id}/locations/global/intelligenceConfig

GetStorageLayoutRequest

Request message for GetStorageLayout operation.

Fields
name

string

Required. The name of the StorageLayout resource. Format: projects/{project}/buckets/{bucket}/storageLayout
prefix

string

An optional prefix used for permission check. It is useful when the caller only has limited permissions under a specific prefix.
request_id

string

Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted.

IntelligenceConfig

The IntelligenceConfig resource associated with your organization, folder, or project.

Fields
name

string

Identifier. The name of the IntelligenceConfig resource associated with your organization, folder, or project.

The name format varies based on the GCP resource hierarchy as follows:

  • For project: projects/{project_number}/locations/global/intelligenceConfig
  • For organization: organizations/{org_id}/locations/global/intelligenceConfig
  • For folder: folders/{folder_id}/locations/global/intelligenceConfig
edition_config

EditionConfig

Optional. The edition configuration of the IntelligenceConfig resource.
update_time

Timestamp

Output only. The time at which the IntelligenceConfig resource is last updated.
filter

Filter

Optional. Filter over location and bucket.
effective_intelligence_config

EffectiveIntelligenceConfig

Output only. The IntelligenceConfig resource that is applicable for the resource.
trial_config

TrialConfig

The trial configuration of the IntelligenceConfig resource.

EditionConfig

The edition configuration of the IntelligenceConfig resource. This signifies the edition used for configuring the IntelligenceConfig resource and can only take the following values: EDITION_CONFIG_UNSPECIFIED, INHERIT, DISABLED, STANDARD and EVALUATE.

Enums
EDITION_CONFIG_UNSPECIFIED This is an unknown edition of the resource.
INHERIT The inherited edition from the parent and filters. This is the default edition when there is no IntelligenceConfig setup for a GCP resource.
DISABLED The edition configuration is disabled for the IntelligenceConfig resource and its children. Filters are not applicable.
STANDARD The IntelligenceConfig resource is of STANDARD edition.
TRIAL The IntelligenceConfig resource is available in TRIAL edition. During the trial period, Cloud Storage does not charge for Storage Intelligence usage. You can specify the buckets to include in the trial period by using filters. At the end of the trial period, the IntelligenceConfig resource is upgraded to STANDARD edition.

EffectiveIntelligenceConfig

The effective IntelligenceConfig for the resource.

Fields
effective_edition

EffectiveEdition

Output only. The IntelligenceConfig edition that is applicable for the resource.
intelligence_config

string

Output only. The IntelligenceConfig resource that is applied for the target resource. Format: {organizations|folders|projects}/{id}/locations/{location}/intelligenceConfig

EffectiveEdition

The effective edition of the IntelligenceConfig resource.

Enums
EFFECTIVE_EDITION_UNSPECIFIED This is an unknown edition of the resource.
NONE No edition.
STANDARD The IntelligenceConfig resource is of STANDARD edition.

Filter

Filter over location and bucket using include or exclude semantics. Resources that match the include or exclude filter are exclusively included or excluded from the Storage Intelligence plan.

Fields
Union field cloud_storage_locations. Bucket locations to include or exclude. cloud_storage_locations can be only one of the following:
included_cloud_storage_locations

CloudStorageLocations

Bucket locations to include.
excluded_cloud_storage_locations

CloudStorageLocations

Bucket locations to exclude.
Union field cloud_storage_buckets. Buckets to include or exclude. cloud_storage_buckets can be only one of the following:
included_cloud_storage_buckets

CloudStorageBuckets

Buckets to include.
excluded_cloud_storage_buckets

CloudStorageBuckets

Buckets to exclude.

CloudStorageBuckets

Collection of buckets.

Fields
bucket_id_regexes[]

string

Optional. A regex pattern for matching bucket names. Regex should follow the syntax specified in google/re2. For example, ^sample_.* matches all buckets of the form gs://sample_bucket-1, gs://sample_bucket-2, gs://sample_bucket-n but not gs://test_sample_bucket. If you want to match a single bucket, say gs://sample_bucket, use sample_bucket.

CloudStorageLocations

Collection of bucket locations.

Fields
locations[]

string

Optional. Bucket locations. Location can be any of the Cloud Storage regions specified in lower case format. For example, us-east1, us-west1.

TrialConfig

The trial configuration of the IntelligenceConfig resource.

Fields
expire_time

Timestamp

Output only. The time at which the trial expires.

ListAnywhereCachesRequest

Request message for ListAnywhereCaches.

Fields
parent

string

Required. The bucket to which this cache belongs.
page_size

int32

Maximum number of caches to return in a single response. The service will use this parameter or 1,000 items, whichever is smaller.
page_token

string

A previously-returned page token representing part of the larger set of results to view.
request_id

string

Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted.

ListAnywhereCachesResponse

Response message for ListAnywhereCaches.

Fields
anywhere_caches[]

AnywhereCache

The list of items.
next_page_token

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListFoldersRequest

Request message for ListFolders operation. This operation is only applicable to a hierarchical namespace enabled bucket.

Fields
parent

string

Required. The parent bucket of the folder.
page_size

int32

Optional. Maximum number of folders to return in a single response. The service will use this parameter or 1,000 items, whichever is smaller.
page_token

string

Optional. A previously-returned page token representing part of the larger set of results to view.
prefix

string

Optional. Filter results to folders whose names begin with this prefix. If not set or set to an empty string, the method lists all folders in the bucket. If set to a non-empty string, the value must end with a /.
delimiter

string

Optional. If set, returns results in a directory-like mode. The results will only include folders that either exactly match the above prefix, or are one level below the prefix. The only supported value is '/'.
lexicographic_start

string

Optional. Filter results to folders whose names are lexicographically equal to or after lexicographic_start. If lexicographic_end is also set, the folders listed have names between lexicographic_start (inclusive) and lexicographic_end (exclusive).
lexicographic_end

string

Optional. Filter results to folders whose names are lexicographically before lexicographic_end. If lexicographic_start is also set, the folders listed have names between lexicographic_start (inclusive) and lexicographic_end (exclusive).
request_id

string

Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted.

ListFoldersResponse

Response message for ListFolders operation.

Fields
folders[]

Folder

The list of child folders
next_page_token

string

The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.

ListManagedFoldersRequest

Request message for ListManagedFolders.

Fields
parent

string

Required. Name of the bucket this managed folder belongs to.
page_size

int32

Optional. Maximum number of managed folders to return in a single response. The service will use this parameter or 1,000 items, whichever is smaller.
page_token

string

Optional. A previously-returned page token representing part of the larger set of results to view.
prefix

string

Optional. Filter results to match managed folders with name starting with this prefix.
request_id

string

Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted.

ListManagedFoldersResponse

Response message for ListManagedFolders.

Fields
managed_folders[]

ManagedFolder

The list of matching managed folders
next_page_token

string

The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.

ManagedFolder

A managed folder. The ManagedFolder resource represents a managed folder in Cloud Storage. You can apply IAM policies on a managed folder to control access to the resources within the managed folder.

Fields
name

string

Identifier. The name of the managed folder. Format: projects/{project}/buckets/{bucket}/managedFolders/{managedFolder}
metageneration

int64

Output only. The metadata version of this managed folder. It increases whenever the metadata is updated. Used for preconditions and for detecting changes in metadata. Managed folders don't have a generation number.
create_time

Timestamp

Output only. The creation time of the managed folder.
update_time

Timestamp

Output only. The modification time of the managed folder.

PauseAnywhereCacheRequest

Request message for PauseAnywhereCache.

Fields
name

string

Required. The name field in the request should be: projects/{project}/buckets/{bucket}/anywhereCaches/{anywhere_cache}
request_id

string

Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted. This request is only idempotent if a request_id is provided.

PendingRenameInfo

Contains information about a pending rename operation.

Fields
operation

string

Output only. The name of the rename operation.

RenameFolderMetadata

Message returned in the metadata field of the operation resource for RenameFolder operation.

Fields
common_metadata

CommonLongRunningOperationMetadata

Generic metadata for the long running operation.
source_folder_id

string

The path of the source folder.
destination_folder_id

string

The path of the destination folder.

RenameFolderRequest

Request message for RenameFolder operation. This operation is only applicable to a hierarchical namespace enabled bucket.

Fields
name

string

Required. Name of the source folder being renamed. Format: projects/{project}/buckets/{bucket}/folders/{folder}
destination_folder_id

string

Required. The destination folder ID, for example, foo/bar/.
request_id

string

Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted. This request is only idempotent if a request_id is provided.
if_metageneration_match

int64

If set, the request renames the folder if the source folder's metageneration matches this value.
if_metageneration_not_match

int64

If set, the request renames the folder if the source folder's metageneration doesn't match this value.

ResumeAnywhereCacheRequest

Request message for ResumeAnywhereCache.

Fields
name

string

Required. The name field in the request should be: projects/{project}/buckets/{bucket}/anywhereCaches/{anywhere_cache}
request_id

string

Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted. This request is only idempotent if a request_id is provided.

StorageLayout

The storage layout configuration of a bucket.

Fields
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

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

HierarchicalNamespace

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

CustomPlacementConfig

Configuration for Custom Dual Regions. It should specify precisely two eligible regions within the same Multiregion. More information on regions may be found here.

Fields
data_locations[]

string

List of locations to use for data placement.

HierarchicalNamespace

Configuration for a bucket's hierarchical namespace feature.

Fields
enabled

bool

Enables the hierarchical namespace feature.

UpdateAnywhereCacheMetadata

Message returned in the metadata field of the operation resource for UpdateAnywhereCache operation.

Fields
common_metadata

CommonLongRunningOperationMetadata

Generic metadata for the long running operation.
anywhere_cache_id

string

Anywhere Cache ID.
zone

string

The zone in which the cache instance is running. For example, us-central1-a.
ttl

Duration

Anywhere Cache entry's TTL between 1h and 7days. A cache-level config that is applied to all new cache entries on admission. If ttl is pending update, this field equals to the new value specified in the Update request.
admission_policy

string

L4 Cache entry Admission Policy in kebab-case (for example, "admit-on-first-miss"). If admission_policy is pending update, this field equals to the new value specified in the Update request.

UpdateAnywhereCacheRequest

Request message for UpdateAnywhereCache.

Fields
anywhere_cache

AnywhereCache

Required. The Anywhere Cache instance to be updated.
update_mask

FieldMask

Required. List of fields to be updated. Mutable fields of AnywhereCache include ttl and admission_policy.

To specify all fields, specify a single field with the value *.

Note: We recommend against doing this. If a new field is introduced at a later time, an older client updating with the * may accidentally reset the new field's value.

Not specifying any fields results in an error.
request_id

string

Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted. This request is only idempotent if a request_id is provided.

UpdateFolderIntelligenceConfigRequest

Request message to update the IntelligenceConfig resource associated with your folder.

IAM Permissions:

Requires storage.intelligenceConfigs.update IAM permission on the folder.

Fields
intelligence_config

IntelligenceConfig

Required. The IntelligenceConfig resource to be updated.
update_mask

FieldMask

Required. The update_mask that specifies the fields within the IntelligenceConfig resource that should be modified by this update. Only the listed fields are updated.
request_id

string

Optional. The ID that uniquely identifies the request, preventing duplicate processing.

UpdateOrganizationIntelligenceConfigRequest

Request message to update the IntelligenceConfig resource associated with your organization.

IAM Permissions:

Requires storage.intelligenceConfigs.update IAM permission on the organization.

Fields
intelligence_config

IntelligenceConfig

Required. The IntelligenceConfig resource to be updated.
update_mask

FieldMask

Required. The update_mask that specifies the fields within the IntelligenceConfig resource that should be modified by this update. Only the listed fields are updated.
request_id

string

Optional. The ID that uniquely identifies the request, preventing duplicate processing.

UpdateProjectIntelligenceConfigRequest

Request message to update the IntelligenceConfig resource associated with your project.

IAM Permissions:

Requires storage.intelligenceConfigs.update IAM permission on the folder.

Fields
intelligence_config

IntelligenceConfig

Required. The IntelligenceConfig resource to be updated.
update_mask

FieldMask

Required. The update_mask that specifies the fields within the IntelligenceConfig resource that should be modified by this update. Only the listed fields are updated.
request_id

string

Optional. The ID that uniquely identifies the request, preventing duplicate processing.