Looker (Google Cloud core) API . projects . locations . instances . backups

Instance Methods

close()

Close httplib2 connections.

create(parent, body=None, x__xgafv=None)

Backup Looker instance.

delete(name, x__xgafv=None)

Delete backup.

get(name, x__xgafv=None)

list(parent, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

List backups of Looker instance.

list_next()

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
create(parent, body=None, x__xgafv=None)
Backup Looker instance.

Args:
  parent: string, Required. Format: projects/{project}/locations/{location}/instances/{instance} (required)
  body: object, The request body.
    The object takes the form of:

{ # The details of a backup resource.
  "createTime": "A String", # Output only. The time when the backup was started.
  "encryptionConfig": { # Encryption configuration (i.e. CMEK). # Output only. Current status of the CMEK encryption
    "kmsKeyName": "A String", # Name of the CMEK key in KMS (input parameter).
    "kmsKeyNameVersion": "A String", # Output only. Full name and version of the CMEK key currently in use to encrypt Looker data. Format: `projects/{project}/locations/{location}/keyRings/{ring}/cryptoKeys/{key}/cryptoKeyVersions/{version}`. Empty if CMEK is not configured in this instance.
    "kmsKeyState": "A String", # Output only. Status of the CMEK key.
  },
  "expireTime": "A String", # Output only. The time when the backup will be deleted.
  "name": "A String", # Immutable. The relative resource name of the backup, in the following form: `projects/{project_number}/locations/{location_id}/instances/{instance_id}/backups/{backup}`
  "state": "A String", # Output only. The current state of the backup.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  "done": True or False, # 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.
  "error": { # 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). # The error result of the operation in case of failure or cancellation.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # 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.
  },
  "metadata": { # 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.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
  "name": "A String", # 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}`.
  "response": { # 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`.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
}
delete(name, x__xgafv=None)
Delete backup.

Args:
  name: string, Required. Format: projects/{project}/locations/{location}/instances/{instance}/backups/{backup} (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  "done": True or False, # 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.
  "error": { # 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). # The error result of the operation in case of failure or cancellation.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # 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.
  },
  "metadata": { # 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.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
  "name": "A String", # 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}`.
  "response": { # 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`.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
}
get(name, x__xgafv=None)

Args:
  name: string, Required. Format: `projects/{project}/locations/{location}/instances/{instance}/backups/{backup}`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The details of a backup resource.
  "createTime": "A String", # Output only. The time when the backup was started.
  "encryptionConfig": { # Encryption configuration (i.e. CMEK). # Output only. Current status of the CMEK encryption
    "kmsKeyName": "A String", # Name of the CMEK key in KMS (input parameter).
    "kmsKeyNameVersion": "A String", # Output only. Full name and version of the CMEK key currently in use to encrypt Looker data. Format: `projects/{project}/locations/{location}/keyRings/{ring}/cryptoKeys/{key}/cryptoKeyVersions/{version}`. Empty if CMEK is not configured in this instance.
    "kmsKeyState": "A String", # Output only. Status of the CMEK key.
  },
  "expireTime": "A String", # Output only. The time when the backup will be deleted.
  "name": "A String", # Immutable. The relative resource name of the backup, in the following form: `projects/{project_number}/locations/{location_id}/instances/{instance_id}/backups/{backup}`
  "state": "A String", # Output only. The current state of the backup.
}
list(parent, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
List backups of Looker instance.

Args:
  parent: string, Required. Format: projects/{project}/locations/{location}/instances/{instance}. (required)
  orderBy: string, Sort results. Default order is "create_time desc". Other supported fields are "state" and "expire_time". https://google.aip.dev/132#ordering
  pageSize: integer, The maximum number of instances to return.
  pageToken: string, A page token received from a previous ListInstances request.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response from listing Looker instance backups.
  "instanceBackups": [ # The list of instances matching the request filters, up to the requested `page_size`.
    { # The details of a backup resource.
      "createTime": "A String", # Output only. The time when the backup was started.
      "encryptionConfig": { # Encryption configuration (i.e. CMEK). # Output only. Current status of the CMEK encryption
        "kmsKeyName": "A String", # Name of the CMEK key in KMS (input parameter).
        "kmsKeyNameVersion": "A String", # Output only. Full name and version of the CMEK key currently in use to encrypt Looker data. Format: `projects/{project}/locations/{location}/keyRings/{ring}/cryptoKeys/{key}/cryptoKeyVersions/{version}`. Empty if CMEK is not configured in this instance.
        "kmsKeyState": "A String", # Output only. Status of the CMEK key.
      },
      "expireTime": "A String", # Output only. The time when the backup will be deleted.
      "name": "A String", # Immutable. The relative resource name of the backup, in the following form: `projects/{project_number}/locations/{location_id}/instances/{instance_id}/backups/{backup}`
      "state": "A String", # Output only. The current state of the backup.
    },
  ],
  "nextPageToken": "A String", # If provided, a page token that can look up the next `page_size` results. If empty, the results list is exhausted.
  "unreachable": [ # Locations that could not be reached.
    "A String",
  ],
}
list_next()
Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.