backuplocation¶
Contents¶
-
Services
-
Messages
BackupLocationService¶
BackupLocationService serves and manages backup locations.
GetBackupLocation¶
rpc GetBackupLocation(GetBackupLocationRequest) BackupLocation
Get API returns the backup location.
CreateBackupLocation¶
rpc CreateBackupLocation(CreateBackupLocationRequest) BackupLocation
Create API creates a backup location for a Tenant (Organization).
UpdateBackupLocation¶
rpc UpdateBackupLocation(UpdateBackupLocationRequest) BackupLocation
Update API updates a backup location.
ListBackupLocations¶
rpc ListBackupLocations(ListBackupLocationsRequest) ListBackupLocationsResponse
(-- api-linter: core::0132::http-body=disabled api-linter: core::0132::http-method=disabled aip.dev/not-precedent: We need to do this because we can't have advance filters as query params. --) List API lists all the backup locations for a Tenant (Organization).
DeleteBackupLocation¶
rpc DeleteBackupLocation(DeleteBackupLocationRequest) .google.protobuf.Empty
Delete API deletes a backup location.
Messages¶
AzureBlobStorage¶
Azure blob storage location.
| Field | Type | Description |
|---|---|---|
| container_name | string | Name of container. |
BackupLocation¶
Resource representing a backup location.
| Field | Type | Description |
|---|---|---|
| meta | public.portworx.common.v1.Meta | Metadata of the resource. |
| config | Config | Desired configuration of the backup location. |
| status | Status | Status of the backup location. |
Config¶
Desired configuration of the backup location.
| Field | Type | Description |
|---|---|---|
| provider | public.portworx.platform.cloudcredential.v1.Provider | Type of backup location. |
| cloud_credential_id | string | id of the cloud credential associated with the backup location. |
| oneof Location.azure_storage | AzureBlobStorage | Azure blob storage details. |
| oneof Location.google_storage | GoogleCloudStorage | Google cloud storage details. |
| oneof Location.s3_storage | S3ObjectStorage | S3 object storage details. |
CreateBackupLocationRequest¶
Request to create a backup location.
| Field | Type | Description |
|---|---|---|
| tenant_id | string | The parent Tenant (Organization) id under which backup location will be created. (-- api-linter: core::0133::request-unknown-fields=disabled aip.dev/not-precedent: We need this field for to support creation of the resource in the Tenant (Organization) context. --) |
| backup_location | BackupLocation | Backup location configuration. |
DeleteBackupLocationRequest¶
Request to delete a backup location.
| Field | Type | Description |
|---|---|---|
| id | string | ID of the backup location. |
GetBackupLocationRequest¶
Request to get a backup location.
| Field | Type | Description |
|---|---|---|
| id | string | ID of the backup location. |
GoogleCloudStorage¶
Google cloud storage location.
| Field | Type | Description |
|---|---|---|
| bucket_name | string | Bucket name. |
ListBackupLocationsRequest¶
Request to list the backup locations for a Tenant (Organization) or a project.
| Field | Type | Description |
|---|---|---|
| tenant_id | string | Tenant (Organization) ID for which the backup locations will be listed. |
| pagination | public.portworx.common.v1.PageBasedPaginationRequest | Pagination metadata for this response. |
| label_selector | public.portworx.common.v1.Selector | Provides the key in labels and associated values for which backup locations need to be listed. |
| field_selector | public.portworx.common.v1.Selector | Field selector is used to filter backup locations based on the fields in the backup locations's proto message. |
| infra_resource_selector | public.portworx.common.v1.ResourceSelector | Infra_resource_selector is used to filter backup location based on the infra resources associated with the backup location. Supported infra resource filters: PROJECT. To filter by credentials, use field_selector filter. |
| resp_data | public.portworx.common.v1.RespData | Response data flags for listing backup locations. |
| sort | public.portworx.common.v1.Sort | Sorting details using which requested list of backup locations to be sorted. |
ListBackupLocationsResponse¶
Response of list backup locations.
| Field | Type | Description |
|---|---|---|
| backup_locations | repeated BackupLocation | The list of cloud credentials scoped to a Tenant (Organization) or a project. |
| pagination | public.portworx.common.v1.PageBasedPaginationResponse | Pagination metadata for this response. (-- api-linter: core::0132::response-unknown-fields=disabled aip.dev/not-precedent: We need this field for pagination. --) |
S3ObjectStorage¶
S3 object storage location.
| Field | Type | Description |
|---|---|---|
| bucket_name | string | Bucket name. |
| region | string | Region where bucket is hosted. |
| endpoint | string | Endpoint to reach S3/S3 compatible storage (defaults to s3.amazonaws.com). |
Status¶
Status of the backup location.
| Field | Type | Description |
|---|---|---|
| validity | Status.Validity | Validity of the backup location. |
UpdateBackupLocationRequest¶
Request to update a backup location.
| Field | Type | Description |
|---|---|---|
| update_mask | google.protobuf.FieldMask | Specifies the field that should be updated to the value specified in backup_location. |
| id | string | ID of the backup location. |
| backup_location | BackupLocation | Desired backup location configuration. |
Enums¶
Status.Validity¶
Validity of the backup location.
| Name | Number | Description |
|---|---|---|
| VALIDITY_UNSPECIFIED | 0 | Validity unspecified. |
| VALID | 1 | Valid backup location indicating its reachable. |
| INVALID | 2 | Invalid backup location indicating its unreachable. |
| NOT_APPLICABLE | 3 | NOT_APPLICABLE backup location specifies that status can not be defined. for the backup location eg: S3Compatible location. |