Package Classes (0.4.3)

Summary of entries of Classes for google-cloud-lustre.

Classes

LustreAsyncClient

Service describing handlers for resources

LustreClient

Service describing handlers for resources

ListDirectoryPoliciesAsyncPager

A pager for iterating through list_directory_policies requests.

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

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

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

ListDirectoryPoliciesPager

A pager for iterating through list_directory_policies requests.

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

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

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

ListInstancesAsyncPager

A pager for iterating through list_instances requests.

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

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

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

ListInstancesPager

A pager for iterating through list_instances requests.

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

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

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

ListMirrorsAsyncPager

A pager for iterating through list_mirrors requests.

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

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

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

ListMirrorsPager

A pager for iterating through list_mirrors requests.

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

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

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

AccessRulesOptions

IP-based access rules for the Managed Lustre instance. These options define the root user squash configuration.

AccessRule

A single policy group with IP-based access rules for the Managed Lustre instance.

SquashMode

Squash mode for an access rule.

    If set inside an
    <xref uid="google.cloud.lustre.v1.AccessRulesOptions.AccessRule">AccessRule</xref>,
    root users matching the `ip_ranges][AccessRule.ip_ranges]`
    are not squashed.

    If set as the
    <xref uid="google.cloud.lustre.v1.AccessRulesOptions.default_squash_mode">default_squash_mode</xref>,
    root squash is disabled for this instance.

    If the default squash mode is `NO_SQUASH`, do not set the
    <xref uid="google.cloud.lustre.v1.AccessRulesOptions.default_squash_uid">default_squash_uid</xref>
    or
    <xref uid="google.cloud.lustre.v1.AccessRulesOptions.default_squash_gid">default_squash_gid</xref>,
    or an `invalid argument` error is returned.
ROOT_SQUASH (2):
    Root user squash is enabled.

    Not supported inside an
    <xref uid="google.cloud.lustre.v1.AccessRulesOptions.AccessRule">AccessRule</xref>.

    If set as the
    <xref uid="google.cloud.lustre.v1.AccessRulesOptions.default_squash_mode">default_squash_mode</xref>,
    root users not matching any of the
    <xref uid="google.cloud.lustre.v1.AccessRulesOptions.access_rules">access_rules</xref>
    are squashed to the
    <xref uid="google.cloud.lustre.v1.AccessRulesOptions.default_squash_uid">default_squash_uid</xref>
    and
    <xref uid="google.cloud.lustre.v1.AccessRulesOptions.default_squash_gid">default_squash_gid</xref>.

CreateDirectoryPolicyRequest

Request message for CreateDirectoryPolicy.

CreateInstanceRequest

Message for creating a Instance

CreateMirrorMetadata

Metadata of the create mirror operation.

CreateMirrorRequest

Request for CreateMirror.

DeleteDirectoryPolicyRequest

Request message for DeleteDirectoryPolicy.

DeleteInstanceRequest

Message for deleting a Instance

DeleteMirrorRequest

Request for DeleteMirror.

DirectoryPolicy

A directory policy for a Managed Lustre instance.

State

State of the directory policy.

DynamicTierOptions

Dynamic tier options for a Managed Lustre instance.

Mode

Specifies the Dynamic performance tier for the instance.

If this field is set to DEFAULT_CACHE, per_unit_storage_throughput must not be set or must be set to zero.

ErrorLogEntry

An entry describing an error that has occurred.

ErrorSummary

A summary of errors by error code, plus a count and sample error log entries.

ExportDataMetadata

Metadata of the export data operation.

ExportDataRequest

Export data from Managed Lustre to a Cloud Storage bucket.

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

ExportDataResponse

Response message for ExportData.

GcsPath

Specifies a Cloud Storage bucket and, optionally, a path inside the bucket.

GetDirectoryPolicyRequest

Request message for GetDirectoryPolicy.

GetInstanceRequest

Message for getting a Instance

GetMirrorRequest

Request for GetMirror.

ImportDataMetadata

Metadata of the import data operation.

ImportDataRequest

Message for importing data to Lustre.

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

ImportDataResponse

Response message for ImportData.

Instance

A Managed Lustre instance.

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

LabelsEntry

The abstract base class for a message.

State

The possible states of an instance.

ListDirectoryPoliciesRequest

Request message for ListDirectoryPolicies.

ListDirectoryPoliciesResponse

Response message for ListDirectoryPolicies.

ListInstancesRequest

Message for requesting list of Instances

ListInstancesResponse

Message for response to listing Instances

ListMirrorsRequest

Request for ListMirrors.

ListMirrorsResponse

Response for ListMirrors.

LustrePath

The root directory path to the Lustre file system.

MaintenancePolicy

Defines a maintenance policy for a resource.

MaintenanceExclusionWindow

Exclusion period when maintenance updates should not occur. An exclusion window can be in either of the following two formats:

  • Non-recurring : A full date, with non-zero year, month and day values.
  • Recurring : A month and day value, with a zero year. Time zone is UTC.

WeeklyMaintenanceWindow

Weekly time window in which maintenance updates may occur. Duration of the window is currently fixed at 1 hour. Time zone is UTC.

MaintenanceSchedule

Represents a scheduled maintenance event.

Mirror

Represents a Cloud Storage mirror.

Direction

Represents the direction of the mirror. This enum expects to be extended in future with new mirror types.

LabelsEntry

The abstract base class for a message.

State

State of the mirror.

OperationMetadata

Represents the metadata of a long-running operation.

RescheduleMaintenanceRequest

Message for requesting to reschedule a maintenance event for a specific instance.

Reschedule

The desired reschedule settings.

RescheduleType

The type of rescheduling event. More reschedule types may be added in the future.

TransferCounters

A collection of counters that report the progress of a transfer operation.

TransferOperationMetadata

Represents the metadata of the long-running transfer operation.

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

TransferType

Type of transfer that occurred.

UpdateInstanceRequest

Message for updating a Instance

UpdateMirrorRequest

Request for UpdateMirror.

Modules

pagers

API documentation for lustre_v1.services.lustre.pagers module.