Blame - docs/dyn/file_v1beta1.projects.locations.backups.html - platform/external/python/google-api-python-client

blob: 742e487319dedd2d726f7994bc3a290649d73cbb [file] [log] [blame]

Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	1	<html><body>
				2	<style>
				3
				4	body, h1, h2, h3, div, span, p, pre, a {
				5	margin: 0;
				6	padding: 0;
				7	border: 0;
				8	font-weight: inherit;
				9	font-style: inherit;
				10	font-size: 100%;
				11	font-family: inherit;
				12	vertical-align: baseline;
				13	}
				14
				15	body {
				16	font-size: 13px;
				17	padding: 1em;
				18	}
				19
				20	h1 {
				21	font-size: 26px;
				22	margin-bottom: 1em;
				23	}
				24
				25	h2 {
				26	font-size: 24px;
				27	margin-bottom: 1em;
				28	}
				29
				30	h3 {
				31	font-size: 20px;
				32	margin-bottom: 1em;
				33	margin-top: 1em;
				34	}
				35
				36	pre, code {
				37	line-height: 1.5;
				38	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
				39	}
				40
				41	pre {
				42	margin-top: 0.5em;
				43	}
				44
				45	h1, h2, h3, p {
				46	font-family: Arial, sans serif;
				47	}
				48
				49	h1, h2, h3 {
				50	border-bottom: solid #CCC 1px;
				51	}
				52
				53	.toc_element {
				54	margin-top: 0.5em;
				55	}
				56
				57	.firstline {
				58	margin-left: 2 em;
				59	}
				60
				61	.method {
				62	margin-top: 1em;
				63	border: solid 1px #CCC;
				64	padding: 1em;
				65	background: #EEE;
				66	}
				67
				68	.details {
				69	font-weight: bold;
				70	font-size: 14px;
				71	}
				72
				73	</style>
				74
				75	<h1><a href="file_v1beta1.html">Cloud Filestore API</a> . <a href="file_v1beta1.projects.html">projects</a> . <a href="file_v1beta1.projects.locations.html">locations</a> . <a href="file_v1beta1.projects.locations.backups.html">backups</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
				78	<code><a href="#close">close()</a></code></p>
				79	<p class="firstline">Close httplib2 connections.</p>
				80	<p class="toc_element">
				81	<code><a href="#create">create(parent, body=None, backupId=None, x__xgafv=None)</a></code></p>
				82	<p class="firstline">Creates a backup.</p>
				83	<p class="toc_element">
				84	<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
				85	<p class="firstline">Deletes a backup.</p>
				86	<p class="toc_element">
				87	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
				88	<p class="firstline">Gets the details of a specific backup.</p>
				89	<p class="toc_element">
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	90	<code><a href="#list">list(parent, pageSize=None, filter=None, orderBy=None, pageToken=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	91	<p class="firstline">Lists all backups in a project for either a specified location or for all locations.</p>
				92	<p class="toc_element">
				93	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				94	<p class="firstline">Retrieves the next page of results.</p>
				95	<p class="toc_element">
				96	<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
				97	<p class="firstline">Updates the settings of a specific backup.</p>
				98	<h3>Method Details</h3>
				99	<div class="method">
				100	<code class="details" id="close">close()</code>
				101	<pre>Close httplib2 connections.</pre>
				102	</div>
				103
				104	<div class="method">
				105	<code class="details" id="create">create(parent, body=None, backupId=None, x__xgafv=None)</code>
				106	<pre>Creates a backup.
				107
				108	Args:
				109	parent: string, Required. The backup's project and location, in the format projects/{project_id}/locations/{location}. In Cloud Filestore, backup locations map to GCP regions, for example us-west1. (required)
				110	body: object, The request body.
				111	The object takes the form of:
				112
				113	{ # A Cloud Filestore backup.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	114	"downloadBytes": "A String", # Output only. Amount of bytes that will be downloaded if the backup is restored
				115	"sourceInstance": "A String", # The resource name of the source Cloud Filestore instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}, used to create this backup.
				116	"sourceFileShare": "A String", # Name of the file share in the source Cloud Filestore instance that the backup is created from.
				117	"state": "A String", # Output only. The backup state.
				118	"description": "A String", # A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.
				119	"labels": { # Resource labels to represent user provided metadata.
				120	"a_key": "A String",
				121	},
				122	"storageBytes": "A String", # Output only. The size of the storage used by the backup. As backups share storage, this number is expected to change with backup creation/deletion.
				123	"capacityGb": "A String", # Output only. Capacity of the source file share when the backup was created.
				124	"sourceInstanceTier": "A String", # Output only. The service tier of the source Cloud Filestore instance that this backup is created from.
				125	"createTime": "A String", # Output only. The time when the backup was created.
				126	"name": "A String", # Output only. The resource name of the backup, in the format projects/{project_id}/locations/{location_id}/backups/{backup_id}.
				127	}
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	128
				129	backupId: string, Required. The ID to use for the backup. The ID must be unique within the specified project and location. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
				130	x__xgafv: string, V1 error format.
				131	Allowed values
				132	1 - v1 error format
				133	2 - v2 error format
				134
				135	Returns:
				136	An object of the form:
				137
				138	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	139	"response": { # The normal response of the operation in case of success. 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`.
				140	"a_key": "", # Properties of the object. Contains field @type with type URL.
				141	},
				142	"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}`.
				143	"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.
				144	"a_key": "", # Properties of the object. Contains field @type with type URL.
				145	},
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	146	"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.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	147	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	148	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				149	{
				150	"a_key": "", # Properties of the object. Contains field @type with type URL.
				151	},
				152	],
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	153	"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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	154	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	155	"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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	156	}</pre>
				157	</div>
				158
				159	<div class="method">
				160	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
				161	<pre>Deletes a backup.
				162
				163	Args:
				164	name: string, Required. The backup resource name, in the format projects/{project_id}/locations/{location}/backups/{backup_id} (required)
				165	x__xgafv: string, V1 error format.
				166	Allowed values
				167	1 - v1 error format
				168	2 - v2 error format
				169
				170	Returns:
				171	An object of the form:
				172
				173	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	174	"response": { # The normal response of the operation in case of success. 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`.
				175	"a_key": "", # Properties of the object. Contains field @type with type URL.
				176	},
				177	"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}`.
				178	"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.
				179	"a_key": "", # Properties of the object. Contains field @type with type URL.
				180	},
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	181	"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.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	182	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	183	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				184	{
				185	"a_key": "", # Properties of the object. Contains field @type with type URL.
				186	},
				187	],
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	188	"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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	189	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	190	"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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	191	}</pre>
				192	</div>
				193
				194	<div class="method">
				195	<code class="details" id="get">get(name, x__xgafv=None)</code>
				196	<pre>Gets the details of a specific backup.
				197
				198	Args:
				199	name: string, Required. The backup resource name, in the format projects/{project_id}/locations/{location}/backups/{backup_id}. (required)
				200	x__xgafv: string, V1 error format.
				201	Allowed values
				202	1 - v1 error format
				203	2 - v2 error format
				204
				205	Returns:
				206	An object of the form:
				207
				208	{ # A Cloud Filestore backup.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	209	"downloadBytes": "A String", # Output only. Amount of bytes that will be downloaded if the backup is restored
				210	"sourceInstance": "A String", # The resource name of the source Cloud Filestore instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}, used to create this backup.
				211	"sourceFileShare": "A String", # Name of the file share in the source Cloud Filestore instance that the backup is created from.
				212	"state": "A String", # Output only. The backup state.
				213	"description": "A String", # A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.
				214	"labels": { # Resource labels to represent user provided metadata.
				215	"a_key": "A String",
				216	},
				217	"storageBytes": "A String", # Output only. The size of the storage used by the backup. As backups share storage, this number is expected to change with backup creation/deletion.
				218	"capacityGb": "A String", # Output only. Capacity of the source file share when the backup was created.
				219	"sourceInstanceTier": "A String", # Output only. The service tier of the source Cloud Filestore instance that this backup is created from.
				220	"createTime": "A String", # Output only. The time when the backup was created.
				221	"name": "A String", # Output only. The resource name of the backup, in the format projects/{project_id}/locations/{location_id}/backups/{backup_id}.
				222	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	223	</div>
				224
				225	<div class="method">
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	226	<code class="details" id="list">list(parent, pageSize=None, filter=None, orderBy=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	227	<pre>Lists all backups in a project for either a specified location or for all locations.
				228
				229	Args:
				230	parent: string, Required. The project and location for which to retrieve backup information, in the format projects/{project_id}/locations/{location}. In Cloud Filestore, backup locations map to GCP regions, for example us-west1. To retrieve backup information for all locations, use "-" for the {location} value. (required)
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	231	pageSize: integer, The maximum number of items to return.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	232	filter: string, List filter.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	233	orderBy: string, Sort results. Supported values are "name", "name desc" or "" (unsorted).
				234	pageToken: string, The next_page_token value to use if there are additional results to retrieve for this list request.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	235	x__xgafv: string, V1 error format.
				236	Allowed values
				237	1 - v1 error format
				238	2 - v2 error format
				239
				240	Returns:
				241	An object of the form:
				242
				243	{ # ListBackupsResponse is the result of ListBackupsRequest.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	244	"nextPageToken": "A String", # The token you can use to retrieve the next page of results. Not returned if there are no more results in the list.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	245	"backups": [ # A list of backups in the project for the specified location. If the {location} value in the request is "-", the response contains a list of backups from all locations. If any location is unreachable, the response will only return backups in reachable locations and the "unreachable" field will be populated with a list of unreachable locations.
				246	{ # A Cloud Filestore backup.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	247	"downloadBytes": "A String", # Output only. Amount of bytes that will be downloaded if the backup is restored
				248	"sourceInstance": "A String", # The resource name of the source Cloud Filestore instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}, used to create this backup.
				249	"sourceFileShare": "A String", # Name of the file share in the source Cloud Filestore instance that the backup is created from.
				250	"state": "A String", # Output only. The backup state.
				251	"description": "A String", # A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.
				252	"labels": { # Resource labels to represent user provided metadata.
				253	"a_key": "A String",
				254	},
				255	"storageBytes": "A String", # Output only. The size of the storage used by the backup. As backups share storage, this number is expected to change with backup creation/deletion.
				256	"capacityGb": "A String", # Output only. Capacity of the source file share when the backup was created.
				257	"sourceInstanceTier": "A String", # Output only. The service tier of the source Cloud Filestore instance that this backup is created from.
				258	"createTime": "A String", # Output only. The time when the backup was created.
				259	"name": "A String", # Output only. The resource name of the backup, in the format projects/{project_id}/locations/{location_id}/backups/{backup_id}.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	260	},
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	261	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	262	"unreachable": [ # Locations that could not be reached.
				263	"A String",
				264	],
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	265	}</pre>
				266	</div>
				267
				268	<div class="method">
				269	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				270	<pre>Retrieves the next page of results.
				271
				272	Args:
				273	previous_request: The request for the previous page. (required)
				274	previous_response: The response from the request for the previous page. (required)
				275
				276	Returns:
				277	A request object that you can call 'execute()' on to request the next
				278	page. Returns None if there are no more items in the collection.
				279	</pre>
				280	</div>
				281
				282	<div class="method">
				283	<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
				284	<pre>Updates the settings of a specific backup.
				285
				286	Args:
				287	name: string, Output only. The resource name of the backup, in the format projects/{project_id}/locations/{location_id}/backups/{backup_id}. (required)
				288	body: object, The request body.
				289	The object takes the form of:
				290
				291	{ # A Cloud Filestore backup.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	292	"downloadBytes": "A String", # Output only. Amount of bytes that will be downloaded if the backup is restored
				293	"sourceInstance": "A String", # The resource name of the source Cloud Filestore instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}, used to create this backup.
				294	"sourceFileShare": "A String", # Name of the file share in the source Cloud Filestore instance that the backup is created from.
				295	"state": "A String", # Output only. The backup state.
				296	"description": "A String", # A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.
				297	"labels": { # Resource labels to represent user provided metadata.
				298	"a_key": "A String",
				299	},
				300	"storageBytes": "A String", # Output only. The size of the storage used by the backup. As backups share storage, this number is expected to change with backup creation/deletion.
				301	"capacityGb": "A String", # Output only. Capacity of the source file share when the backup was created.
				302	"sourceInstanceTier": "A String", # Output only. The service tier of the source Cloud Filestore instance that this backup is created from.
				303	"createTime": "A String", # Output only. The time when the backup was created.
				304	"name": "A String", # Output only. The resource name of the backup, in the format projects/{project_id}/locations/{location_id}/backups/{backup_id}.
				305	}
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	306
				307	updateMask: string, Required. Mask of fields to update. At least one path must be supplied in this field.
				308	x__xgafv: string, V1 error format.
				309	Allowed values
				310	1 - v1 error format
				311	2 - v2 error format
				312
				313	Returns:
				314	An object of the form:
				315
				316	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	317	"response": { # The normal response of the operation in case of success. 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`.
				318	"a_key": "", # Properties of the object. Contains field @type with type URL.
				319	},
				320	"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}`.
				321	"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.
				322	"a_key": "", # Properties of the object. Contains field @type with type URL.
				323	},
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	324	"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.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	325	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	326	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				327	{
				328	"a_key": "", # Properties of the object. Contains field @type with type URL.
				329	},
				330	],
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	331	"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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	332	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	333	"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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	334	}</pre>
				335	</div>
				336
				337	</body></html>