Package Classes (0.1.16)

Summary of entries of Classes for storageinsights.

Classes

StorageInsightsAsyncClient

Service describing handlers for resources

StorageInsightsClient

Service describing handlers for resources

ListDatasetConfigsAsyncPager

A pager for iterating through list_dataset_configs requests.

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

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

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

ListDatasetConfigsPager

A pager for iterating through list_dataset_configs requests.

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

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

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

ListReportConfigsAsyncPager

A pager for iterating through list_report_configs requests.

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

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

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

ListReportConfigsPager

A pager for iterating through list_report_configs requests.

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

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

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

ListReportDetailsAsyncPager

A pager for iterating through list_report_details requests.

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

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

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

ListReportDetailsPager

A pager for iterating through list_report_details requests.

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

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

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

CSVOptions

Options to configure CSV formatted reports.

CloudStorageDestinationOptions

Options to store reports in storage systems. Next ID: 3

CloudStorageFilters

Options to filter data on storage systems. Next ID: 2

CreateDatasetConfigRequest

Request message for [CreateDatasetConfig][google.cloud.storageinsights.v1.StorageInsights.CreateDatasetConfig]

CreateReportConfigRequest

Message for creating a ReportConfig

DatasetConfig

Message describing the dataset configuration properties. For more information, see Dataset configuration properties <https://cloud.google.com/storage/docs/insights/datasets#dataset-config>__.

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

BucketErrors

Provides a summary of the bucket level error statistics.

CloudStorageBuckets

Collection of Cloud Storage buckets.

CloudStorageBucket

Defines the bucket by its name or a regex pattern to match buckets.

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

CloudStorageLocations

Collection of Cloud Storage locations.

ConfigState

State of the configuration.

LabelsEntry

The abstract base class for a message.

Defines the details about the linked dataset.

ProjectErrors

Provides a summary of the project level error statistics.

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

SourceFolders

Specifies a set of folders to include in the dataset

SourceProjects

Collection of project numbers

ValidationErrorsBeforeIngestion

Summary of validation errors that occurred during the verification phase.

DeleteDatasetConfigRequest

Request message for [DeleteDatasetConfig][google.cloud.storageinsights.v1.StorageInsights.DeleteDatasetConfig]

DeleteReportConfigRequest

Message for deleting a ReportConfig

FrequencyOptions

ReportConfig Resource:

Options to setup frequency of report generation.

Frequency

This ENUM specifies possible frequencies of report generation.

GetDatasetConfigRequest

Request message for [GetDatasetConfig][google.cloud.storageinsights.v1.StorageInsights.GetDatasetConfig]

GetReportConfigRequest

Message for getting a ReportConfig

GetReportDetailRequest

Message for getting a ReportDetail

Identity

Identity lets the user provide the type of identity to use, and outputs the identity string that can be used for IAM policy changes.

IdentityType

Type of service account to use for the dataset configuration.

LinkDatasetRequest

Request message for [LinkDataset][google.cloud.storageinsights.v1.StorageInsights.LinkDataset]

LinkDatasetResponse

Response message for [LinkDataset][google.cloud.storageinsights.v1.StorageInsights.LinkDataset]

ListDatasetConfigsRequest

Request message for [ListDatasetConfigs][google.cloud.storageinsights.v1.StorageInsights.ListDatasetConfigs]

ListDatasetConfigsResponse

Response message for [ListDatasetConfigs][google.cloud.storageinsights.v1.StorageInsights.ListDatasetConfigs]

ListReportConfigsRequest

Request message for [ListReportConfigs][google.cloud.storageinsights.v1.StorageInsights.ListReportConfigs]

ListReportConfigsResponse

Message for response to listing ReportConfigs

ListReportDetailsRequest

Message for requesting list of ReportDetails

ListReportDetailsResponse

Message for response to listing ReportDetails

LocationMetadata

Metadata that helps discover which resources are available in a location.

ObjectMetadataReportOptions

Report specification for exporting object metadata. Next ID: 4

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

OperationMetadata

Represents the metadata of the long-running operation.

ParquetOptions

Options to configure Parquet formatted reports.

ReportConfig

Message describing ReportConfig object. ReportConfig is the configuration to generate reports. See https://cloud.google.com/storage/docs/insights/using-inventory-reports#create-config-rest for more details on how to set various fields. Next ID: 12

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

LabelsEntry

The abstract base class for a message.

ReportDetail

Message describing ReportDetail object. ReportDetail represents metadata of generated reports for a ReportConfig. Next ID: 10

LabelsEntry

The abstract base class for a message.

Metrics

Different metrics associated with the generated report.

UnlinkDatasetRequest

Request message for [UnlinkDataset][google.cloud.storageinsights.v1.StorageInsights.UnlinkDataset]

UpdateDatasetConfigRequest

Request message for [UpdateDatasetConfig][google.cloud.storageinsights.v1.StorageInsights.UpdateDatasetConfig]

UpdateReportConfigRequest

Message for updating a ReportConfig

Modules

pagers

API documentation for storageinsights_v1.services.storage_insights.pagers module.