Cloud Firestore API . projects . databases . backupSchedules

close()

Close httplib2 connections.

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

Creates a backup schedule on a database. At most two backup schedules can be configured on a database, one daily backup schedule and one weekly backup schedule.

Args:
  parent: string, Required. The parent database. Format `projects/{project}/databases/{database}` (required)
  body: object, The request body.
    The object takes the form of:

{ # A backup schedule for a Cloud Firestore Database. This resource is owned by the database it is backing up, and is deleted along with the database. The actual backups are not though.
  "createTime": "A String", # Output only. The timestamp at which this backup schedule was created and effective since. No backups will be created for this schedule before this time.
  "dailyRecurrence": { # Represents a recurring schedule that runs every day. The time zone is UTC. # For a schedule that runs daily.
  },
  "name": "A String", # Output only. The unique backup schedule identifier across all locations and databases for the given project. This will be auto-assigned. Format is `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}`
  "retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention period is 14 weeks.
  "updateTime": "A String", # Output only. The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as create_time.
  "weeklyRecurrence": { # Represents a recurring schedule that runs on a specified day of the week. The time zone is UTC. # For a schedule that runs weekly on a specific day.
    "day": "A String", # The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed.
  },
}

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

Returns:
  An object of the form:

    { # A backup schedule for a Cloud Firestore Database. This resource is owned by the database it is backing up, and is deleted along with the database. The actual backups are not though.
  "createTime": "A String", # Output only. The timestamp at which this backup schedule was created and effective since. No backups will be created for this schedule before this time.
  "dailyRecurrence": { # Represents a recurring schedule that runs every day. The time zone is UTC. # For a schedule that runs daily.
  },
  "name": "A String", # Output only. The unique backup schedule identifier across all locations and databases for the given project. This will be auto-assigned. Format is `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}`
  "retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention period is 14 weeks.
  "updateTime": "A String", # Output only. The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as create_time.
  "weeklyRecurrence": { # Represents a recurring schedule that runs on a specified day of the week. The time zone is UTC. # For a schedule that runs weekly on a specific day.
    "day": "A String", # The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed.
  },
}

delete(name, x__xgafv=None)

Deletes a backup schedule.

Args:
  name: string, Required. The name of the backup schedule. Format `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # 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); }
}

get(name, x__xgafv=None)

Gets information about a backup schedule.

Args:
  name: string, Required. The name of the backup schedule. Format `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A backup schedule for a Cloud Firestore Database. This resource is owned by the database it is backing up, and is deleted along with the database. The actual backups are not though.
  "createTime": "A String", # Output only. The timestamp at which this backup schedule was created and effective since. No backups will be created for this schedule before this time.
  "dailyRecurrence": { # Represents a recurring schedule that runs every day. The time zone is UTC. # For a schedule that runs daily.
  },
  "name": "A String", # Output only. The unique backup schedule identifier across all locations and databases for the given project. This will be auto-assigned. Format is `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}`
  "retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention period is 14 weeks.
  "updateTime": "A String", # Output only. The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as create_time.
  "weeklyRecurrence": { # Represents a recurring schedule that runs on a specified day of the week. The time zone is UTC. # For a schedule that runs weekly on a specific day.
    "day": "A String", # The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed.
  },
}

list(parent, x__xgafv=None)

List backup schedules.

Args:
  parent: string, Required. The parent database. Format is `projects/{project}/databases/{database}`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response for FirestoreAdmin.ListBackupSchedules.
  "backupSchedules": [ # List of all backup schedules.
    { # A backup schedule for a Cloud Firestore Database. This resource is owned by the database it is backing up, and is deleted along with the database. The actual backups are not though.
      "createTime": "A String", # Output only. The timestamp at which this backup schedule was created and effective since. No backups will be created for this schedule before this time.
      "dailyRecurrence": { # Represents a recurring schedule that runs every day. The time zone is UTC. # For a schedule that runs daily.
      },
      "name": "A String", # Output only. The unique backup schedule identifier across all locations and databases for the given project. This will be auto-assigned. Format is `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}`
      "retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention period is 14 weeks.
      "updateTime": "A String", # Output only. The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as create_time.
      "weeklyRecurrence": { # Represents a recurring schedule that runs on a specified day of the week. The time zone is UTC. # For a schedule that runs weekly on a specific day.
        "day": "A String", # The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed.
      },
    },
  ],
}

patch(name, body=None, updateMask=None, x__xgafv=None)

Updates a backup schedule.

Args:
  name: string, Output only. The unique backup schedule identifier across all locations and databases for the given project. This will be auto-assigned. Format is `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}` (required)
  body: object, The request body.
    The object takes the form of:

{ # A backup schedule for a Cloud Firestore Database. This resource is owned by the database it is backing up, and is deleted along with the database. The actual backups are not though.
  "createTime": "A String", # Output only. The timestamp at which this backup schedule was created and effective since. No backups will be created for this schedule before this time.
  "dailyRecurrence": { # Represents a recurring schedule that runs every day. The time zone is UTC. # For a schedule that runs daily.
  },
  "name": "A String", # Output only. The unique backup schedule identifier across all locations and databases for the given project. This will be auto-assigned. Format is `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}`
  "retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention period is 14 weeks.
  "updateTime": "A String", # Output only. The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as create_time.
  "weeklyRecurrence": { # Represents a recurring schedule that runs on a specified day of the week. The time zone is UTC. # For a schedule that runs weekly on a specific day.
    "day": "A String", # The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed.
  },
}

  updateMask: string, The list of fields to be updated.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A backup schedule for a Cloud Firestore Database. This resource is owned by the database it is backing up, and is deleted along with the database. The actual backups are not though.
  "createTime": "A String", # Output only. The timestamp at which this backup schedule was created and effective since. No backups will be created for this schedule before this time.
  "dailyRecurrence": { # Represents a recurring schedule that runs every day. The time zone is UTC. # For a schedule that runs daily.
  },
  "name": "A String", # Output only. The unique backup schedule identifier across all locations and databases for the given project. This will be auto-assigned. Format is `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}`
  "retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention period is 14 weeks.
  "updateTime": "A String", # Output only. The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as create_time.
  "weeklyRecurrence": { # Represents a recurring schedule that runs on a specified day of the week. The time zone is UTC. # For a schedule that runs weekly on a specific day.
    "day": "A String", # The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed.
  },
}