Package Classes (1.12.0)

Summary of entries of Classes for google-cloud-storage-control.

Classes

StorageControlAsyncClient

StorageControl service includes selected control plane operations.

StorageControlClient

StorageControl service includes selected control plane operations.

ListAnywhereCachesAsyncPager

A pager for iterating through list_anywhere_caches requests.

This class thinly wraps an initial ListAnywhereCachesResponse object, and provides an __aiter__ method to iterate through its anywhere_caches field.

If there are more pages, the __aiter__ method will make additional ListAnywhereCaches requests and continue to iterate through the anywhere_caches field on the corresponding responses.

All the usual ListAnywhereCachesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListAnywhereCachesPager

A pager for iterating through list_anywhere_caches requests.

This class thinly wraps an initial ListAnywhereCachesResponse object, and provides an __iter__ method to iterate through its anywhere_caches field.

If there are more pages, the __iter__ method will make additional ListAnywhereCaches requests and continue to iterate through the anywhere_caches field on the corresponding responses.

All the usual ListAnywhereCachesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListFoldersAsyncPager

A pager for iterating through list_folders requests.

This class thinly wraps an initial ListFoldersResponse object, and provides an __aiter__ method to iterate through its folders field.

If there are more pages, the __aiter__ method will make additional ListFolders requests and continue to iterate through the folders field on the corresponding responses.

All the usual ListFoldersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListFoldersPager

A pager for iterating through list_folders requests.

This class thinly wraps an initial ListFoldersResponse object, and provides an __iter__ method to iterate through its folders field.

If there are more pages, the __iter__ method will make additional ListFolders requests and continue to iterate through the folders field on the corresponding responses.

All the usual ListFoldersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListIntelligenceFindingRevisionsAsyncPager

A pager for iterating through list_intelligence_finding_revisions requests.

This class thinly wraps an initial ListIntelligenceFindingRevisionsResponse object, and provides an __aiter__ method to iterate through its intelligence_finding_revisions field.

If there are more pages, the __aiter__ method will make additional ListIntelligenceFindingRevisions requests and continue to iterate through the intelligence_finding_revisions field on the corresponding responses.

All the usual ListIntelligenceFindingRevisionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListIntelligenceFindingRevisionsPager

A pager for iterating through list_intelligence_finding_revisions requests.

This class thinly wraps an initial ListIntelligenceFindingRevisionsResponse object, and provides an __iter__ method to iterate through its intelligence_finding_revisions field.

If there are more pages, the __iter__ method will make additional ListIntelligenceFindingRevisions requests and continue to iterate through the intelligence_finding_revisions field on the corresponding responses.

All the usual ListIntelligenceFindingRevisionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListIntelligenceFindingsAsyncPager

A pager for iterating through list_intelligence_findings requests.

This class thinly wraps an initial ListIntelligenceFindingsResponse object, and provides an __aiter__ method to iterate through its intelligence_findings field.

If there are more pages, the __aiter__ method will make additional ListIntelligenceFindings requests and continue to iterate through the intelligence_findings field on the corresponding responses.

All the usual ListIntelligenceFindingsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListIntelligenceFindingsPager

A pager for iterating through list_intelligence_findings requests.

This class thinly wraps an initial ListIntelligenceFindingsResponse object, and provides an __iter__ method to iterate through its intelligence_findings field.

If there are more pages, the __iter__ method will make additional ListIntelligenceFindings requests and continue to iterate through the intelligence_findings field on the corresponding responses.

All the usual ListIntelligenceFindingsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListManagedFoldersAsyncPager

A pager for iterating through list_managed_folders requests.

This class thinly wraps an initial ListManagedFoldersResponse object, and provides an __aiter__ method to iterate through its managed_folders field.

If there are more pages, the __aiter__ method will make additional ListManagedFolders requests and continue to iterate through the managed_folders field on the corresponding responses.

All the usual ListManagedFoldersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListManagedFoldersPager

A pager for iterating through list_managed_folders requests.

This class thinly wraps an initial ListManagedFoldersResponse object, and provides an __iter__ method to iterate through its managed_folders field.

If there are more pages, the __iter__ method will make additional ListManagedFolders requests and continue to iterate through the managed_folders field on the corresponding responses.

All the usual ListManagedFoldersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

SummarizeIntelligenceFindingsAsyncPager

A pager for iterating through summarize_intelligence_findings requests.

This class thinly wraps an initial SummarizeIntelligenceFindingsResponse object, and provides an __aiter__ method to iterate through its finding_summaries field.

If there are more pages, the __aiter__ method will make additional SummarizeIntelligenceFindings requests and continue to iterate through the finding_summaries field on the corresponding responses.

All the usual SummarizeIntelligenceFindingsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

SummarizeIntelligenceFindingsPager

A pager for iterating through summarize_intelligence_findings requests.

This class thinly wraps an initial SummarizeIntelligenceFindingsResponse object, and provides an __iter__ method to iterate through its finding_summaries field.

If there are more pages, the __iter__ method will make additional SummarizeIntelligenceFindings requests and continue to iterate through the finding_summaries field on the corresponding responses.

All the usual SummarizeIntelligenceFindingsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

AnywhereCache

An Anywhere Cache Instance.

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.

CreateAnywhereCacheMetadata

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

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

CreateAnywhereCacheRequest

Request message for CreateAnywhereCache.

CreateFolderRequest

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

CreateManagedFolderRequest

Request message for CreateManagedFolder.

DeleteFolderRecursiveMetadata

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

DeleteFolderRecursiveRequest

Request message for DeleteFolderRecursive.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

DeleteFolderRequest

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

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

DeleteManagedFolderRequest

DeleteManagedFolder RPC request message.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

DisableAnywhereCacheRequest

Request message for DisableAnywhereCache.

FindingCategory

List of categories a finding falls under.

FindingSeverity

Severity of the IntelligenceFinding resource.

FindingSummary

A summary of findings generated for an organization, a folder, or a project.

SummaryDetails

Details about the FindingSummary resource.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ResourceType

The list of resource types.

FindingType

List the finding types.

Folder

A folder resource. This resource can only exist in a hierarchical namespace enabled bucket.

GetAnywhereCacheRequest

Request message for GetAnywhereCache.

GetFolderIntelligenceConfigRequest

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

IAM Permissions

Requires storage.intelligenceConfigs.get IAM <https://cloud.google.com/iam/docs/overview#permissions>__ permission on the folder.

GetFolderRequest

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

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

GetIntelligenceFindingRequest

Request message to get the IntelligenceFinding resource associated with a project.

GetIntelligenceFindingRevisionRequest

Request message to get the IntelligenceFindingRevision resource associated with a project.

GetManagedFolderRequest

Request message for GetManagedFolder.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

GetOrganizationIntelligenceConfigRequest

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

IAM Permissions

Requires storage.intelligenceConfigs.get IAM <https://cloud.google.com/iam/docs/overview#permissions>__ permission on the organization.

GetProjectIntelligenceConfigRequest

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

IAM Permissions:

Requires storage.intelligenceConfigs.get IAM <https://cloud.google.com/iam/docs/overview#permissions>__ permission on the project.

GetStorageLayoutRequest

Request message for GetStorageLayout.

IntelligenceConfig

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

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 TRIAL.

EffectiveIntelligenceConfig

The effective IntelligenceConfig for the resource.

EffectiveEdition

The effective edition of the IntelligenceConfig resource.

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.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

CloudStorageBuckets

Collection of buckets.

CloudStorageLocations

Collection of bucket locations.

TrialConfig

The trial configuration of the IntelligenceConfig resource.

IntelligenceFinding

The IntelligenceFinding resource that represents a security, performance, or cost-related finding about a project or bucket.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ColdlineAndArchivalStorageOperationsSpike

Represents a finding about a spike in Class A/B operations on Coldline or Archive Cloud Storage objects. This corresponds to the COLD_AND_ARCHIVAL_STORAGE_OPERATIONS_SPIKE finding type.

BucketContribution

Represents the operation spike details for a bucket.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Contribution

Represents the contribution of the bucket towards the IntelligenceFinding.

PrefixContribution

Represents the operation spike details for an object prefix.

CrossRegionEgressSpike

Represents a finding about a spike in cross-region egress from Cloud Storage. This corresponds to the CROSS_REGION_EGRESS_SPIKE finding type.

BucketContribution

Represents the cross-region egress spike details for a bucket.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Contribution

Represents the contribution of the bucket towards the IntelligenceFinding.

PrefixContribution

Represents the cross-region egress spike details for an object prefix.

StorageGrowthAboveTrend

Represents a finding about a storage growth above the expected trend. This corresponds to the STORAGE_GROWTH_ABOVE_TREND finding type.

BucketContribution

Represents the storage growth details for a bucket.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ThrottledRequestSpike

Represents a finding about a spike in throttled requests (429 errors) within a project. This corresponds to the THROTTLED_REQUEST_SPIKE finding type.

BucketContribution

Represents the throttled requests details for a bucket.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Contribution

Represents the contribution of the bucket towards the IntelligenceFinding.

PrefixContribution

Represents throttled requests details for an object prefix.

IntelligenceFindingRevision

An IntelligenceFindingRevision represents a specific revision of an IntelligenceFinding resource.

ListAnywhereCachesRequest

Request message for ListAnywhereCaches.

ListAnywhereCachesResponse

Response message for ListAnywhereCaches.

ListFoldersRequest

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

ListFoldersResponse

Response message for ListFolders.

ListIntelligenceFindingRevisionsRequest

Request message to list IntelligenceFindingRevision resources associated with a project.

ListIntelligenceFindingRevisionsResponse

Response message to list IntelligenceFindingRevision resources associated with a project.

ListIntelligenceFindingsRequest

Request message to list IntelligenceFinding resources associated with a project.

ListIntelligenceFindingsResponse

Response message to list the IntelligenceFinding resources associated with a project.

ListManagedFoldersRequest

Request message for ListManagedFolders.

ListManagedFoldersResponse

Response message for ListManagedFolders.

ManagedFolder

A managed folder.

PauseAnywhereCacheRequest

Request message for PauseAnywhereCache.

PendingRenameInfo

Contains information about a pending rename operation.

RenameFolderMetadata

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

RenameFolderRequest

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

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ResumeAnywhereCacheRequest

Request message for ResumeAnywhereCache.

StorageLayout

The storage layout configuration of a bucket.

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 <https://cloud.google.com/storage/docs/locations>__.

HierarchicalNamespace

Configuration for a bucket's hierarchical namespace feature.

SummarizeIntelligenceFindingsRequest

Request message to summarize the intelligence findings for the specified scope(org, folder or project).

ResourceScope

The list of resource scopes.

SummarizeIntelligenceFindingsResponse

Response message to summarize the intelligence findings for a specified scope(org, folder or project).

UpdateAnywhereCacheMetadata

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

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

UpdateAnywhereCacheRequest

Request message for UpdateAnywhereCache.

UpdateFolderIntelligenceConfigRequest

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

IAM Permissions:

Requires storage.intelligenceConfigs.update IAM <https://cloud.google.com/iam/docs/overview#permissions>__ permission on the folder.

UpdateOrganizationIntelligenceConfigRequest

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

IAM Permissions:

Requires storage.intelligenceConfigs.update IAM <https://cloud.google.com/iam/docs/overview#permissions>__ permission on the organization.

UpdateProjectIntelligenceConfigRequest

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

IAM Permissions:

Requires storage.intelligenceConfigs.update IAM <https://cloud.google.com/iam/docs/overview#permissions>__ permission on the folder.

Modules

pagers

API documentation for storage_control_v2.services.storage_control.pagers module.