{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
}
}
}
},
"basePath": "",
"baseUrl": "https://gkebackup.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Backup for GKE",
"description": "Backup for GKE is a managed Kubernetes workload backup and restore service for GKE clusters.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "gkebackup:v1",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://gkebackup.mtls.googleapis.com/",
"name": "gkebackup",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"projects": {
"resources": {
"locations": {
"methods": {
"get": {
"description": "Gets information about a location.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}",
"httpMethod": "GET",
"id": "gkebackup.projects.locations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Resource name for the location.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Location"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.",
"flatPath": "v1/projects/{projectsId}/locations",
"httpMethod": "GET",
"id": "gkebackup.projects.locations.list",
"parameterOrder": [
"name"
],
"parameters": {
"extraLocationTypes": {
"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
"location": "query",
"repeated": true,
"type": "string"
},
"filter": {
"description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).",
"location": "query",
"type": "string"
},
"name": {
"description": "The resource that owns the locations collection, if applicable.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "The maximum number of results to return. If not set, the service selects a default.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}/locations",
"response": {
"$ref": "ListLocationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"backupChannels": {
"methods": {
"create": {
"description": "Creates a new BackupChannel in a given location.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupChannels",
"httpMethod": "POST",
"id": "gkebackup.projects.locations.backupChannels.create",
"parameterOrder": [
"parent"
],
"parameters": {
"backupChannelId": {
"description": "Optional. The client-provided short name for the BackupChannel resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of BackupChannels in this location If the user does not provide a name, a uuid will be used as the name.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The location within which to create the BackupChannel. Format: `projects/*/locations/*`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/backupChannels",
"request": {
"$ref": "BackupChannel"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes an existing BackupChannel.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupChannels/{backupChannelsId}",
"httpMethod": "DELETE",
"id": "gkebackup.projects.locations.backupChannels.delete",
"parameterOrder": [
"name"
],
"parameters": {
"etag": {
"description": "Optional. If provided, this value must match the current value of the target BackupChannel's etag field or the request is rejected.",
"location": "query",
"type": "string"
},
"force": {
"description": "Optional. If set to true, any BackupPlanAssociations below this BackupChannel will also be deleted. Otherwise, the request will only succeed if the BackupChannel has no BackupPlanAssociations.",
"location": "query",
"type": "boolean"
},
"name": {
"description": "Required. Fully qualified BackupChannel name. Format: `projects/*/locations/*/backupChannels/*`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/backupChannels/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Retrieve the details of a single BackupChannel.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupChannels/{backupChannelsId}",
"httpMethod": "GET",
"id": "gkebackup.projects.locations.backupChannels.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Fully qualified BackupChannel name. Format: `projects/*/locations/*/backupChannels/*`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/backupChannels/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "BackupChannel"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists BackupChannels in a given location.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupChannels",
"httpMethod": "GET",
"id": "gkebackup.projects.locations.backupChannels.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Field match expression used to filter the results.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Optional. Field by which to sort the results.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. The target number of results to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may include a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. The value of next_page_token received from a previous `ListBackupChannels` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListBackupChannels` must match the call that provided the page token.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The location that contains the BackupChannels to list. Format: `projects/*/locations/*`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/backupChannels",
"response": {
"$ref": "ListBackupChannelsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Update a BackupChannel.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupChannels/{backupChannelsId}",
"httpMethod": "PATCH",
"id": "gkebackup.projects.locations.backupChannels.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Identifier. The fully qualified name of the BackupChannel. `projects/*/locations/*/backupChannels/*`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/backupChannels/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Optional. This is used to specify the fields to be overwritten in the BackupChannel targeted for update. The values for each of these updated fields will be taken from the `backup_channel` provided with this request. Field names are relative to the root of the resource (e.g., `description`, `labels`, etc.) If no `update_mask` is provided, all fields in `backup_channel` will be written to the target BackupChannel resource. Note that OUTPUT_ONLY and IMMUTABLE fields in `backup_channel` are ignored and are not used to update the target BackupChannel.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "BackupChannel"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"backupPlanBindings": {
"methods": {
"get": {
"description": "Retrieve the details of a single BackupPlanBinding.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupChannels/{backupChannelsId}/backupPlanBindings/{backupPlanBindingsId}",
"httpMethod": "GET",
"id": "gkebackup.projects.locations.backupChannels.backupPlanBindings.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Fully qualified BackupPlanBinding name. Format: `projects/*/locations/*/backupChannels/*/backupPlanBindings/*`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/backupChannels/[^/]+/backupPlanBindings/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "BackupPlanBinding"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists BackupPlanBindings in a given location.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupChannels/{backupChannelsId}/backupPlanBindings",
"httpMethod": "GET",
"id": "gkebackup.projects.locations.backupChannels.backupPlanBindings.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Field match expression used to filter the results.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Optional. Field by which to sort the results.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. The target number of results to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may include a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. The value of next_page_token received from a previous `ListBackupPlanBindings` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListBackupPlanBindings` must match the call that provided the page token.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The BackupChannel that contains the BackupPlanBindings to list. Format: `projects/*/locations/*/backupChannels/*`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/backupChannels/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/backupPlanBindings",
"response": {
"$ref": "ListBackupPlanBindingsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"backupPlans": {
"methods": {
"create": {
"description": "Creates a new BackupPlan in a given location.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupPlans",
"httpMethod": "POST",
"id": "gkebackup.projects.locations.backupPlans.create",
"parameterOrder": [
"parent"
],
"parameters": {
"backupPlanId": {
"description": "Required. The client-provided short name for the BackupPlan resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of BackupPlans in this location",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The location within which to create the BackupPlan. Format: `projects/*/locations/*`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/backupPlans",
"request": {
"$ref": "BackupPlan"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes an existing BackupPlan.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}",
"httpMethod": "DELETE",
"id": "gkebackup.projects.locations.backupPlans.delete",
"parameterOrder": [
"name"
],
"parameters": {
"etag": {
"description": "Optional. If provided, this value must match the current value of the target BackupPlan's etag field or the request is rejected.",
"location": "query",
"type": "string"
},
"name": {
"description": "Required. Fully qualified BackupPlan name. Format: `projects/*/locations/*/backupPlans/*`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Retrieve the details of a single BackupPlan.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}",
"httpMethod": "GET",
"id": "gkebackup.projects.locations.backupPlans.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Fully qualified BackupPlan name. Format: `projects/*/locations/*/backupPlans/*`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "BackupPlan"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getIamPolicy": {
"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}:getIamPolicy",
"httpMethod": "GET",
"id": "gkebackup.projects.locations.backupPlans.getIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"options.requestedPolicyVersion": {
"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"format": "int32",
"location": "query",
"type": "integer"
},
"resource": {
"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:getIamPolicy",
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getTags": {
"description": "Returns tags directly bound to a GCP resource.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}:getTags",
"httpMethod": "GET",
"id": "gkebackup.projects.locations.backupPlans.getTags",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The full resource name of the service resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:getTags",
"response": {
"$ref": "GetTagsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists BackupPlans in a given location.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupPlans",
"httpMethod": "GET",
"id": "gkebackup.projects.locations.backupPlans.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Field match expression used to filter the results.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Optional. Field by which to sort the results.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. The target number of results to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may include a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. The value of next_page_token received from a previous `ListBackupPlans` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListBackupPlans` must match the call that provided the page token.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The location that contains the BackupPlans to list. Format: `projects/*/locations/*`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/backupPlans",
"response": {
"$ref": "ListBackupPlansResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Update a BackupPlan.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}",
"httpMethod": "PATCH",
"id": "gkebackup.projects.locations.backupPlans.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Output only. Identifier. The full name of the BackupPlan resource. Format: `projects/*/locations/*/backupPlans/*`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Optional. This is used to specify the fields to be overwritten in the BackupPlan targeted for update. The values for each of these updated fields will be taken from the `backup_plan` provided with this request. Field names are relative to the root of the resource (e.g., `description`, `backup_config.include_volume_data`, etc.) If no `update_mask` is provided, all fields in `backup_plan` will be written to the target BackupPlan resource. Note that OUTPUT_ONLY and IMMUTABLE fields in `backup_plan` are ignored and are not used to update the target BackupPlan.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "BackupPlan"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"setIamPolicy": {
"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}:setIamPolicy",
"httpMethod": "POST",
"id": "gkebackup.projects.locations.backupPlans.setIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:setIamPolicy",
"request": {
"$ref": "SetIamPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"setTags": {
"description": "Updates tags directly bound to a GCP resource.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}:setTags",
"httpMethod": "POST",
"id": "gkebackup.projects.locations.backupPlans.setTags",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The full resource name of the service resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:setTags",
"request": {
"$ref": "SetTagsRequest"
},
"response": {
"$ref": "SetTagsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"testIamPermissions": {
"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}:testIamPermissions",
"httpMethod": "POST",
"id": "gkebackup.projects.locations.backupPlans.testIamPermissions",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:testIamPermissions",
"request": {
"$ref": "TestIamPermissionsRequest"
},
"response": {
"$ref": "TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"backups": {
"methods": {
"create": {
"description": "Creates a Backup for the given BackupPlan.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}/backups",
"httpMethod": "POST",
"id": "gkebackup.projects.locations.backupPlans.backups.create",
"parameterOrder": [
"parent"
],
"parameters": {
"backupId": {
"description": "Optional. The client-provided short name for the Backup resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of Backups in this BackupPlan",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The BackupPlan within which to create the Backup. Format: `projects/*/locations/*/backupPlans/*`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/backups",
"request": {
"$ref": "Backup"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes an existing Backup.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}/backups/{backupsId}",
"httpMethod": "DELETE",
"id": "gkebackup.projects.locations.backupPlans.backups.delete",
"parameterOrder": [
"name"
],
"parameters": {
"etag": {
"description": "Optional. If provided, this value must match the current value of the target Backup's etag field or the request is rejected.",
"location": "query",
"type": "string"
},
"force": {
"description": "Optional. If set to true, any VolumeBackups below this Backup will also be deleted. Otherwise, the request will only succeed if the Backup has no VolumeBackups.",
"location": "query",
"type": "boolean"
},
"name": {
"description": "Required. Name of the Backup resource. Format: `projects/*/locations/*/backupPlans/*/backups/*`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+/backups/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Retrieve the details of a single Backup.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}/backups/{backupsId}",
"httpMethod": "GET",
"id": "gkebackup.projects.locations.backupPlans.backups.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Full name of the Backup resource. Format: `projects/*/locations/*/backupPlans/*/backups/*`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+/backups/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Backup"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getBackupIndexDownloadUrl": {
"description": "Retrieve the link to the backupIndex.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}/backups/{backupsId}:getBackupIndexDownloadUrl",
"httpMethod": "GET",
"id": "gkebackup.projects.locations.backupPlans.backups.getBackupIndexDownloadUrl",
"parameterOrder": [
"backup"
],
"parameters": {
"backup": {
"description": "Required. Full name of Backup resource. Format: projects/{project}/locations/{location}/backupPlans/{backup_plan}/backups/{backup}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+/backups/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+backup}:getBackupIndexDownloadUrl",
"response": {
"$ref": "GetBackupIndexDownloadUrlResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getIamPolicy": {
"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}/backups/{backupsId}:getIamPolicy",
"httpMethod": "GET",
"id": "gkebackup.projects.locations.backupPlans.backups.getIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"options.requestedPolicyVersion": {
"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"format": "int32",
"location": "query",
"type": "integer"
},
"resource": {
"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+/backups/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:getIamPolicy",
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists the Backups for a given BackupPlan.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}/backups",
"httpMethod": "GET",
"id": "gkebackup.projects.locations.backupPlans.backups.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Field match expression used to filter the results.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Optional. Field by which to sort the results.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. The target number of results to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may include a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. The value of next_page_token received from a previous `ListBackups` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListBackups` must match the call that provided the page token.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The BackupPlan that contains the Backups to list. Format: `projects/*/locations/*/backupPlans/*`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+$",
"required": true,
"type": "string"
},
"returnPartialSuccess": {
"description": "Optional. If set to true, the response will return partial results when some regions are unreachable and the unreachable field will be populated.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+parent}/backups",
"response": {
"$ref": "ListBackupsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Update a Backup.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}/backups/{backupsId}",
"httpMethod": "PATCH",
"id": "gkebackup.projects.locations.backupPlans.backups.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Output only. Identifier. The fully qualified name of the Backup. `projects/*/locations/*/backupPlans/*/backups/*`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+/backups/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Optional. This is used to specify the fields to be overwritten in the Backup targeted for update. The values for each of these updated fields will be taken from the `backup_plan` provided with this request. Field names are relative to the root of the resource. If no `update_mask` is provided, all fields in `backup` will be written to the target Backup resource. Note that OUTPUT_ONLY and IMMUTABLE fields in `backup` are ignored and are not used to update the target Backup.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "Backup"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"setIamPolicy": {
"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}/backups/{backupsId}:setIamPolicy",
"httpMethod": "POST",
"id": "gkebackup.projects.locations.backupPlans.backups.setIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+/backups/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:setIamPolicy",
"request": {
"$ref": "SetIamPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"testIamPermissions": {
"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}/backups/{backupsId}:testIamPermissions",
"httpMethod": "POST",
"id": "gkebackup.projects.locations.backupPlans.backups.testIamPermissions",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+/backups/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:testIamPermissions",
"request": {
"$ref": "TestIamPermissionsRequest"
},
"response": {
"$ref": "TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"volumeBackups": {
"methods": {
"get": {
"description": "Retrieve the details of a single VolumeBackup.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}/backups/{backupsId}/volumeBackups/{volumeBackupsId}",
"httpMethod": "GET",
"id": "gkebackup.projects.locations.backupPlans.backups.volumeBackups.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Full name of the VolumeBackup resource. Format: `projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+/backups/[^/]+/volumeBackups/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "VolumeBackup"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getIamPolicy": {
"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}/backups/{backupsId}/volumeBackups/{volumeBackupsId}:getIamPolicy",
"httpMethod": "GET",
"id": "gkebackup.projects.locations.backupPlans.backups.volumeBackups.getIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"options.requestedPolicyVersion": {
"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"format": "int32",
"location": "query",
"type": "integer"
},
"resource": {
"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+/backups/[^/]+/volumeBackups/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:getIamPolicy",
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists the VolumeBackups for a given Backup.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}/backups/{backupsId}/volumeBackups",
"httpMethod": "GET",
"id": "gkebackup.projects.locations.backupPlans.backups.volumeBackups.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Field match expression used to filter the results.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Optional. Field by which to sort the results.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. The target number of results to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may include a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. The value of next_page_token received from a previous `ListVolumeBackups` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListVolumeBackups` must match the call that provided the page token.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The Backup that contains the VolumeBackups to list. Format: `projects/*/locations/*/backupPlans/*/backups/*`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+/backups/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/volumeBackups",
"response": {
"$ref": "ListVolumeBackupsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"setIamPolicy": {
"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}/backups/{backupsId}/volumeBackups/{volumeBackupsId}:setIamPolicy",
"httpMethod": "POST",
"id": "gkebackup.projects.locations.backupPlans.backups.volumeBackups.setIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+/backups/[^/]+/volumeBackups/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:setIamPolicy",
"request": {
"$ref": "SetIamPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"testIamPermissions": {
"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}/backups/{backupsId}/volumeBackups/{volumeBackupsId}:testIamPermissions",
"httpMethod": "POST",
"id": "gkebackup.projects.locations.backupPlans.backups.volumeBackups.testIamPermissions",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+/backups/[^/]+/volumeBackups/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:testIamPermissions",
"request": {
"$ref": "TestIamPermissionsRequest"
},
"response": {
"$ref": "TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
}
}
},
"operations": {
"methods": {
"cancel": {
"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel",
"httpMethod": "POST",
"id": "gkebackup.projects.locations.operations.cancel",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be cancelled.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:cancel",
"request": {
"$ref": "GoogleLongrunningCancelOperationRequest"
},
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
"httpMethod": "DELETE",
"id": "gkebackup.projects.locations.operations.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be deleted.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "gkebackup.projects.locations.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations",
"httpMethod": "GET",
"id": "gkebackup.projects.locations.operations.list",
"parameterOrder": [
"name"
],
"parameters": {
"filter": {
"description": "The standard list filter.",
"location": "query",
"type": "string"
},
"name": {
"description": "The name of the operation's parent resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
},
"returnPartialSuccess": {
"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+name}/operations",
"response": {
"$ref": "GoogleLongrunningListOperationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"restoreChannels": {
"methods": {
"create": {
"description": "Creates a new RestoreChannel in a given location.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/restoreChannels",
"httpMethod": "POST",
"id": "gkebackup.projects.locations.restoreChannels.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The location within which to create the RestoreChannel. Format: `projects/*/locations/*`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
},
"restoreChannelId": {
"description": "Optional. The client-provided short name for the RestoreChannel resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of RestoreChannels in this location If the user does not provide a name, a uuid will be used as the name.",
"location": "query",
"type": "string"
}
},
"path": "v1/{+parent}/restoreChannels",
"request": {
"$ref": "RestoreChannel"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes an existing RestoreChannel.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/restoreChannels/{restoreChannelsId}",
"httpMethod": "DELETE",
"id": "gkebackup.projects.locations.restoreChannels.delete",
"parameterOrder": [
"name"
],
"parameters": {
"etag": {
"description": "Optional. If provided, this value must match the current value of the target RestoreChannel's etag field or the request is rejected.",
"location": "query",
"type": "string"
},
"name": {
"description": "Required. Fully qualified RestoreChannel name. Format: `projects/*/locations/*/restoreChannels/*`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/restoreChannels/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Retrieve the details of a single RestoreChannel.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/restoreChannels/{restoreChannelsId}",
"httpMethod": "GET",
"id": "gkebackup.projects.locations.restoreChannels.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Fully qualified RestoreChannel name. Format: `projects/*/locations/*/restoreChannels/*`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/restoreChannels/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "RestoreChannel"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists RestoreChannels in a given location.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/restoreChannels",
"httpMethod": "GET",
"id": "gkebackup.projects.locations.restoreChannels.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Field match expression used to filter the results.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Optional. Field by which to sort the results.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. The target number of results to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may include a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. The value of next_page_token received from a previous `ListRestoreChannels` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListRestoreChannels` must match the call that provided the page token.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The location that contains the RestoreChannels to list. Format: `projects/*/locations/*`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/restoreChannels",
"response": {
"$ref": "ListRestoreChannelsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Update a RestoreChannel.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/restoreChannels/{restoreChannelsId}",
"httpMethod": "PATCH",
"id": "gkebackup.projects.locations.restoreChannels.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Identifier. The fully qualified name of the RestoreChannel. `projects/*/locations/*/restoreChannels/*`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/restoreChannels/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Optional. This is used to specify the fields to be overwritten in the RestoreChannel targeted for update. The values for each of these updated fields will be taken from the `restore_channel` provided with this request. Field names are relative to the root of the resource (e.g., `description`, `destination_project_id`, etc.) If no `update_mask` is provided, all fields in `restore_channel` will be written to the target RestoreChannel resource. Note that OUTPUT_ONLY and IMMUTABLE fields in `restore_channel` are ignored and are not used to update the target RestoreChannel.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "RestoreChannel"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"restorePlanBindings": {
"methods": {
"get": {
"description": "Retrieve the details of a single RestorePlanBinding.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/restoreChannels/{restoreChannelsId}/restorePlanBindings/{restorePlanBindingsId}",
"httpMethod": "GET",
"id": "gkebackup.projects.locations.restoreChannels.restorePlanBindings.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Fully qualified RestorePlanBinding name. Format: `projects/*/locations/*/restoreChannels/*/restorePlanBindings/*`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/restoreChannels/[^/]+/restorePlanBindings/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "RestorePlanBinding"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists RestorePlanBindings in a given location.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/restoreChannels/{restoreChannelsId}/restorePlanBindings",
"httpMethod": "GET",
"id": "gkebackup.projects.locations.restoreChannels.restorePlanBindings.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Field match expression used to filter the results.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Optional. Field by which to sort the results.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. The target number of results to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may include a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. The value of next_page_token received from a previous `ListRestorePlanBindings` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListRestorePlanBindings` must match the call that provided the page token.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The RestoreChannel that contains the ListRestorePlanBindings to list. Format: `projects/*/locations/*/restoreChannels/*`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/restoreChannels/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/restorePlanBindings",
"response": {
"$ref": "ListRestorePlanBindingsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"restorePlans": {
"methods": {
"create": {
"description": "Creates a new RestorePlan in a given location.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/restorePlans",
"httpMethod": "POST",
"id": "gkebackup.projects.locations.restorePlans.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The location within which to create the RestorePlan. Format: `projects/*/locations/*`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
},
"restorePlanId": {
"description": "Required. The client-provided short name for the RestorePlan resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of RestorePlans in this location",
"location": "query",
"type": "string"
}
},
"path": "v1/{+parent}/restorePlans",
"request": {
"$ref": "RestorePlan"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes an existing RestorePlan.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}",
"httpMethod": "DELETE",
"id": "gkebackup.projects.locations.restorePlans.delete",
"parameterOrder": [
"name"
],
"parameters": {
"etag": {
"description": "Optional. If provided, this value must match the current value of the target RestorePlan's etag field or the request is rejected.",
"location": "query",
"type": "string"
},
"force": {
"description": "Optional. If set to true, any Restores below this RestorePlan will also be deleted. Otherwise, the request will only succeed if the RestorePlan has no Restores.",
"location": "query",
"type": "boolean"
},
"name": {
"description": "Required. Fully qualified RestorePlan name. Format: `projects/*/locations/*/restorePlans/*`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/restorePlans/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Retrieve the details of a single RestorePlan.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}",
"httpMethod": "GET",
"id": "gkebackup.projects.locations.restorePlans.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Fully qualified RestorePlan name. Format: `projects/*/locations/*/restorePlans/*`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/restorePlans/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "RestorePlan"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getIamPolicy": {
"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}:getIamPolicy",
"httpMethod": "GET",
"id": "gkebackup.projects.locations.restorePlans.getIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"options.requestedPolicyVersion": {
"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"format": "int32",
"location": "query",
"type": "integer"
},
"resource": {
"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/restorePlans/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:getIamPolicy",
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getTags": {
"description": "Returns tags directly bound to a GCP resource.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}:getTags",
"httpMethod": "GET",
"id": "gkebackup.projects.locations.restorePlans.getTags",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The full resource name of the service resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/restorePlans/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:getTags",
"response": {
"$ref": "GetTagsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists RestorePlans in a given location.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/restorePlans",
"httpMethod": "GET",
"id": "gkebackup.projects.locations.restorePlans.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Field match expression used to filter the results.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Optional. Field by which to sort the results.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. The target number of results to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may include a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. The value of next_page_token received from a previous `ListRestorePlans` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListRestorePlans` must match the call that provided the page token.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The location that contains the RestorePlans to list. Format: `projects/*/locations/*`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/restorePlans",
"response": {
"$ref": "ListRestorePlansResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Update a RestorePlan.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}",
"httpMethod": "PATCH",
"id": "gkebackup.projects.locations.restorePlans.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Output only. Identifier. The full name of the RestorePlan resource. Format: `projects/*/locations/*/restorePlans/*`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/restorePlans/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Optional. This is used to specify the fields to be overwritten in the RestorePlan targeted for update. The values for each of these updated fields will be taken from the `restore_plan` provided with this request. Field names are relative to the root of the resource. If no `update_mask` is provided, all fields in `restore_plan` will be written to the target RestorePlan resource. Note that OUTPUT_ONLY and IMMUTABLE fields in `restore_plan` are ignored and are not used to update the target RestorePlan.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "RestorePlan"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"setIamPolicy": {
"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}:setIamPolicy",
"httpMethod": "POST",
"id": "gkebackup.projects.locations.restorePlans.setIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/restorePlans/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:setIamPolicy",
"request": {
"$ref": "SetIamPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"setTags": {
"description": "Updates tags directly bound to a GCP resource.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}:setTags",
"httpMethod": "POST",
"id": "gkebackup.projects.locations.restorePlans.setTags",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The full resource name of the service resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/restorePlans/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:setTags",
"request": {
"$ref": "SetTagsRequest"
},
"response": {
"$ref": "SetTagsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"testIamPermissions": {
"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}:testIamPermissions",
"httpMethod": "POST",
"id": "gkebackup.projects.locations.restorePlans.testIamPermissions",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/restorePlans/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:testIamPermissions",
"request": {
"$ref": "TestIamPermissionsRequest"
},
"response": {
"$ref": "TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"restores": {
"methods": {
"create": {
"description": "Creates a new Restore for the given RestorePlan.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}/restores",
"httpMethod": "POST",
"id": "gkebackup.projects.locations.restorePlans.restores.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The RestorePlan within which to create the Restore. Format: `projects/*/locations/*/restorePlans/*`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/restorePlans/[^/]+$",
"required": true,
"type": "string"
},
"restoreId": {
"description": "Required. The client-provided short name for the Restore resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of Restores in this RestorePlan.",
"location": "query",
"type": "string"
}
},
"path": "v1/{+parent}/restores",
"request": {
"$ref": "Restore"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes an existing Restore.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}/restores/{restoresId}",
"httpMethod": "DELETE",
"id": "gkebackup.projects.locations.restorePlans.restores.delete",
"parameterOrder": [
"name"
],
"parameters": {
"etag": {
"description": "Optional. If provided, this value must match the current value of the target Restore's etag field or the request is rejected.",
"location": "query",
"type": "string"
},
"force": {
"description": "Optional. If set to true, any VolumeRestores below this restore will also be deleted. Otherwise, the request will only succeed if the restore has no VolumeRestores.",
"location": "query",
"type": "boolean"
},
"name": {
"description": "Required. Full name of the Restore Format: `projects/*/locations/*/restorePlans/*/restores/*`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/restorePlans/[^/]+/restores/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Retrieves the details of a single Restore.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}/restores/{restoresId}",
"httpMethod": "GET",
"id": "gkebackup.projects.locations.restorePlans.restores.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the restore resource. Format: `projects/*/locations/*/restorePlans/*/restores/*`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/restorePlans/[^/]+/restores/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Restore"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getIamPolicy": {
"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}/restores/{restoresId}:getIamPolicy",
"httpMethod": "GET",
"id": "gkebackup.projects.locations.restorePlans.restores.getIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"options.requestedPolicyVersion": {
"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"format": "int32",
"location": "query",
"type": "integer"
},
"resource": {
"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/restorePlans/[^/]+/restores/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:getIamPolicy",
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists the Restores for a given RestorePlan.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}/restores",
"httpMethod": "GET",
"id": "gkebackup.projects.locations.restorePlans.restores.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Field match expression used to filter the results.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Optional. Field by which to sort the results.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. The target number of results to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may include a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. The value of next_page_token received from a previous `ListRestores` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListRestores` must match the call that provided the page token.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The RestorePlan that contains the Restores to list. Format: `projects/*/locations/*/restorePlans/*`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/restorePlans/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/restores",
"response": {
"$ref": "ListRestoresResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Update a Restore.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}/restores/{restoresId}",
"httpMethod": "PATCH",
"id": "gkebackup.projects.locations.restorePlans.restores.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Output only. Identifier. The full name of the Restore resource. Format: `projects/*/locations/*/restorePlans/*/restores/*`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/restorePlans/[^/]+/restores/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Optional. This is used to specify the fields to be overwritten in the Restore targeted for update. The values for each of these updated fields will be taken from the `restore` provided with this request. Field names are relative to the root of the resource. If no `update_mask` is provided, all fields in `restore` will be written to the target Restore resource. Note that OUTPUT_ONLY and IMMUTABLE fields in `restore` are ignored and are not used to update the target Restore.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "Restore"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"setIamPolicy": {
"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}/restores/{restoresId}:setIamPolicy",
"httpMethod": "POST",
"id": "gkebackup.projects.locations.restorePlans.restores.setIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/restorePlans/[^/]+/restores/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:setIamPolicy",
"request": {
"$ref": "SetIamPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"testIamPermissions": {
"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}/restores/{restoresId}:testIamPermissions",
"httpMethod": "POST",
"id": "gkebackup.projects.locations.restorePlans.restores.testIamPermissions",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/restorePlans/[^/]+/restores/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:testIamPermissions",
"request": {
"$ref": "TestIamPermissionsRequest"
},
"response": {
"$ref": "TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"volumeRestores": {
"methods": {
"get": {
"description": "Retrieve the details of a single VolumeRestore.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}/restores/{restoresId}/volumeRestores/{volumeRestoresId}",
"httpMethod": "GET",
"id": "gkebackup.projects.locations.restorePlans.restores.volumeRestores.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Full name of the VolumeRestore resource. Format: `projects/*/locations/*/restorePlans/*/restores/*/volumeRestores/*`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/restorePlans/[^/]+/restores/[^/]+/volumeRestores/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "VolumeRestore"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getIamPolicy": {
"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}/restores/{restoresId}/volumeRestores/{volumeRestoresId}:getIamPolicy",
"httpMethod": "GET",
"id": "gkebackup.projects.locations.restorePlans.restores.volumeRestores.getIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"options.requestedPolicyVersion": {
"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"format": "int32",
"location": "query",
"type": "integer"
},
"resource": {
"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/restorePlans/[^/]+/restores/[^/]+/volumeRestores/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:getIamPolicy",
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists the VolumeRestores for a given Restore.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}/restores/{restoresId}/volumeRestores",
"httpMethod": "GET",
"id": "gkebackup.projects.locations.restorePlans.restores.volumeRestores.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Field match expression used to filter the results.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Optional. Field by which to sort the results.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. The target number of results to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may include a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. The value of next_page_token received from a previous `ListVolumeRestores` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListVolumeRestores` must match the call that provided the page token.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The Restore that contains the VolumeRestores to list. Format: `projects/*/locations/*/restorePlans/*/restores/*`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/restorePlans/[^/]+/restores/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/volumeRestores",
"response": {
"$ref": "ListVolumeRestoresResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"setIamPolicy": {
"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}/restores/{restoresId}/volumeRestores/{volumeRestoresId}:setIamPolicy",
"httpMethod": "POST",
"id": "gkebackup.projects.locations.restorePlans.restores.volumeRestores.setIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/restorePlans/[^/]+/restores/[^/]+/volumeRestores/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:setIamPolicy",
"request": {
"$ref": "SetIamPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"testIamPermissions": {
"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}/restores/{restoresId}/volumeRestores/{volumeRestoresId}:testIamPermissions",
"httpMethod": "POST",
"id": "gkebackup.projects.locations.restorePlans.restores.volumeRestores.testIamPermissions",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/restorePlans/[^/]+/restores/[^/]+/volumeRestores/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:testIamPermissions",
"request": {
"$ref": "TestIamPermissionsRequest"
},
"response": {
"$ref": "TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
}
}
}
}
}
}
}
},
"revision": "20260213",
"rootUrl": "https://gkebackup.googleapis.com/",
"schemas": {
"AuditConfig": {
"description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.",
"id": "AuditConfig",
"properties": {
"auditLogConfigs": {
"description": "The configuration for logging of each type of permission.",
"items": {
"$ref": "AuditLogConfig"
},
"type": "array"
},
"service": {
"description": "Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.",
"type": "string"
}
},
"type": "object"
},
"AuditLogConfig": {
"description": "Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.",
"id": "AuditLogConfig",
"properties": {
"exemptedMembers": {
"description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.",
"items": {
"type": "string"
},
"type": "array"
},
"logType": {
"description": "The log type that this config enables.",
"enum": [
"LOG_TYPE_UNSPECIFIED",
"ADMIN_READ",
"DATA_WRITE",
"DATA_READ"
],
"enumDescriptions": [
"Default case. Should never be this.",
"Admin reads. Example: CloudIAM getIamPolicy",
"Data writes. Example: CloudSQL Users create",
"Data reads. Example: CloudSQL Users list"
],
"type": "string"
}
},
"type": "object"
},
"BDRBackupPlanJobLog": {
"description": "Log entry for BDRBackupPlanJobLog for resources using BackupPlan based protection.",
"id": "BDRBackupPlanJobLog",
"properties": {
"backupPlanName": {
"description": "Canonical resource name for Backup Plan Plan of the job.",
"type": "string"
},
"endTime": {
"description": "End time of the job.",
"format": "google-datetime",
"type": "string"
},
"errorCode": {
"description": "The error code. Only populated in error scenarios.",
"format": "int32",
"type": "integer"
},
"errorMessage": {
"description": "The user readable error message. Only populated in error scenarios.",
"type": "string"
},
"errorType": {
"description": "The name of the error type eg. PERMISSION_DENIED. Only populated in error scenarios.",
"type": "string"
},
"jobCategory": {
"description": "The category field displays the category of the job. Can be one of [UPDATE_BACKUP_PLAN].",
"type": "string"
},
"jobId": {
"description": "The job_id field displays the identifier of the job being reported.",
"type": "string"
},
"jobStatus": {
"description": "The status field displays the status of the job. Can be one of [RUNNING,SUCCESSFUL, FAILED].",
"type": "string"
},
"newBackupPlanRevisionId": {
"description": "User friendly revision id e.g. v0, v1 etc.",
"type": "string"
},
"newBackupPlanRevisionName": {
"description": "Full resource name for new backup plan revision",
"type": "string"
},
"previousBackupPlanRevisionId": {
"description": "User friendly revision id e.g. v0, v1 etc.",
"type": "string"
},
"previousBackupPlanRevisionName": {
"description": "Full resource name for previous backup plan revision",
"type": "string"
},
"previousBackupRules": {
"description": "Previous Backup Plan rules.",
"items": {
"$ref": "BackupRuleDetail"
},
"type": "array"
},
"resourceType": {
"description": "The resource_type field displays the type of the protected resource.",
"type": "string"
},
"revisedBackupRules": {
"description": "Revised Backup Plan rules.",
"items": {
"$ref": "BackupRuleDetail"
},
"type": "array"
},
"startTime": {
"description": "Start time of the job.",
"format": "google-datetime",
"type": "string"
},
"workloadsAffectedCount": {
"description": "The total number of workloads affected by the job.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"BDRBackupRestoreJobLog": {
"description": "Log entry for Backup and Restore Job for resources using BackupPlan based protection. Next Id: 23",
"id": "BDRBackupRestoreJobLog",
"properties": {
"backupConsistencyTime": {
"description": "Backup consistency time.",
"format": "google-datetime",
"type": "string"
},
"backupName": {
"description": "Full resource name of the backup created in backup jobs and used in restore jobs.",
"type": "string"
},
"backupPlanName": {
"description": "Full resource name for Backup Plan of the job. Only populated for Scheduled Backup and Adhoc Backup.",
"type": "string"
},
"backupRetentionDays": {
"description": "Backup retention in days.",
"format": "int32",
"type": "integer"
},
"backupRule": {
"description": "Name of the backup rule. Only populated for Scheduled Backup and Adhoc Backup.",
"type": "string"
},
"backupVaultName": {
"description": "Full resource name backup vault name",
"type": "string"
},
"endTime": {
"description": "End time of the job.",
"format": "google-datetime",
"type": "string"
},
"errorCode": {
"description": "The error code. Only populated in error scenarios.",
"format": "int32",
"type": "integer"
},
"errorMessage": {
"description": "The user readable error message. Only populated in error scenarios.",
"type": "string"
},
"errorType": {
"description": "The name of the error type eg. PERMISSION_DENIED. Only populated in error scenarios.",
"type": "string"
},
"incrementalBackupSizeGib": {
"description": "The amount of incremental backup data copied.",
"format": "double",
"type": "number"
},
"jobCategory": {
"description": "The category field displays the category of the job.",
"type": "string"
},
"jobId": {
"description": "The job_id field displays the identifier of the job being logged.",
"type": "string"
},
"jobStatus": {
"description": "The status field displays the status of the job.",
"type": "string"
},
"recoveryPointTime": {
"description": "Recovery point time.",
"format": "google-datetime",
"type": "string"
},
"resourceType": {
"description": "The resource_type field displays the type of the protected resource.",
"type": "string"
},
"restoreResourceLocation": {
"description": "Restore resource location.",
"type": "string"
},
"restoreResourceName": {
"description": "Full resource name of the restore resource. Only populated in restore jobs.",
"type": "string"
},
"sourceResourceId": {
"description": "The source resource ID.",
"type": "string"
},
"sourceResourceLocation": {
"description": "Source resource location.",
"type": "string"
},
"sourceResourceName": {
"description": "Full resource name of the protected resource.",
"type": "string"
},
"startTime": {
"description": "Start time of the job.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"Backup": {
"description": "Represents a request to perform a single point-in-time capture of some portion of the state of a GKE cluster, the record of the backup operation itself, and an anchor for the underlying artifacts that comprise the Backup (the config backup and VolumeBackups).",
"id": "Backup",
"properties": {
"allNamespaces": {
"description": "Output only. If True, all namespaces were included in the Backup.",
"readOnly": true,
"type": "boolean"
},
"clusterMetadata": {
"$ref": "ClusterMetadata",
"description": "Output only. Information about the GKE cluster from which this Backup was created.",
"readOnly": true
},
"completeTime": {
"description": "Output only. Completion time of the Backup",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"configBackupSizeBytes": {
"description": "Output only. The size of the config backup in bytes.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"containsSecrets": {
"description": "Output only. Whether or not the Backup contains Kubernetes Secrets. Controlled by the parent BackupPlan's include_secrets value.",
"readOnly": true,
"type": "boolean"
},
"containsVolumeData": {
"description": "Output only. Whether or not the Backup contains volume data. Controlled by the parent BackupPlan's include_volume_data value.",
"readOnly": true,
"type": "boolean"
},
"createTime": {
"description": "Output only. The timestamp when this Backup resource was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"deleteLockDays": {
"description": "Optional. Minimum age for this Backup (in days). If this field is set to a non-zero value, the Backup will be \"locked\" against deletion (either manual or automatic deletion) for the number of days provided (measured from the creation time of the Backup). MUST be an integer value between 0-90 (inclusive). Defaults to parent BackupPlan's backup_delete_lock_days setting and may only be increased (either at creation time or in a subsequent update).",
"format": "int32",
"type": "integer"
},
"deleteLockExpireTime": {
"description": "Output only. The time at which an existing delete lock will expire for this backup (calculated from create_time + delete_lock_days).",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Optional. User specified descriptive string for this Backup.",
"type": "string"
},
"encryptionKey": {
"$ref": "EncryptionKey",
"description": "Output only. The customer managed encryption key that was used to encrypt the Backup's artifacts. Inherited from the parent BackupPlan's encryption_key value.",
"readOnly": true
},
"etag": {
"description": "Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a backup from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform backup updates in order to avoid race conditions: An `etag` is returned in the response to `GetBackup`, and systems are expected to put that etag in the request to `UpdateBackup` or `DeleteBackup` to ensure that their change will be applied to the same version of the resource.",
"readOnly": true,
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. A set of custom labels supplied by user.",
"type": "object"
},
"manual": {
"description": "Output only. This flag indicates whether this Backup resource was created manually by a user or via a schedule in the BackupPlan. A value of True means that the Backup was created manually.",
"readOnly": true,
"type": "boolean"
},
"name": {
"description": "Output only. Identifier. The fully qualified name of the Backup. `projects/*/locations/*/backupPlans/*/backups/*`",
"readOnly": true,
"type": "string"
},
"namespaceCount": {
"description": "Output only. The total number of user managed namespaces contained in the Backup.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"permissiveMode": {
"description": "Output only. If false, Backup will fail when Backup for GKE detects Kubernetes configuration that is non-standard or requires additional setup to restore. Inherited from the parent BackupPlan's permissive_mode value.",
"readOnly": true,
"type": "boolean"
},
"podCount": {
"description": "Output only. The total number of Kubernetes Pods contained in the Backup.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"resourceCount": {
"description": "Output only. The total number of Kubernetes resources included in the Backup.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"retainDays": {
"description": "Optional. The age (in days) after which this Backup will be automatically deleted. Must be an integer value >= 0: - If 0, no automatic deletion will occur for this Backup. - If not 0, this must be >= delete_lock_days and <= 365. Once a Backup is created, this value may only be increased. Defaults to the parent BackupPlan's backup_retain_days value.",
"format": "int32",
"type": "integer"
},
"retainExpireTime": {
"description": "Output only. The time at which this Backup will be automatically deleted (calculated from create_time + retain_days).",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"satisfiesPzi": {
"description": "Output only. [Output Only] Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"satisfiesPzs": {
"description": "Output only. [Output Only] Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"selectedApplications": {
"$ref": "NamespacedNames",
"description": "Output only. If set, the list of ProtectedApplications whose resources were included in the Backup.",
"readOnly": true
},
"selectedNamespaceLabels": {
"$ref": "ResourceLabels",
"description": "Output only. If set, the list of labels whose constituent namespaces were included in the Backup.",
"readOnly": true
},
"selectedNamespaces": {
"$ref": "Namespaces",
"description": "Output only. If set, the list of namespaces that were included in the Backup.",
"readOnly": true
},
"sizeBytes": {
"description": "Output only. The total size of the Backup in bytes = config backup size + sum(volume backup sizes)",
"format": "int64",
"readOnly": true,
"type": "string"
},
"state": {
"description": "Output only. Current state of the Backup",
"enum": [
"STATE_UNSPECIFIED",
"CREATING",
"IN_PROGRESS",
"SUCCEEDED",
"FAILED",
"DELETING"
],
"enumDescriptions": [
"The Backup resource is in the process of being created.",
"The Backup resource has been created and the associated BackupJob Kubernetes resource has been injected into the source cluster.",
"The gkebackup agent in the cluster has begun executing the backup operation.",
"The backup operation has completed successfully.",
"The backup operation has failed.",
"This Backup resource (and its associated artifacts) is in the process of being deleted."
],
"readOnly": true,
"type": "string"
},
"stateReason": {
"description": "Output only. Human-readable description of why the backup is in the current `state`. This field is only meant for human readability and should not be used programmatically as this field is not guaranteed to be consistent.",
"readOnly": true,
"type": "string"
},
"troubleshootingInfo": {
"$ref": "TroubleshootingInfo",
"description": "Output only. Information about the troubleshooting steps which will provide debugging information to the end users.",
"readOnly": true
},
"uid": {
"description": "Output only. Server generated global unique identifier of [UUID4](https://en.wikipedia.org/wiki/Universally_unique_identifier)",
"readOnly": true,
"type": "string"
},
"updateTime": {
"description": "Output only. The timestamp when this Backup resource was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"volumeCount": {
"description": "Output only. The total number of volume backups contained in the Backup.",
"format": "int32",
"readOnly": true,
"type": "integer"
}
},
"type": "object"
},
"BackupChannel": {
"description": "A BackupChannel imposes constraints on where clusters can be backed up. The BackupChannel should be in the same project and region as the cluster being backed up. The backup can be created only in destination_project.",
"id": "BackupChannel",
"properties": {
"createTime": {
"description": "Output only. The timestamp when this BackupChannel resource was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Optional. User specified descriptive string for this BackupChannel.",
"type": "string"
},
"destinationProject": {
"description": "Required. Immutable. The project where Backups are allowed to be stored. The format is `projects/{projectId}` or `projects/{projectNumber}`.",
"type": "string"
},
"destinationProjectId": {
"description": "Output only. The project_id where Backups are allowed to be stored. Example Project ID: \"my-project-id\". This will be an OUTPUT_ONLY field to return the project_id of the destination project.",
"readOnly": true,
"type": "string"
},
"etag": {
"description": "Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a BackupChannel from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform BackupChannel updates in order to avoid race conditions: An `etag` is returned in the response to `GetBackupChannel`, and systems are expected to put that etag in the request to `UpdateBackupChannel` or `DeleteBackupChannel` to ensure that their change will be applied to the same version of the resource.",
"readOnly": true,
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. A set of custom labels supplied by user.",
"type": "object"
},
"name": {
"description": "Identifier. The fully qualified name of the BackupChannel. `projects/*/locations/*/backupChannels/*`",
"type": "string"
},
"uid": {
"description": "Output only. Server generated global unique identifier of [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format.",
"readOnly": true,
"type": "string"
},
"updateTime": {
"description": "Output only. The timestamp when this BackupChannel resource was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"BackupConfig": {
"description": "BackupConfig defines the configuration of Backups created via this BackupPlan.",
"id": "BackupConfig",
"properties": {
"allNamespaces": {
"description": "If True, include all namespaced resources",
"type": "boolean"
},
"encryptionKey": {
"$ref": "EncryptionKey",
"description": "Optional. This defines a customer managed encryption key that will be used to encrypt the \"config\" portion (the Kubernetes resources) of Backups created via this plan. Default (empty): Config backup artifacts will not be encrypted."
},
"includeSecrets": {
"description": "Optional. This flag specifies whether Kubernetes Secret resources should be included when they fall into the scope of Backups. Default: False",
"type": "boolean"
},
"includeVolumeData": {
"description": "Optional. This flag specifies whether volume data should be backed up when PVCs are included in the scope of a Backup. Default: False",
"type": "boolean"
},
"permissiveMode": {
"description": "Optional. If false, Backups will fail when Backup for GKE detects Kubernetes configuration that is non-standard or requires additional setup to restore. Default: False",
"type": "boolean"
},
"selectedApplications": {
"$ref": "NamespacedNames",
"description": "If set, include just the resources referenced by the listed ProtectedApplications."
},
"selectedNamespaceLabels": {
"$ref": "ResourceLabels",
"description": "If set, the list of labels whose constituent namespaces were included in the Backup."
},
"selectedNamespaces": {
"$ref": "Namespaces",
"description": "If set, include just the resources in the listed namespaces."
}
},
"type": "object"
},
"BackupConfigDetails": {
"description": "BackupConfigDetails defines the configuration of Backups created via this BackupPlan.",
"id": "BackupConfigDetails",
"properties": {
"allNamespaces": {
"description": "Output only. If True, include all namespaced resources",
"readOnly": true,
"type": "boolean"
},
"encryptionKey": {
"$ref": "EncryptionKey",
"description": "Output only. This defines a customer managed encryption key that will be used to encrypt the \"config\" portion (the Kubernetes resources) of Backups created via this plan. Default (empty): Config backup artifacts will not be encrypted.",
"readOnly": true
},
"includeSecrets": {
"description": "Output only. This flag specifies whether Kubernetes Secret resources should be included when they fall into the scope of Backups. Default: False",
"readOnly": true,
"type": "boolean"
},
"includeVolumeData": {
"description": "Output only. This flag specifies whether volume data should be backed up when PVCs are included in the scope of a Backup. Default: False",
"readOnly": true,
"type": "boolean"
},
"selectedApplications": {
"$ref": "NamespacedNames",
"description": "Output only. If set, include just the resources referenced by the listed ProtectedApplications.",
"readOnly": true
},
"selectedNamespaces": {
"$ref": "Namespaces",
"description": "Output only. If set, include just the resources in the listed namespaces.",
"readOnly": true
}
},
"type": "object"
},
"BackupPlan": {
"description": "Defines the configuration and scheduling for a \"line\" of Backups.",
"id": "BackupPlan",
"properties": {
"backupChannel": {
"description": "Output only. The fully qualified name of the BackupChannel to be used to create a backup. This field is set only if the cluster being backed up is in a different project. `projects/*/locations/*/backupChannels/*`",
"readOnly": true,
"type": "string"
},
"backupConfig": {
"$ref": "BackupConfig",
"description": "Optional. Defines the configuration of Backups created via this BackupPlan."
},
"backupSchedule": {
"$ref": "Schedule",
"description": "Optional. Defines a schedule for automatic Backup creation via this BackupPlan."
},
"cluster": {
"description": "Required. Immutable. The source cluster from which Backups will be created via this BackupPlan. Valid formats: - `projects/*/locations/*/clusters/*` - `projects/*/zones/*/clusters/*`",
"type": "string"
},
"createTime": {
"description": "Output only. The timestamp when this BackupPlan resource was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"deactivated": {
"description": "Optional. This flag indicates whether this BackupPlan has been deactivated. Setting this field to True locks the BackupPlan such that no further updates will be allowed (except deletes), including the deactivated field itself. It also prevents any new Backups from being created via this BackupPlan (including scheduled Backups). Default: False",
"type": "boolean"
},
"description": {
"description": "Optional. User specified descriptive string for this BackupPlan.",
"type": "string"
},
"etag": {
"description": "Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a backup plan from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform BackupPlan updates in order to avoid race conditions: An `etag` is returned in the response to `GetBackupPlan`, and systems are expected to put that etag in the request to `UpdateBackupPlan` or `DeleteBackupPlan` to ensure that their change will be applied to the same version of the resource.",
"readOnly": true,
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. A set of custom labels supplied by user.",
"type": "object"
},
"lastSuccessfulBackupTime": {
"description": "Output only. Completion time of the last successful Backup. This is sourced from a successful Backup's complete_time field. This field is added to maintain consistency with BackupPlanBinding to display last successful backup time.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Output only. Identifier. The full name of the BackupPlan resource. Format: `projects/*/locations/*/backupPlans/*`",
"readOnly": true,
"type": "string"
},
"protectedNamespaceCount": {
"description": "Output only. The number of user managed namespaces backed up in the last successful Backup created via this BackupPlan.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"protectedPodCount": {
"description": "Output only. The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"retentionPolicy": {
"$ref": "RetentionPolicy",
"description": "Optional. RetentionPolicy governs lifecycle of Backups created under this plan."
},
"rpoRiskLevel": {
"description": "Output only. A number that represents the current risk level of this BackupPlan from RPO perspective with 1 being no risk and 5 being highest risk.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"rpoRiskReason": {
"description": "Output only. Human-readable description of why the BackupPlan is in the current rpo_risk_level and action items if any.",
"readOnly": true,
"type": "string"
},
"state": {
"description": "Output only. State of the BackupPlan. This State field reflects the various stages a BackupPlan can be in during the Create operation. It will be set to \"DEACTIVATED\" if the BackupPlan is deactivated on an Update",
"enum": [
"STATE_UNSPECIFIED",
"CLUSTER_PENDING",
"PROVISIONING",
"READY",
"FAILED",
"DEACTIVATED",
"DELETING"
],
"enumDescriptions": [
"Default first value for Enums.",
"Waiting for cluster state to be RUNNING.",
"The BackupPlan is in the process of being created.",
"The BackupPlan has successfully been created and is ready for Backups.",
"BackupPlan creation has failed.",
"The BackupPlan has been deactivated.",
"The BackupPlan is in the process of being deleted."
],
"readOnly": true,
"type": "string"
},
"stateReason": {
"description": "Output only. Human-readable description of why BackupPlan is in the current `state`. This field is only meant for human readability and should not be used programmatically as this field is not guaranteed to be consistent.",
"readOnly": true,
"type": "string"
},
"uid": {
"description": "Output only. Server generated global unique identifier of [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format.",
"readOnly": true,
"type": "string"
},
"updateTime": {
"description": "Output only. The timestamp when this BackupPlan resource was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"BackupPlanBinding": {
"description": "A BackupPlanBinding binds a BackupPlan with a BackupChannel. This resource is created automatically when a BackupPlan is created using a BackupChannel. This also serves as a holder for cross-project fields that need to be displayed in the current project.",
"id": "BackupPlanBinding",
"properties": {
"backupPlan": {
"description": "Output only. Immutable. The fully qualified name of the BackupPlan bound with the parent BackupChannel. `projects/*/locations/*/backupPlans/{backup_plan}`",
"readOnly": true,
"type": "string"
},
"backupPlanDetails": {
"$ref": "BackupPlanDetails",
"description": "Output only. Contains details about the backup plan/backup.",
"readOnly": true
},
"cluster": {
"description": "Output only. Immutable. The fully qualified name of the cluster that is being backed up Valid formats: - `projects/*/locations/*/clusters/*` - `projects/*/zones/*/clusters/*`",
"readOnly": true,
"type": "string"
},
"createTime": {
"description": "Output only. The timestamp when this binding was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"etag": {
"description": "Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a BackupPlanBinding from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform BackupPlanBinding updates in order to avoid race conditions: An `etag` is returned in the response to `GetBackupPlanBinding`, and systems are expected to put that etag in the request to `UpdateBackupPlanBinding` or `DeleteBackupPlanBinding` to ensure that their change will be applied to the same version of the resource.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Identifier. The fully qualified name of the BackupPlanBinding. `projects/*/locations/*/backupChannels/*/backupPlanBindings/*`",
"type": "string"
},
"uid": {
"description": "Output only. Server generated global unique identifier of [UUID4](https://en.wikipedia.org/wiki/Universally_unique_identifier)",
"readOnly": true,
"type": "string"
},
"updateTime": {
"description": "Output only. The timestamp when this binding was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"BackupPlanDetails": {
"description": "Contains metadata about the backup plan/backup.",
"id": "BackupPlanDetails",
"properties": {
"backupConfigDetails": {
"$ref": "BackupConfigDetails",
"description": "Output only. Contains details about the BackupConfig of Backups created via this BackupPlan.",
"readOnly": true
},
"lastSuccessfulBackup": {
"description": "Output only. The fully qualified name of the last successful Backup created under this BackupPlan. `projects/*/locations/*/backupPlans/*/backups/*`",
"readOnly": true,
"type": "string"
},
"lastSuccessfulBackupTime": {
"description": "Output only. Completion time of the last successful Backup. This is sourced from a successful Backup's complete_time field.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"nextScheduledBackupTime": {
"description": "Output only. Start time of next scheduled backup under this BackupPlan by either cron_schedule or rpo config. This is sourced from BackupPlan.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"protectedPodCount": {
"description": "Output only. The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"retentionPolicyDetails": {
"$ref": "RetentionPolicyDetails",
"description": "Output only. Contains details about the RetentionPolicy of Backups created via this BackupPlan.",
"readOnly": true
},
"rpoRiskLevel": {
"description": "Output only. A number that represents the current risk level of this BackupPlan from RPO perspective with 1 being no risk and 5 being highest risk.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"state": {
"description": "Output only. State of the BackupPlan.",
"enum": [
"STATE_UNSPECIFIED",
"CLUSTER_PENDING",
"PROVISIONING",
"READY",
"FAILED",
"DEACTIVATED",
"DELETING"
],
"enumDescriptions": [
"Default first value for Enums.",
"Waiting for cluster state to be RUNNING.",
"The BackupPlan is in the process of being created.",
"The BackupPlan has successfully been created and is ready for Backups.",
"BackupPlan creation has failed.",
"The BackupPlan has been deactivated.",
"The BackupPlan is in the process of being deleted."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"BackupRuleDetail": {
"id": "BackupRuleDetail",
"properties": {
"backupWindow": {
"description": "Backup Window For Eg. \u201c00:00 to 06:00\u201d",
"type": "string"
},
"backupWindowTimezone": {
"description": "Backup Window Timezone in IANA format. For Eg. \u201cAmerica/Los_Angeles\u201d",
"type": "string"
},
"recurrence": {
"description": "Recurrence Type. For Eg. \u201cWeekly\u201d,\u201d Monthly\u201d or \u201cDaily\u201d.",
"type": "string"
},
"recurrenceSchedule": {
"description": "Recurrence Repeat Schedule. For Eg. \u201c1st and 25th day of the month.\u201d",
"type": "string"
},
"retentionDays": {
"description": "Backup Retention in Days.",
"format": "int32",
"type": "integer"
},
"ruleName": {
"description": "Backup Rule Name.",
"type": "string"
}
},
"type": "object"
},
"Binding": {
"description": "Associates `members`, or principals, with a `role`.",
"id": "Binding",
"properties": {
"condition": {
"$ref": "Expr",
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
},
"members": {
"description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.",
"items": {
"type": "string"
},
"type": "array"
},
"role": {
"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).",
"type": "string"
}
},
"type": "object"
},
"ClusterMetadata": {
"description": "Information about the GKE cluster from which this Backup was created.",
"id": "ClusterMetadata",
"properties": {
"anthosVersion": {
"description": "Output only. Anthos version",
"readOnly": true,
"type": "string"
},
"backupCrdVersions": {
"additionalProperties": {
"type": "string"
},
"description": "Output only. A list of the Backup for GKE CRD versions found in the cluster.",
"readOnly": true,
"type": "object"
},
"cluster": {
"description": "Output only. The source cluster from which this Backup was created. Valid formats: - `projects/*/locations/*/clusters/*` - `projects/*/zones/*/clusters/*` This is inherited from the parent BackupPlan's cluster field.",
"readOnly": true,
"type": "string"
},
"gkeVersion": {
"description": "Output only. GKE version",
"readOnly": true,
"type": "string"
},
"k8sVersion": {
"description": "Output only. The Kubernetes server version of the source cluster.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"ClusterResourceRestoreScope": {
"description": "Defines the scope of cluster-scoped resources to restore. Some group kinds are not reasonable choices for a restore, and will cause an error if selected here. Any scope selection that would restore \"all valid\" resources automatically excludes these group kinds. - Node - ComponentStatus - gkebackup.gke.io/BackupJob - gkebackup.gke.io/RestoreJob - metrics.k8s.io/NodeMetrics - migration.k8s.io/StorageState - migration.k8s.io/StorageVersionMigration - snapshot.storage.k8s.io/VolumeSnapshotContent - storage.k8s.io/CSINode - storage.k8s.io/VolumeAttachment Some group kinds are driven by restore configuration elsewhere, and will cause an error if selected here. - Namespace - PersistentVolume",
"id": "ClusterResourceRestoreScope",
"properties": {
"allGroupKinds": {
"description": "Optional. If True, all valid cluster-scoped resources will be restored. Mutually exclusive to any other field in the message.",
"type": "boolean"
},
"excludedGroupKinds": {
"description": "Optional. A list of cluster-scoped resource group kinds to NOT restore from the backup. If specified, all valid cluster-scoped resources will be restored except for those specified in the list. Mutually exclusive to any other field in the message.",
"items": {
"$ref": "GroupKind"
},
"type": "array"
},
"noGroupKinds": {
"description": "Optional. If True, no cluster-scoped resources will be restored. This has the same restore scope as if the message is not defined. Mutually exclusive to any other field in the message.",
"type": "boolean"
},
"selectedGroupKinds": {
"description": "Optional. A list of cluster-scoped resource group kinds to restore from the backup. If specified, only the selected resources will be restored. Mutually exclusive to any other field in the message.",
"items": {
"$ref": "GroupKind"
},
"type": "array"
}
},
"type": "object"
},
"Date": {
"description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp",
"id": "Date",
"properties": {
"day": {
"description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.",
"format": "int32",
"type": "integer"
},
"month": {
"description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.",
"format": "int32",
"type": "integer"
},
"year": {
"description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"DayOfWeekList": {
"description": "Holds repeated DaysOfWeek values as a container.",
"id": "DayOfWeekList",
"properties": {
"daysOfWeek": {
"description": "Optional. A list of days of week.",
"items": {
"enum": [
"DAY_OF_WEEK_UNSPECIFIED",
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY",
"SUNDAY"
],
"enumDescriptions": [
"The day of the week is unspecified.",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday",
"Sunday"
],
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Empty": {
"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }",
"id": "Empty",
"properties": {},
"type": "object"
},
"EncryptionKey": {
"description": "Defined a customer managed encryption key that will be used to encrypt Backup artifacts.",
"id": "EncryptionKey",
"properties": {
"gcpKmsEncryptionKey": {
"description": "Optional. Google Cloud KMS encryption key. Format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`",
"type": "string"
}
},
"type": "object"
},
"ExclusionWindow": {
"description": "Defines a time window during which no backup should happen. All time and date are in UTC.",
"id": "ExclusionWindow",
"properties": {
"daily": {
"description": "The exclusion window occurs every day if set to \"True\". Specifying this field to \"False\" is an error.",
"type": "boolean"
},
"daysOfWeek": {
"$ref": "DayOfWeekList",
"description": "The exclusion window occurs on these days of each week in UTC."
},
"duration": {
"description": "Required. Specifies duration of the window. Duration must be >= 5 minutes and < (target RPO - 20 minutes). Additional restrictions based on the recurrence type to allow some time for backup to happen: - single_occurrence_date: no restriction, but UI may warn about this when duration >= target RPO - daily window: duration < 24 hours - weekly window: - days of week includes all seven days of a week: duration < 24 hours - all other weekly window: duration < 168 hours (i.e., 24 * 7 hours)",
"format": "google-duration",
"type": "string"
},
"singleOccurrenceDate": {
"$ref": "Date",
"description": "No recurrence. The exclusion window occurs only once and on this date in UTC."
},
"startTime": {
"$ref": "TimeOfDay",
"description": "Optional. Specifies the start time of the window using time of the day in UTC."
}
},
"type": "object"
},
"Expr": {
"description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.",
"id": "Expr",
"properties": {
"description": {
"description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.",
"type": "string"
},
"expression": {
"description": "Textual representation of an expression in Common Expression Language syntax.",
"type": "string"
},
"location": {
"description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.",
"type": "string"
},
"title": {
"description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.",
"type": "string"
}
},
"type": "object"
},
"Filter": {
"description": "Defines the filter for `Restore`. This filter can be used to further refine the resource selection of the `Restore` beyond the coarse-grained scope defined in the `RestorePlan`. `exclusion_filters` take precedence over `inclusion_filters`. If a resource matches both `inclusion_filters` and `exclusion_filters`, it will not be restored.",
"id": "Filter",
"properties": {
"exclusionFilters": {
"description": "Optional. Excludes resources from restoration. If specified, a resource will not be restored if it matches any `ResourceSelector` of the `exclusion_filters`.",
"items": {
"$ref": "ResourceSelector"
},
"type": "array"
},
"inclusionFilters": {
"description": "Optional. Selects resources for restoration. If specified, only resources which match `inclusion_filters` will be selected for restoration. A resource will be selected if it matches any `ResourceSelector` of the `inclusion_filters`.",
"items": {
"$ref": "ResourceSelector"
},
"type": "array"
}
},
"type": "object"
},
"GetBackupIndexDownloadUrlResponse": {
"description": "Response message for GetBackupIndexDownloadUrl.",
"id": "GetBackupIndexDownloadUrlResponse",
"properties": {
"signedUrl": {
"description": "Required. The signed URL for downloading the backup index.",
"type": "string"
}
},
"type": "object"
},
"GetTagsRequest": {
"description": "Request message for GetTags.",
"id": "GetTagsRequest",
"properties": {
"name": {
"description": "Required. The full resource name of the service resource.",
"type": "string"
}
},
"type": "object"
},
"GetTagsResponse": {
"description": "Response message for GetTags.",
"id": "GetTagsResponse",
"properties": {
"etag": {
"description": "A checksum based on the current bindings. This field is always set in server responses.",
"type": "string"
},
"name": {
"description": "Required. The full resource name of the service resource.",
"type": "string"
},
"tags": {
"additionalProperties": {
"type": "string"
},
"description": "Required. Tag keys/values directly bound to this resource. Each item in the map must be expressed as \" : \". For example: \"123/environment\" : \"production\", \"123/costCenter\" : \"marketing\"",
"type": "object"
}
},
"type": "object"
},
"GoogleLongrunningCancelOperationRequest": {
"description": "The request message for Operations.CancelOperation.",
"id": "GoogleLongrunningCancelOperationRequest",
"properties": {},
"type": "object"
},
"GoogleLongrunningListOperationsResponse": {
"description": "The response message for Operations.ListOperations.",
"id": "GoogleLongrunningListOperationsResponse",
"properties": {
"nextPageToken": {
"description": "The standard List next-page token.",
"type": "string"
},
"operations": {
"description": "A list of operations that matches the specified filter in the request.",
"items": {
"$ref": "GoogleLongrunningOperation"
},
"type": "array"
},
"unreachable": {
"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleLongrunningOperation": {
"description": "This resource represents a long-running operation that is the result of a network API call.",
"id": "GoogleLongrunningOperation",
"properties": {
"done": {
"description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.",
"type": "boolean"
},
"error": {
"$ref": "GoogleRpcStatus",
"description": "The error result of the operation in case of failure or cancellation."
},
"metadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
"type": "object"
},
"name": {
"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.",
"type": "string"
},
"response": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.",
"type": "object"
}
},
"type": "object"
},
"GoogleRpcStatus": {
"description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).",
"id": "GoogleRpcStatus",
"properties": {
"code": {
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
"type": "integer"
},
"details": {
"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
"items": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
"type": "string"
}
},
"type": "object"
},
"GroupKind": {
"description": "This is a direct map to the Kubernetes GroupKind type [GroupKind](https://godoc.org/k8s.io/apimachinery/pkg/runtime/schema#GroupKind) and is used for identifying specific \"types\" of resources to restore.",
"id": "GroupKind",
"properties": {
"resourceGroup": {
"description": "Optional. API group string of a Kubernetes resource, e.g. \"apiextensions.k8s.io\", \"storage.k8s.io\", etc. Note: use empty string for core API group.",
"type": "string"
},
"resourceKind": {
"description": "Optional. Kind of a Kubernetes resource, must be in UpperCamelCase (PascalCase) and singular form. E.g. \"CustomResourceDefinition\", \"StorageClass\", etc.",
"type": "string"
}
},
"type": "object"
},
"GroupKindDependency": {
"description": "Defines a dependency between two group kinds.",
"id": "GroupKindDependency",
"properties": {
"requiring": {
"$ref": "GroupKind",
"description": "Required. The requiring group kind requires that the other group kind be restored first."
},
"satisfying": {
"$ref": "GroupKind",
"description": "Required. The satisfying group kind must be restored first in order to satisfy the dependency."
}
},
"type": "object"
},
"Label": {
"description": "A single Kubernetes label-value pair.",
"id": "Label",
"properties": {
"key": {
"description": "Optional. The key/name of the label.",
"type": "string"
},
"value": {
"description": "Optional. The value of the label.",
"type": "string"
}
},
"type": "object"
},
"ListBackupChannelsResponse": {
"description": "Response message for ListBackupChannels.",
"id": "ListBackupChannelsResponse",
"properties": {
"backupChannels": {
"description": "The list of BackupChannels matching the given criteria.",
"items": {
"$ref": "BackupChannel"
},
"type": "array"
},
"nextPageToken": {
"description": "A token which may be sent as page_token in a subsequent `ListBackupChannels` call to retrieve the next page of results. If this field is omitted or empty, then there are no more results to return.",
"type": "string"
},
"unreachable": {
"description": "Locations that could not be reached.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ListBackupPlanBindingsResponse": {
"description": "Response message for ListBackupPlanBindings.",
"id": "ListBackupPlanBindingsResponse",
"properties": {
"backupPlanBindings": {
"description": "The list of BackupPlanBindings matching the given criteria.",
"items": {
"$ref": "BackupPlanBinding"
},
"type": "array"
},
"nextPageToken": {
"description": "A token which may be sent as page_token in a subsequent `ListBackupPlanBindingss` call to retrieve the next page of results. If this field is omitted or empty, then there are no more results to return.",
"type": "string"
},
"unreachable": {
"description": "Locations that could not be reached.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ListBackupPlansResponse": {
"description": "Response message for ListBackupPlans.",
"id": "ListBackupPlansResponse",
"properties": {
"backupPlans": {
"description": "The list of BackupPlans matching the given criteria.",
"items": {
"$ref": "BackupPlan"
},
"type": "array"
},
"nextPageToken": {
"description": "A token which may be sent as page_token in a subsequent `ListBackupPlans` call to retrieve the next page of results. If this field is omitted or empty, then there are no more results to return.",
"type": "string"
},
"unreachable": {
"description": "Locations that could not be reached.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ListBackupsResponse": {
"description": "Response message for ListBackups.",
"id": "ListBackupsResponse",
"properties": {
"backups": {
"description": "The list of Backups matching the given criteria.",
"items": {
"$ref": "Backup"
},
"type": "array"
},
"nextPageToken": {
"description": "A token which may be sent as page_token in a subsequent `ListBackups` call to retrieve the next page of results. If this field is omitted or empty, then there are no more results to return.",
"type": "string"
},
"unreachable": {
"description": "Locations that could not be reached.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ListLocationsResponse": {
"description": "The response message for Locations.ListLocations.",
"id": "ListLocationsResponse",
"properties": {
"locations": {
"description": "A list of locations that matches the specified filter in the request.",
"items": {
"$ref": "Location"
},
"type": "array"
},
"nextPageToken": {
"description": "The standard List next-page token.",
"type": "string"
}
},
"type": "object"
},
"ListRestoreChannelsResponse": {
"description": "Response message for ListRestoreChannels.",
"id": "ListRestoreChannelsResponse",
"properties": {
"nextPageToken": {
"description": "A token which may be sent as page_token in a subsequent `ListRestoreChannels` call to retrieve the next page of results. If this field is omitted or empty, then there are no more results to return.",
"type": "string"
},
"restoreChannels": {
"description": "The list of RestoreChannels matching the given criteria.",
"items": {
"$ref": "RestoreChannel"
},
"type": "array"
},
"unreachable": {
"description": "Locations that could not be reached.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ListRestorePlanBindingsResponse": {
"description": "Response message for ListRestorePlanBindings.",
"id": "ListRestorePlanBindingsResponse",
"properties": {
"nextPageToken": {
"description": "A token which may be sent as page_token in a subsequent `ListRestorePlanBindings` call to retrieve the next page of results. If this field is omitted or empty, then there are no more results to return.",
"type": "string"
},
"restorePlanBindings": {
"description": "The list of RestorePlanBindings matching the given criteria.",
"items": {
"$ref": "RestorePlanBinding"
},
"type": "array"
},
"unreachable": {
"description": "Unordered list. Locations that could not be reached.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ListRestorePlansResponse": {
"description": "Response message for ListRestorePlans.",
"id": "ListRestorePlansResponse",
"properties": {
"nextPageToken": {
"description": "A token which may be sent as page_token in a subsequent `ListRestorePlans` call to retrieve the next page of results. If this field is omitted or empty, then there are no more results to return.",
"type": "string"
},
"restorePlans": {
"description": "The list of RestorePlans matching the given criteria.",
"items": {
"$ref": "RestorePlan"
},
"type": "array"
},
"unreachable": {
"description": "Locations that could not be reached.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ListRestoresResponse": {
"description": "Response message for ListRestores.",
"id": "ListRestoresResponse",
"properties": {
"nextPageToken": {
"description": "A token which may be sent as page_token in a subsequent `ListRestores` call to retrieve the next page of results. If this field is omitted or empty, then there are no more results to return.",
"type": "string"
},
"restores": {
"description": "The list of Restores matching the given criteria.",
"items": {
"$ref": "Restore"
},
"type": "array"
},
"unreachable": {
"description": "Locations that could not be reached.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ListVolumeBackupsResponse": {
"description": "Response message for ListVolumeBackups.",
"id": "ListVolumeBackupsResponse",
"properties": {
"nextPageToken": {
"description": "A token which may be sent as page_token in a subsequent `ListVolumeBackups` call to retrieve the next page of results. If this field is omitted or empty, then there are no more results to return.",
"type": "string"
},
"volumeBackups": {
"description": "The list of VolumeBackups matching the given criteria.",
"items": {
"$ref": "VolumeBackup"
},
"type": "array"
}
},
"type": "object"
},
"ListVolumeRestoresResponse": {
"description": "Response message for ListVolumeRestores.",
"id": "ListVolumeRestoresResponse",
"properties": {
"nextPageToken": {
"description": "A token which may be sent as page_token in a subsequent `ListVolumeRestores` call to retrieve the next page of results. If this field is omitted or empty, then there are no more results to return.",
"type": "string"
},
"volumeRestores": {
"description": "The list of VolumeRestores matching the given criteria.",
"items": {
"$ref": "VolumeRestore"
},
"type": "array"
}
},
"type": "object"
},
"Location": {
"description": "A resource that represents a Google Cloud location.",
"id": "Location",
"properties": {
"displayName": {
"description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}",
"type": "object"
},
"locationId": {
"description": "The canonical id for this location. For example: `\"us-east1\"`.",
"type": "string"
},
"metadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "Service-specific metadata. For example the available capacity at the given location.",
"type": "object"
},
"name": {
"description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`",
"type": "string"
}
},
"type": "object"
},
"NamespacedName": {
"description": "A reference to a namespaced resource in Kubernetes.",
"id": "NamespacedName",
"properties": {
"name": {
"description": "Optional. The name of the Kubernetes resource.",
"type": "string"
},
"namespace": {
"description": "Optional. The Namespace of the Kubernetes resource.",
"type": "string"
}
},
"type": "object"
},
"NamespacedNames": {
"description": "A list of namespaced Kubernetes resources.",
"id": "NamespacedNames",
"properties": {
"namespacedNames": {
"description": "Optional. A list of namespaced Kubernetes resources.",
"items": {
"$ref": "NamespacedName"
},
"type": "array"
}
},
"type": "object"
},
"Namespaces": {
"description": "A list of Kubernetes Namespaces.",
"id": "Namespaces",
"properties": {
"namespaces": {
"description": "Optional. A list of Kubernetes Namespaces.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"OperationMetadata": {
"description": "Represents the metadata of the long-running operation.",
"id": "OperationMetadata",
"properties": {
"apiVersion": {
"description": "Output only. API version used to start the operation.",
"readOnly": true,
"type": "string"
},
"createTime": {
"description": "Output only. The time the operation was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"endTime": {
"description": "Output only. The time the operation finished running.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"requestedCancellation": {
"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
"readOnly": true,
"type": "boolean"
},
"statusMessage": {
"description": "Output only. Human-readable status of the operation, if any.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Output only. Server-defined resource path for the target of the operation.",
"readOnly": true,
"type": "string"
},
"verb": {
"description": "Output only. Name of the verb executed by the operation.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"Policy": {
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
"id": "Policy",
"properties": {
"auditConfigs": {
"description": "Specifies cloud audit logging configuration for this policy.",
"items": {
"$ref": "AuditConfig"
},
"type": "array"
},
"bindings": {
"description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.",
"items": {
"$ref": "Binding"
},
"type": "array"
},
"etag": {
"description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.",
"format": "byte",
"type": "string"
},
"version": {
"description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"ResourceFilter": {
"description": "ResourceFilter specifies matching criteria to limit the scope of a change to a specific set of kubernetes resources that are selected for restoration from a backup.",
"id": "ResourceFilter",
"properties": {
"groupKinds": {
"description": "Optional. (Filtering parameter) Any resource subject to transformation must belong to one of the listed \"types\". If this field is not provided, no type filtering will be performed (all resources of all types matching previous filtering parameters will be candidates for transformation).",
"items": {
"$ref": "GroupKind"
},
"type": "array"
},
"jsonPath": {
"description": "Optional. This is a [JSONPath] (https://github.com/json-path/JsonPath/blob/master/README.md) expression that matches specific fields of candidate resources and it operates as a filtering parameter (resources that are not matched with this expression will not be candidates for transformation).",
"type": "string"
},
"namespaces": {
"description": "Optional. (Filtering parameter) Any resource subject to transformation must be contained within one of the listed Kubernetes Namespace in the Backup. If this field is not provided, no namespace filtering will be performed (all resources in all Namespaces, including all cluster-scoped resources, will be candidates for transformation).",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ResourceLabels": {
"description": "A list of Kubernetes labels.",
"id": "ResourceLabels",
"properties": {
"resourceLabels": {
"description": "Optional. A list of Kubernetes label-value pairs.",
"items": {
"$ref": "Label"
},
"type": "array"
}
},
"type": "object"
},
"ResourceSelector": {
"description": "Defines a selector to identify a single or a group of resources. Conditions in the selector are optional, but at least one field should be set to a non-empty value. If a condition is not specified, no restrictions will be applied on that dimension. If more than one condition is specified, a resource will be selected if and only if all conditions are met.",
"id": "ResourceSelector",
"properties": {
"groupKind": {
"$ref": "GroupKind",
"description": "Optional. Selects resources using their Kubernetes GroupKinds. If specified, only resources of provided GroupKind will be selected."
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. Selects resources using Kubernetes [labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/). If specified, a resource will be selected if and only if the resource has all of the provided labels and all the label values match.",
"type": "object"
},
"name": {
"description": "Optional. Selects resources using their resource names. If specified, only resources with the provided name will be selected.",
"type": "string"
},
"namespace": {
"description": "Optional. Selects resources using their namespaces. This only applies to namespace scoped resources and cannot be used for selecting cluster scoped resources. If specified, only resources in the provided namespace will be selected. If not specified, the filter will apply to both cluster scoped and namespace scoped resources (e.g. name or label). The [Namespace](https://pkg.go.dev/k8s.io/api/core/v1#Namespace) resource itself will be restored if and only if any resources within the namespace are restored.",
"type": "string"
}
},
"type": "object"
},
"Restore": {
"description": "Represents both a request to Restore some portion of a Backup into a target GKE cluster and a record of the restore operation itself.",
"id": "Restore",
"properties": {
"backup": {
"description": "Required. Immutable. A reference to the Backup used as the source from which this Restore will restore. Note that this Backup must be a sub-resource of the RestorePlan's backup_plan. Format: `projects/*/locations/*/backupPlans/*/backups/*`.",
"type": "string"
},
"cluster": {
"description": "Output only. The target cluster into which this Restore will restore data. Valid formats: - `projects/*/locations/*/clusters/*` - `projects/*/zones/*/clusters/*` Inherited from parent RestorePlan's cluster value.",
"readOnly": true,
"type": "string"
},
"completeTime": {
"description": "Output only. Timestamp of when the restore operation completed.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"createTime": {
"description": "Output only. The timestamp when this Restore resource was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Optional. User specified descriptive string for this Restore.",
"type": "string"
},
"etag": {
"description": "Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a restore from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform restore updates in order to avoid race conditions: An `etag` is returned in the response to `GetRestore`, and systems are expected to put that etag in the request to `UpdateRestore` or `DeleteRestore` to ensure that their change will be applied to the same version of the resource.",
"readOnly": true,
"type": "string"
},
"filter": {
"$ref": "Filter",
"description": "Optional. Immutable. Filters resources for `Restore`. If not specified, the scope of the restore will remain the same as defined in the `RestorePlan`. If this is specified and no resources are matched by the `inclusion_filters` or everything is excluded by the `exclusion_filters`, nothing will be restored. This filter can only be specified if the value of namespaced_resource_restore_mode is set to `MERGE_SKIP_ON_CONFLICT`, `MERGE_REPLACE_VOLUME_ON_CONFLICT` or `MERGE_REPLACE_ON_CONFLICT`."
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "A set of custom labels supplied by user.",
"type": "object"
},
"name": {
"description": "Output only. Identifier. The full name of the Restore resource. Format: `projects/*/locations/*/restorePlans/*/restores/*`",
"readOnly": true,
"type": "string"
},
"resourcesExcludedCount": {
"description": "Output only. Number of resources excluded during the restore execution.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"resourcesFailedCount": {
"description": "Output only. Number of resources that failed to be restored during the restore execution.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"resourcesRestoredCount": {
"description": "Output only. Number of resources restored during the restore execution.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"restoreConfig": {
"$ref": "RestoreConfig",
"description": "Output only. Configuration of the Restore. Inherited from parent RestorePlan's restore_config.",
"readOnly": true
},
"state": {
"description": "Output only. The current state of the Restore.",
"enum": [
"STATE_UNSPECIFIED",
"CREATING",
"IN_PROGRESS",
"SUCCEEDED",
"FAILED",
"DELETING",
"VALIDATING"
],
"enumDescriptions": [
"The Restore resource is in the process of being created.",
"The Restore resource has been created and the associated RestoreJob Kubernetes resource has been injected into target cluster.",
"The gkebackup agent in the cluster has begun executing the restore operation.",
"The restore operation has completed successfully. Restored workloads may not yet be operational.",
"The restore operation has failed.",
"This Restore resource is in the process of being deleted.",
"The Kubernetes resources created by this Restore are being validated."
],
"readOnly": true,
"type": "string"
},
"stateReason": {
"description": "Output only. Human-readable description of why the Restore is in its current state. This field is only meant for human readability and should not be used programmatically as this field is not guaranteed to be consistent.",
"readOnly": true,
"type": "string"
},
"troubleshootingInfo": {
"$ref": "TroubleshootingInfo",
"description": "Output only. Information about the troubleshooting steps which will provide debugging information to the end users.",
"readOnly": true
},
"uid": {
"description": "Output only. Server generated global unique identifier of [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format.",
"readOnly": true,
"type": "string"
},
"updateTime": {
"description": "Output only. The timestamp when this Restore resource was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"volumeDataRestorePolicyOverrides": {
"description": "Optional. Immutable. Overrides the volume data restore policies selected in the Restore Config for override-scoped resources.",
"items": {
"$ref": "VolumeDataRestorePolicyOverride"
},
"type": "array"
},
"volumesRestoredCount": {
"description": "Output only. Number of volumes restored during the restore execution.",
"format": "int32",
"readOnly": true,
"type": "integer"
}
},
"type": "object"
},
"RestoreChannel": {
"description": "A RestoreChannel imposes constraints on where backups can be restored. The RestoreChannel should be in the same project and region as the backups. The backups can only be restored in the `destination_project`.",
"id": "RestoreChannel",
"properties": {
"createTime": {
"description": "Output only. The timestamp when this RestoreChannel was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Optional. User specified descriptive string for this RestoreChannel.",
"type": "string"
},
"destinationProject": {
"description": "Required. Immutable. The project into which the backups will be restored. The format is `projects/{projectId}` or `projects/{projectNumber}`.",
"type": "string"
},
"destinationProjectId": {
"description": "Output only. The project_id where backups will be restored. Example Project ID: \"my-project-id\". This will be an OUTPUT_ONLY field to return the project_id of the destination project.",
"readOnly": true,
"type": "string"
},
"etag": {
"description": "Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a RestoreChannel from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform RestoreChannel updates in order to avoid race conditions: An `etag` is returned in the response to `GetRestoreChannel`, and systems are expected to put that etag in the request to `UpdateRestoreChannel` or `DeleteRestoreChannel` to ensure that their change will be applied to the same version of the resource.",
"readOnly": true,
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. A set of custom labels supplied by user.",
"type": "object"
},
"name": {
"description": "Identifier. The fully qualified name of the RestoreChannel. `projects/*/locations/*/restoreChannels/*`",
"type": "string"
},
"uid": {
"description": "Output only. Server generated global unique identifier of [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format.",
"readOnly": true,
"type": "string"
},
"updateTime": {
"description": "Output only. The timestamp when this RestoreChannel was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"RestoreConfig": {
"description": "Configuration of a restore.",
"id": "RestoreConfig",
"properties": {
"allNamespaces": {
"description": "Restore all namespaced resources in the Backup if set to \"True\". Specifying this field to \"False\" is an error.",
"type": "boolean"
},
"clusterResourceConflictPolicy": {
"description": "Optional. Defines the behavior for handling the situation where cluster-scoped resources being restored already exist in the target cluster. This MUST be set to a value other than CLUSTER_RESOURCE_CONFLICT_POLICY_UNSPECIFIED if cluster_resource_restore_scope is not empty.",
"enum": [
"CLUSTER_RESOURCE_CONFLICT_POLICY_UNSPECIFIED",
"USE_EXISTING_VERSION",
"USE_BACKUP_VERSION"
],
"enumDescriptions": [
"Unspecified. Only allowed if no cluster-scoped resources will be restored.",
"Do not attempt to restore the conflicting resource.",
"Delete the existing version before re-creating it from the Backup. This is a dangerous option which could cause unintentional data loss if used inappropriately. For example, deleting a CRD will cause Kubernetes to delete all CRs of that type."
],
"type": "string"
},
"clusterResourceRestoreScope": {
"$ref": "ClusterResourceRestoreScope",
"description": "Optional. Identifies the cluster-scoped resources to restore from the Backup. Not specifying it means NO cluster resource will be restored."
},
"excludedNamespaces": {
"$ref": "Namespaces",
"description": "A list of selected namespaces excluded from restoration. All namespaces except those in this list will be restored."
},
"namespacedResourceRestoreMode": {
"description": "Optional. Defines the behavior for handling the situation where sets of namespaced resources being restored already exist in the target cluster. This MUST be set to a value other than NAMESPACED_RESOURCE_RESTORE_MODE_UNSPECIFIED.",
"enum": [
"NAMESPACED_RESOURCE_RESTORE_MODE_UNSPECIFIED",
"DELETE_AND_RESTORE",
"FAIL_ON_CONFLICT",
"MERGE_SKIP_ON_CONFLICT",
"MERGE_REPLACE_VOLUME_ON_CONFLICT",
"MERGE_REPLACE_ON_CONFLICT"
],
"enumDescriptions": [
"Unspecified (invalid).",
"When conflicting top-level resources (either Namespaces or ProtectedApplications, depending upon the scope) are encountered, this will first trigger a delete of the conflicting resource AND ALL OF ITS REFERENCED RESOURCES (e.g., all resources in the Namespace or all resources referenced by the ProtectedApplication) before restoring the resources from the Backup. This mode should only be used when you are intending to revert some portion of a cluster to an earlier state.",
"If conflicting top-level resources (either Namespaces or ProtectedApplications, depending upon the scope) are encountered at the beginning of a restore process, the Restore will fail. If a conflict occurs during the restore process itself (e.g., because an out of band process creates conflicting resources), a conflict will be reported.",
"This mode merges the backup and the target cluster and skips the conflicting resources. If a single resource to restore exists in the cluster before restoration, the resource will be skipped, otherwise it will be restored.",
"This mode merges the backup and the target cluster and skips the conflicting resources except volume data. If a PVC to restore already exists, this mode will restore/reconnect the volume without overwriting the PVC. It is similar to MERGE_SKIP_ON_CONFLICT except that it will apply the volume data policy for the conflicting PVCs: - RESTORE_VOLUME_DATA_FROM_BACKUP: restore data only and respect the reclaim policy of the original PV; - REUSE_VOLUME_HANDLE_FROM_BACKUP: reconnect and respect the reclaim policy of the original PV; - NO_VOLUME_DATA_RESTORATION: new provision and respect the reclaim policy of the original PV. Note that this mode could cause data loss as the original PV can be retained or deleted depending on its reclaim policy.",
"This mode merges the backup and the target cluster and replaces the conflicting resources with the ones in the backup. If a single resource to restore exists in the cluster before restoration, the resource will be replaced with the one from the backup. To replace an existing resource, the first attempt is to update the resource to match the one from the backup; if the update fails, the second attempt is to delete the resource and restore it from the backup. Note that this mode could cause data loss as it replaces the existing resources in the target cluster, and the original PV can be retained or deleted depending on its reclaim policy."
],
"type": "string"
},
"noNamespaces": {
"description": "Do not restore any namespaced resources if set to \"True\". Specifying this field to \"False\" is not allowed.",
"type": "boolean"
},
"restoreOrder": {
"$ref": "RestoreOrder",
"description": "Optional. RestoreOrder contains custom ordering to use on a Restore."
},
"selectedApplications": {
"$ref": "NamespacedNames",
"description": "A list of selected ProtectedApplications to restore. The listed ProtectedApplications and all the resources to which they refer will be restored."
},
"selectedNamespaces": {
"$ref": "Namespaces",
"description": "A list of selected Namespaces to restore from the Backup. The listed Namespaces and all resources contained in them will be restored."
},
"substitutionRules": {
"description": "Optional. A list of transformation rules to be applied against Kubernetes resources as they are selected for restoration from a Backup. Rules are executed in order defined - this order matters, as changes made by a rule may impact the filtering logic of subsequent rules. An empty list means no substitution will occur.",
"items": {
"$ref": "SubstitutionRule"
},
"type": "array"
},
"transformationRules": {
"description": "Optional. A list of transformation rules to be applied against Kubernetes resources as they are selected for restoration from a Backup. Rules are executed in order defined - this order matters, as changes made by a rule may impact the filtering logic of subsequent rules. An empty list means no transformation will occur.",
"items": {
"$ref": "TransformationRule"
},
"type": "array"
},
"volumeDataRestorePolicy": {
"description": "Optional. Specifies the mechanism to be used to restore volume data. Default: VOLUME_DATA_RESTORE_POLICY_UNSPECIFIED (will be treated as NO_VOLUME_DATA_RESTORATION).",
"enum": [
"VOLUME_DATA_RESTORE_POLICY_UNSPECIFIED",
"RESTORE_VOLUME_DATA_FROM_BACKUP",
"REUSE_VOLUME_HANDLE_FROM_BACKUP",
"NO_VOLUME_DATA_RESTORATION"
],
"enumDescriptions": [
"Unspecified (illegal).",
"For each PVC to be restored, create a new underlying volume and PV from the corresponding VolumeBackup contained within the Backup.",
"For each PVC to be restored, attempt to reuse the original PV contained in the Backup (with its original underlying volume). This option is likely only usable when restoring a workload to its original cluster.",
"For each PVC to be restored, create PVC without any particular action to restore data. In this case, the normal Kubernetes provisioning logic would kick in, and this would likely result in either dynamically provisioning blank PVs or binding to statically provisioned PVs."
],
"type": "string"
},
"volumeDataRestorePolicyBindings": {
"description": "Optional. A table that binds volumes by their scope to a restore policy. Bindings must have a unique scope. Any volumes not scoped in the bindings are subject to the policy defined in volume_data_restore_policy.",
"items": {
"$ref": "VolumeDataRestorePolicyBinding"
},
"type": "array"
}
},
"type": "object"
},
"RestoreOrder": {
"description": "Allows customers to specify dependencies between resources that Backup for GKE can use to compute a resasonable restore order.",
"id": "RestoreOrder",
"properties": {
"groupKindDependencies": {
"description": "Optional. Contains a list of group kind dependency pairs provided by the customer, that is used by Backup for GKE to generate a group kind restore order.",
"items": {
"$ref": "GroupKindDependency"
},
"type": "array"
}
},
"type": "object"
},
"RestorePlan": {
"description": "The configuration of a potential series of Restore operations to be performed against Backups belong to a particular BackupPlan.",
"id": "RestorePlan",
"properties": {
"backupPlan": {
"description": "Required. Immutable. A reference to the BackupPlan from which Backups may be used as the source for Restores created via this RestorePlan. Format: `projects/*/locations/*/backupPlans/*`.",
"type": "string"
},
"cluster": {
"description": "Required. Immutable. The target cluster into which Restores created via this RestorePlan will restore data. NOTE: the cluster's region must be the same as the RestorePlan. Valid formats: - `projects/*/locations/*/clusters/*` - `projects/*/zones/*/clusters/*`",
"type": "string"
},
"createTime": {
"description": "Output only. The timestamp when this RestorePlan resource was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Optional. User specified descriptive string for this RestorePlan.",
"type": "string"
},
"etag": {
"description": "Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a restore from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform restore updates in order to avoid race conditions: An `etag` is returned in the response to `GetRestorePlan`, and systems are expected to put that etag in the request to `UpdateRestorePlan` or `DeleteRestorePlan` to ensure that their change will be applied to the same version of the resource.",
"readOnly": true,
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. A set of custom labels supplied by user.",
"type": "object"
},
"name": {
"description": "Output only. Identifier. The full name of the RestorePlan resource. Format: `projects/*/locations/*/restorePlans/*`.",
"readOnly": true,
"type": "string"
},
"restoreChannel": {
"description": "Output only. The fully qualified name of the RestoreChannel to be used to create a RestorePlan. This field is set only if the `backup_plan` is in a different project than the RestorePlan. Format: `projects/*/locations/*/restoreChannels/*`",
"readOnly": true,
"type": "string"
},
"restoreConfig": {
"$ref": "RestoreConfig",
"description": "Required. Configuration of Restores created via this RestorePlan."
},
"state": {
"description": "Output only. State of the RestorePlan. This State field reflects the various stages a RestorePlan can be in during the Create operation.",
"enum": [
"STATE_UNSPECIFIED",
"CLUSTER_PENDING",
"READY",
"FAILED",
"DELETING"
],
"enumDescriptions": [
"Default first value for Enums.",
"Waiting for cluster state to be RUNNING.",
"The RestorePlan has successfully been created and is ready for Restores.",
"RestorePlan creation has failed.",
"The RestorePlan is in the process of being deleted."
],
"readOnly": true,
"type": "string"
},
"stateReason": {
"description": "Output only. Human-readable description of why RestorePlan is in the current `state`. This field is only meant for human readability and should not be used programmatically as this field is not guaranteed to be consistent.",
"readOnly": true,
"type": "string"
},
"uid": {
"description": "Output only. Server generated global unique identifier of [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format.",
"readOnly": true,
"type": "string"
},
"updateTime": {
"description": "Output only. The timestamp when this RestorePlan resource was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"RestorePlanBinding": {
"description": "A RestorePlanBinding binds a RestorePlan with a RestoreChannel. This resource is created automatically when a RestorePlan is created using a RestoreChannel. This also serves as a holder for cross-project fields that need to be displayed in the current project.",
"id": "RestorePlanBinding",
"properties": {
"backupPlan": {
"description": "Output only. The fully qualified name of the BackupPlan bound to the specified RestorePlan. `projects/*/locations/*/backukpPlans/{backup_plan}`",
"readOnly": true,
"type": "string"
},
"createTime": {
"description": "Output only. The timestamp when this binding was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"etag": {
"description": "Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a RestorePlanBinding from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform RestorePlanBinding updates in order to avoid race conditions: An `etag` is returned in the response to `GetRestorePlanBinding`, and systems are expected to put that etag in the request to `UpdateRestorePlanBinding` or `DeleteRestorePlanBinding` to ensure that their change will be applied to the same version of the resource.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Identifier. The fully qualified name of the RestorePlanBinding. `projects/*/locations/*/restoreChannels/*/restorePlanBindings/*`",
"type": "string"
},
"restorePlan": {
"description": "Output only. The fully qualified name of the RestorePlan bound to this RestoreChannel. `projects/*/locations/*/restorePlans/{restore_plan}`",
"readOnly": true,
"type": "string"
},
"uid": {
"description": "Output only. Server generated global unique identifier of [UUID4](https://en.wikipedia.org/wiki/Universally_unique_identifier)",
"readOnly": true,
"type": "string"
},
"updateTime": {
"description": "Output only. The timestamp when this binding was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"RetentionPolicy": {
"description": "RetentionPolicy defines a Backup retention policy for a BackupPlan.",
"id": "RetentionPolicy",
"properties": {
"backupDeleteLockDays": {
"description": "Optional. Minimum age for Backups created via this BackupPlan (in days). This field MUST be an integer value between 0-90 (inclusive). A Backup created under this BackupPlan will NOT be deletable until it reaches Backup's (create_time + backup_delete_lock_days). Updating this field of a BackupPlan does NOT affect existing Backups under it. Backups created AFTER a successful update will inherit the new value. Default: 0 (no delete blocking)",
"format": "int32",
"type": "integer"
},
"backupRetainDays": {
"description": "Optional. The default maximum age of a Backup created via this BackupPlan. This field MUST be an integer value >= 0 and <= 365. If specified, a Backup created under this BackupPlan will be automatically deleted after its age reaches (create_time + backup_retain_days). If not specified, Backups created under this BackupPlan will NOT be subject to automatic deletion. Updating this field does NOT affect existing Backups under it. Backups created AFTER a successful update will automatically pick up the new value. NOTE: backup_retain_days must be >= backup_delete_lock_days. If cron_schedule is defined, then this must be <= 360 * the creation interval. If rpo_config is defined, then this must be <= 360 * target_rpo_minutes / (1440minutes/day). Default: 0 (no automatic deletion)",
"format": "int32",
"type": "integer"
},
"locked": {
"description": "Optional. This flag denotes whether the retention policy of this BackupPlan is locked. If set to True, no further update is allowed on this policy, including the `locked` field itself. Default: False",
"type": "boolean"
}
},
"type": "object"
},
"RetentionPolicyDetails": {
"description": "RetentionPolicyDetails defines a Backup retention policy for a BackupPlan.",
"id": "RetentionPolicyDetails",
"properties": {
"backupDeleteLockDays": {
"description": "Optional. Minimum age for Backups created via this BackupPlan (in days). This field MUST be an integer value between 0-90 (inclusive). A Backup created under this BackupPlan will NOT be deletable until it reaches Backup's (create_time + backup_delete_lock_days). Updating this field of a BackupPlan does NOT affect existing Backups under it. Backups created AFTER a successful update will inherit the new value. Default: 0 (no delete blocking)",
"format": "int32",
"type": "integer"
},
"backupRetainDays": {
"description": "Optional. The default maximum age of a Backup created via this BackupPlan. This field MUST be an integer value >= 0 and <= 365. If specified, a Backup created under this BackupPlan will be automatically deleted after its age reaches (create_time + backup_retain_days). If not specified, Backups created under this BackupPlan will NOT be subject to automatic deletion. Default: 0 (no automatic deletion)",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"RpoConfig": {
"description": "Defines RPO scheduling configuration for automatically creating Backups via this BackupPlan.",
"id": "RpoConfig",
"properties": {
"exclusionWindows": {
"description": "Optional. User specified time windows during which backup can NOT happen for this BackupPlan - backups should start and finish outside of any given exclusion window. Note: backup jobs will be scheduled to start and finish outside the duration of the window as much as possible, but running jobs will not get canceled when it runs into the window. All the time and date values in exclusion_windows entry in the API are in UTC. We only allow <=1 recurrence (daily or weekly) exclusion window for a BackupPlan while no restriction on number of single occurrence windows.",
"items": {
"$ref": "ExclusionWindow"
},
"type": "array"
},
"targetRpoMinutes": {
"description": "Required. Defines the target RPO for the BackupPlan in minutes, which means the target maximum data loss in time that is acceptable for this BackupPlan. This must be at least 60, i.e., 1 hour, and at most 86400, i.e., 60 days.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"Schedule": {
"description": "Defines scheduling parameters for automatically creating Backups via this BackupPlan.",
"id": "Schedule",
"properties": {
"cronSchedule": {
"description": "Optional. A standard [cron](https://wikipedia.com/wiki/cron) string that defines a repeating schedule for creating Backups via this BackupPlan. This is mutually exclusive with the rpo_config field since at most one schedule can be defined for a BackupPlan. If this is defined, then backup_retain_days must also be defined. Default (empty): no automatic backup creation will occur.",
"type": "string"
},
"nextScheduledBackupTime": {
"description": "Output only. Start time of next scheduled backup under this BackupPlan by either cron_schedule or rpo config.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"paused": {
"description": "Optional. This flag denotes whether automatic Backup creation is paused for this BackupPlan. Default: False",
"type": "boolean"
},
"rpoConfig": {
"$ref": "RpoConfig",
"description": "Optional. Defines the RPO schedule configuration for this BackupPlan. This is mutually exclusive with the cron_schedule field since at most one schedule can be defined for a BackupPLan. If this is defined, then backup_retain_days must also be defined. Default (empty): no automatic backup creation will occur."
}
},
"type": "object"
},
"SetIamPolicyRequest": {
"description": "Request message for `SetIamPolicy` method.",
"id": "SetIamPolicyRequest",
"properties": {
"policy": {
"$ref": "Policy",
"description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them."
},
"updateMask": {
"description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: \"bindings, etag\"`",
"format": "google-fieldmask",
"type": "string"
}
},
"type": "object"
},
"SetTagsRequest": {
"description": "Request message for SetTags.",
"id": "SetTagsRequest",
"properties": {
"etag": {
"description": "Optional. A checksum based on the current bindings which can be passed to prevent race conditions. If not passed, etag check would be skipped.",
"type": "string"
},
"name": {
"description": "Required. The full resource name of the service resource.",
"type": "string"
},
"requestId": {
"description": "Optional. A unique identifier for this request. Must be a valid UUID. This request is only idempotent if a `request_id` is provided.",
"type": "string"
},
"tags": {
"additionalProperties": {
"type": "string"
},
"description": "Required. These bindings will override any bindings previously set and will be effective immediately. Each item in the map must be expressed as \" : \". For example: \"123/environment\" : \"production\", \"123/costCenter\" : \"marketing\"",
"type": "object"
}
},
"type": "object"
},
"SetTagsResponse": {
"description": "Response message for SetTags.",
"id": "SetTagsResponse",
"properties": {
"etag": {
"description": "A checksum based on the current bindings. This field is always set in server responses.",
"type": "string"
},
"name": {
"description": "Required. The full resource name of the service resource.",
"type": "string"
},
"tags": {
"additionalProperties": {
"type": "string"
},
"description": "Required. Tag keys/values directly bound to this resource. Each item in the map must be expressed as \" : \". For example: \"123/environment\" : \"production\", \"123/costCenter\" : \"marketing\"",
"type": "object"
}
},
"type": "object"
},
"SubstitutionRule": {
"description": "A transformation rule to be applied against Kubernetes resources as they are selected for restoration from a Backup. A rule contains both filtering logic (which resources are subject to substitution) and substitution logic.",
"id": "SubstitutionRule",
"properties": {
"newValue": {
"description": "Optional. This is the new value to set for any fields that pass the filtering and selection criteria. To remove a value from a Kubernetes resource, either leave this field unspecified, or set it to the empty string (\"\").",
"type": "string"
},
"originalValuePattern": {
"description": "Optional. (Filtering parameter) This is a [regular expression] (https://en.wikipedia.org/wiki/Regular_expression) that is compared against the fields matched by the target_json_path expression (and must also have passed the previous filters). Substitution will not be performed against fields whose value does not match this expression. If this field is NOT specified, then ALL fields matched by the target_json_path expression will undergo substitution. Note that an empty (e.g., \"\", rather than unspecified) value for this field will only match empty fields.",
"type": "string"
},
"targetGroupKinds": {
"description": "Optional. (Filtering parameter) Any resource subject to substitution must belong to one of the listed \"types\". If this field is not provided, no type filtering will be performed (all resources of all types matching previous filtering parameters will be candidates for substitution).",
"items": {
"$ref": "GroupKind"
},
"type": "array"
},
"targetJsonPath": {
"description": "Required. This is a [JSONPath] (https://kubernetes.io/docs/reference/kubectl/jsonpath/) expression that matches specific fields of candidate resources and it operates as both a filtering parameter (resources that are not matched with this expression will not be candidates for substitution) as well as a field identifier (identifies exactly which fields out of the candidate resources will be modified).",
"type": "string"
},
"targetNamespaces": {
"description": "Optional. (Filtering parameter) Any resource subject to substitution must be contained within one of the listed Kubernetes Namespace in the Backup. If this field is not provided, no namespace filtering will be performed (all resources in all Namespaces, including all cluster-scoped resources, will be candidates for substitution). To mix cluster-scoped and namespaced resources in the same rule, use an empty string (\"\") as one of the target namespaces.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"TestIamPermissionsRequest": {
"description": "Request message for `TestIamPermissions` method.",
"id": "TestIamPermissionsRequest",
"properties": {
"permissions": {
"description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"TestIamPermissionsResponse": {
"description": "Response message for `TestIamPermissions` method.",
"id": "TestIamPermissionsResponse",
"properties": {
"permissions": {
"description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"TimeOfDay": {
"description": "Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.",
"id": "TimeOfDay",
"properties": {
"hours": {
"description": "Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.",
"format": "int32",
"type": "integer"
},
"minutes": {
"description": "Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.",
"format": "int32",
"type": "integer"
},
"nanos": {
"description": "Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.",
"format": "int32",
"type": "integer"
},
"seconds": {
"description": "Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"TransformationRule": {
"description": "A transformation rule to be applied against Kubernetes resources as they are selected for restoration from a Backup. A rule contains both filtering logic (which resources are subject to transform) and transformation logic.",
"id": "TransformationRule",
"properties": {
"description": {
"description": "Optional. The description is a user specified string description of the transformation rule.",
"type": "string"
},
"fieldActions": {
"description": "Required. A list of transformation rule actions to take against candidate resources. Actions are executed in order defined - this order matters, as they could potentially interfere with each other and the first operation could affect the outcome of the second operation.",
"items": {
"$ref": "TransformationRuleAction"
},
"type": "array"
},
"resourceFilter": {
"$ref": "ResourceFilter",
"description": "Optional. This field is used to specify a set of fields that should be used to determine which resources in backup should be acted upon by the supplied transformation rule actions, and this will ensure that only specific resources are affected by transformation rule actions."
}
},
"type": "object"
},
"TransformationRuleAction": {
"description": "TransformationRuleAction defines a TransformationRule action based on the JSON Patch RFC (https://www.rfc-editor.org/rfc/rfc6902)",
"id": "TransformationRuleAction",
"properties": {
"fromPath": {
"description": "Optional. A string containing a JSON Pointer value that references the location in the target document to move the value from.",
"type": "string"
},
"op": {
"description": "Required. op specifies the operation to perform.",
"enum": [
"OP_UNSPECIFIED",
"REMOVE",
"MOVE",
"COPY",
"ADD",
"TEST",
"REPLACE"
],
"enumDescriptions": [
"Unspecified operation",
"The \"remove\" operation removes the value at the target location.",
"The \"move\" operation removes the value at a specified location and adds it to the target location.",
"The \"copy\" operation copies the value at a specified location to the target location.",
"The \"add\" operation performs one of the following functions, depending upon what the target location references: 1. If the target location specifies an array index, a new value is inserted into the array at the specified index. 2. If the target location specifies an object member that does not already exist, a new member is added to the object. 3. If the target location specifies an object member that does exist, that member's value is replaced.",
"The \"test\" operation tests that a value at the target location is equal to a specified value.",
"The \"replace\" operation replaces the value at the target location with a new value. The operation object MUST contain a \"value\" member whose content specifies the replacement value."
],
"type": "string"
},
"path": {
"description": "Optional. A string containing a JSON-Pointer value that references a location within the target document where the operation is performed.",
"type": "string"
},
"value": {
"description": "Optional. A string that specifies the desired value in string format to use for transformation.",
"type": "string"
}
},
"type": "object"
},
"TroubleshootingInfo": {
"description": "Stores information about troubleshooting doc for debugging a particular state of an operation (eg - backup/restore). This will be used by the end user to debug their operation failure scenario easily.",
"id": "TroubleshootingInfo",
"properties": {
"stateReasonCode": {
"description": "Output only. Unique code for each backup/restore operation failure message which helps user identify the failure.",
"readOnly": true,
"type": "string"
},
"stateReasonUri": {
"description": "Output only. URL for the troubleshooting doc which will help the user fix the failing backup/restore operation.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"VolumeBackup": {
"description": "Represents the backup of a specific persistent volume as a component of a Backup - both the record of the operation and a pointer to the underlying storage-specific artifacts.",
"id": "VolumeBackup",
"properties": {
"completeTime": {
"description": "Output only. The timestamp when the associated underlying volume backup operation completed.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"createTime": {
"description": "Output only. The timestamp when this VolumeBackup resource was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"diskSizeBytes": {
"description": "Output only. The minimum size of the disk to which this VolumeBackup can be restored.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"etag": {
"description": "Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a volume backup from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform volume backup updates in order to avoid race conditions.",
"readOnly": true,
"type": "string"
},
"format": {
"description": "Output only. The format used for the volume backup.",
"enum": [
"VOLUME_BACKUP_FORMAT_UNSPECIFIED",
"GCE_PERSISTENT_DISK"
],
"enumDescriptions": [
"Default value, not specified.",
"Compute Engine Persistent Disk snapshot based volume backup."
],
"readOnly": true,
"type": "string"
},
"name": {
"description": "Output only. The full name of the VolumeBackup resource. Format: `projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*`.",
"readOnly": true,
"type": "string"
},
"satisfiesPzi": {
"description": "Output only. [Output Only] Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"satisfiesPzs": {
"description": "Output only. [Output Only] Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"sourcePvc": {
"$ref": "NamespacedName",
"description": "Output only. A reference to the source Kubernetes PVC from which this VolumeBackup was created.",
"readOnly": true
},
"state": {
"description": "Output only. The current state of this VolumeBackup.",
"enum": [
"STATE_UNSPECIFIED",
"CREATING",
"SNAPSHOTTING",
"UPLOADING",
"SUCCEEDED",
"FAILED",
"DELETING",
"CLEANED_UP"
],
"enumDescriptions": [
"This is an illegal state and should not be encountered.",
"A volume for the backup was identified and backup process is about to start.",
"The volume backup operation has begun and is in the initial \"snapshot\" phase of the process. Any defined ProtectedApplication \"pre\" hooks will be executed before entering this state and \"post\" hooks will be executed upon leaving this state.",
"The snapshot phase of the volume backup operation has completed and the snapshot is now being uploaded to backup storage.",
"The volume backup operation has completed successfully.",
"The volume backup operation has failed.",
"This VolumeBackup resource (and its associated artifacts) is in the process of being deleted.",
"The underlying artifacts of a volume backup (eg: persistent disk snapshots) are deleted."
],
"readOnly": true,
"type": "string"
},
"stateMessage": {
"description": "Output only. A human readable message explaining why the VolumeBackup is in its current state. This field is only meant for human consumption and should not be used programmatically as this field is not guaranteed to be consistent.",
"readOnly": true,
"type": "string"
},
"storageBytes": {
"description": "Output only. The aggregate size of the underlying artifacts associated with this VolumeBackup in the backup storage. This may change over time when multiple backups of the same volume share the same backup storage location. In particular, this is likely to increase in size when the immediately preceding backup of the same volume is deleted.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"uid": {
"description": "Output only. Server generated global unique identifier of [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format.",
"readOnly": true,
"type": "string"
},
"updateTime": {
"description": "Output only. The timestamp when this VolumeBackup resource was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"volumeBackupHandle": {
"description": "Output only. A storage system-specific opaque handle to the underlying volume backup.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"VolumeDataRestorePolicyBinding": {
"description": "Binds resources in the scope to the given VolumeDataRestorePolicy.",
"id": "VolumeDataRestorePolicyBinding",
"properties": {
"policy": {
"description": "Required. The VolumeDataRestorePolicy to apply when restoring volumes in scope.",
"enum": [
"VOLUME_DATA_RESTORE_POLICY_UNSPECIFIED",
"RESTORE_VOLUME_DATA_FROM_BACKUP",
"REUSE_VOLUME_HANDLE_FROM_BACKUP",
"NO_VOLUME_DATA_RESTORATION"
],
"enumDescriptions": [
"Unspecified (illegal).",
"For each PVC to be restored, create a new underlying volume and PV from the corresponding VolumeBackup contained within the Backup.",
"For each PVC to be restored, attempt to reuse the original PV contained in the Backup (with its original underlying volume). This option is likely only usable when restoring a workload to its original cluster.",
"For each PVC to be restored, create PVC without any particular action to restore data. In this case, the normal Kubernetes provisioning logic would kick in, and this would likely result in either dynamically provisioning blank PVs or binding to statically provisioned PVs."
],
"type": "string"
},
"volumeType": {
"description": "The volume type, as determined by the PVC's bound PV, to apply the policy to.",
"enum": [
"VOLUME_TYPE_UNSPECIFIED",
"GCE_PERSISTENT_DISK"
],
"enumDescriptions": [
"Default",
"Compute Engine Persistent Disk volume"
],
"type": "string"
}
},
"type": "object"
},
"VolumeDataRestorePolicyOverride": {
"description": "Defines an override to apply a VolumeDataRestorePolicy for scoped resources.",
"id": "VolumeDataRestorePolicyOverride",
"properties": {
"policy": {
"description": "Required. The VolumeDataRestorePolicy to apply when restoring volumes in scope.",
"enum": [
"VOLUME_DATA_RESTORE_POLICY_UNSPECIFIED",
"RESTORE_VOLUME_DATA_FROM_BACKUP",
"REUSE_VOLUME_HANDLE_FROM_BACKUP",
"NO_VOLUME_DATA_RESTORATION"
],
"enumDescriptions": [
"Unspecified (illegal).",
"For each PVC to be restored, create a new underlying volume and PV from the corresponding VolumeBackup contained within the Backup.",
"For each PVC to be restored, attempt to reuse the original PV contained in the Backup (with its original underlying volume). This option is likely only usable when restoring a workload to its original cluster.",
"For each PVC to be restored, create PVC without any particular action to restore data. In this case, the normal Kubernetes provisioning logic would kick in, and this would likely result in either dynamically provisioning blank PVs or binding to statically provisioned PVs."
],
"type": "string"
},
"selectedPvcs": {
"$ref": "NamespacedNames",
"description": "A list of PVCs to apply the policy override to."
}
},
"type": "object"
},
"VolumeRestore": {
"description": "Represents the operation of restoring a volume from a VolumeBackup.",
"id": "VolumeRestore",
"properties": {
"completeTime": {
"description": "Output only. The timestamp when the associated underlying volume restoration completed.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"createTime": {
"description": "Output only. The timestamp when this VolumeRestore resource was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"etag": {
"description": "Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a volume restore from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform volume restore updates in order to avoid race conditions.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Output only. Full name of the VolumeRestore resource. Format: `projects/*/locations/*/restorePlans/*/restores/*/volumeRestores/*`",
"readOnly": true,
"type": "string"
},
"state": {
"description": "Output only. The current state of this VolumeRestore.",
"enum": [
"STATE_UNSPECIFIED",
"CREATING",
"RESTORING",
"SUCCEEDED",
"FAILED",
"DELETING"
],
"enumDescriptions": [
"This is an illegal state and should not be encountered.",
"A volume for the restore was identified and restore process is about to start.",
"The volume is currently being restored.",
"The volume has been successfully restored.",
"The volume restoration process failed.",
"This VolumeRestore resource is in the process of being deleted."
],
"readOnly": true,
"type": "string"
},
"stateMessage": {
"description": "Output only. A human readable message explaining why the VolumeRestore is in its current state.",
"readOnly": true,
"type": "string"
},
"targetPvc": {
"$ref": "NamespacedName",
"description": "Output only. The reference to the target Kubernetes PVC to be restored.",
"readOnly": true
},
"uid": {
"description": "Output only. Server generated global unique identifier of [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format.",
"readOnly": true,
"type": "string"
},
"updateTime": {
"description": "Output only. The timestamp when this VolumeRestore resource was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"volumeBackup": {
"description": "Output only. The full name of the VolumeBackup from which the volume will be restored. Format: `projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*`.",
"readOnly": true,
"type": "string"
},
"volumeHandle": {
"description": "Output only. A storage system-specific opaque handler to the underlying volume created for the target PVC from the volume backup.",
"readOnly": true,
"type": "string"
},
"volumeType": {
"description": "Output only. The type of volume provisioned",
"enum": [
"VOLUME_TYPE_UNSPECIFIED",
"GCE_PERSISTENT_DISK"
],
"enumDescriptions": [
"Default",
"Compute Engine Persistent Disk volume"
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
},
"servicePath": "",
"title": "Backup for GKE API",
"version": "v1",
"version_module": true
}