| <html><body> | |
| <style> | |
| body, h1, h2, h3, div, span, p, pre, a { | |
| margin: 0; | |
| padding: 0; | |
| border: 0; | |
| font-weight: inherit; | |
| font-style: inherit; | |
| font-size: 100%; | |
| font-family: inherit; | |
| vertical-align: baseline; | |
| } | |
| body { | |
| font-size: 13px; | |
| padding: 1em; | |
| } | |
| h1 { | |
| font-size: 26px; | |
| margin-bottom: 1em; | |
| } | |
| h2 { | |
| font-size: 24px; | |
| margin-bottom: 1em; | |
| } | |
| h3 { | |
| font-size: 20px; | |
| margin-bottom: 1em; | |
| margin-top: 1em; | |
| } | |
| pre, code { | |
| line-height: 1.5; | |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; | |
| } | |
| pre { | |
| margin-top: 0.5em; | |
| } | |
| h1, h2, h3, p { | |
| font-family: Arial, sans serif; | |
| } | |
| h1, h2, h3 { | |
| border-bottom: solid #CCC 1px; | |
| } | |
| .toc_element { | |
| margin-top: 0.5em; | |
| } | |
| .firstline { | |
| margin-left: 2 em; | |
| } | |
| .method { | |
| margin-top: 1em; | |
| border: solid 1px #CCC; | |
| padding: 1em; | |
| background: #EEE; | |
| } | |
| .details { | |
| font-weight: bold; | |
| font-size: 14px; | |
| } | |
| </style> | |
| <h1><a href="firestore_v1.html">Cloud Firestore API</a> . <a href="firestore_v1.projects.html">projects</a> . <a href="firestore_v1.projects.databases.html">databases</a> . <a href="firestore_v1.projects.databases.backupSchedules.html">backupSchedules</a></h1> | |
| <h2>Instance Methods</h2> | |
| <p class="toc_element"> | |
| <code><a href="#close">close()</a></code></p> | |
| <p class="firstline">Close httplib2 connections.</p> | |
| <p class="toc_element"> | |
| <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Creates a backup schedule on a database. At most two backup schedules can be configured on a database, one daily backup schedule with retention up to 7 days and one weekly backup schedule with retention up to 14 weeks.</p> | |
| <p class="toc_element"> | |
| <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Deletes a backup schedule.</p> | |
| <p class="toc_element"> | |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Gets information about a backup schedule.</p> | |
| <p class="toc_element"> | |
| <code><a href="#list">list(parent, x__xgafv=None)</a></code></p> | |
| <p class="firstline">List backup schedules.</p> | |
| <p class="toc_element"> | |
| <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Updates a backup schedule.</p> | |
| <h3>Method Details</h3> | |
| <div class="method"> | |
| <code class="details" id="close">close()</code> | |
| <pre>Close httplib2 connections.</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> | |
| <pre>Creates a backup schedule on a database. At most two backup schedules can be configured on a database, one daily backup schedule with retention up to 7 days and one weekly backup schedule with retention up to 14 weeks. | |
| 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": { # Represent a recurring schedule that runs at a specific time every day. The time zone is UTC. # For a schedule that runs daily at a specified time. | |
| }, | |
| "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. | |
| "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 and time. | |
| "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": { # Represent a recurring schedule that runs at a specific time every day. The time zone is UTC. # For a schedule that runs daily at a specified time. | |
| }, | |
| "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. | |
| "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 and time. | |
| "day": "A String", # The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed. | |
| }, | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="delete">delete(name, x__xgafv=None)</code> | |
| <pre>Deletes a backup schedule. | |
| Args: | |
| name: string, Required. The name of 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); } | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="get">get(name, x__xgafv=None)</code> | |
| <pre>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": { # Represent a recurring schedule that runs at a specific time every day. The time zone is UTC. # For a schedule that runs daily at a specified time. | |
| }, | |
| "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. | |
| "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 and time. | |
| "day": "A String", # The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed. | |
| }, | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="list">list(parent, x__xgafv=None)</code> | |
| <pre>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": { # Represent a recurring schedule that runs at a specific time every day. The time zone is UTC. # For a schedule that runs daily at a specified time. | |
| }, | |
| "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. | |
| "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 and time. | |
| "day": "A String", # The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed. | |
| }, | |
| }, | |
| ], | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> | |
| <pre>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": { # Represent a recurring schedule that runs at a specific time every day. The time zone is UTC. # For a schedule that runs daily at a specified time. | |
| }, | |
| "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. | |
| "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 and time. | |
| "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": { # Represent a recurring schedule that runs at a specific time every day. The time zone is UTC. # For a schedule that runs daily at a specified time. | |
| }, | |
| "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. | |
| "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 and time. | |
| "day": "A String", # The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed. | |
| }, | |
| }</pre> | |
| </div> | |
| </body></html> |