Update docs for 1.4.0 release
diff --git a/docs/dyn/analytics_v3.management.html b/docs/dyn/analytics_v3.management.html
index 6bad005..76936bb 100644
--- a/docs/dyn/analytics_v3.management.html
+++ b/docs/dyn/analytics_v3.management.html
@@ -105,11 +105,6 @@
<p class="firstline">Returns the customMetrics Resource.</p>
<p class="toc_element">
- <code><a href="analytics_v3.management.dailyUploads.html">dailyUploads()</a></code>
-</p>
-<p class="firstline">Returns the dailyUploads Resource.</p>
-
-<p class="toc_element">
<code><a href="analytics_v3.management.experiments.html">experiments()</a></code>
</p>
<p class="firstline">Returns the experiments Resource.</p>
diff --git a/docs/dyn/analytics_v3.management.uploads.html b/docs/dyn/analytics_v3.management.uploads.html
index 7f6c68f..1b63ecc 100644
--- a/docs/dyn/analytics_v3.management.uploads.html
+++ b/docs/dyn/analytics_v3.management.uploads.html
@@ -84,9 +84,6 @@
<code><a href="#list">list(accountId, webPropertyId, customDataSourceId, max_results=None, start_index=None)</a></code></p>
<p class="firstline">List uploads to which the user has access.</p>
<p class="toc_element">
- <code><a href="#migrateDataImport">migrateDataImport(accountId, webPropertyId, customDataSourceId)</a></code></p>
-<p class="firstline">Migrate custom data source and data imports to latest version.</p>
-<p class="toc_element">
<code><a href="#uploadData">uploadData(accountId, webPropertyId, customDataSourceId, media_body=None)</a></code></p>
<p class="firstline">Upload data for a custom data source.</p>
<h3>Method Details</h3>
@@ -172,17 +169,6 @@
</div>
<div class="method">
- <code class="details" id="migrateDataImport">migrateDataImport(accountId, webPropertyId, customDataSourceId)</code>
- <pre>Migrate custom data source and data imports to latest version.
-
-Args:
- accountId: string, Account Id for migration. (required)
- webPropertyId: string, Web property Id for migration. (required)
- customDataSourceId: string, Custom data source Id for migration. (required)
-</pre>
-</div>
-
-<div class="method">
<code class="details" id="uploadData">uploadData(accountId, webPropertyId, customDataSourceId, media_body=None)</code>
<pre>Upload data for a custom data source.
diff --git a/docs/dyn/androidenterprise_v1.collections.html b/docs/dyn/androidenterprise_v1.collections.html
new file mode 100644
index 0000000..8bd44e4
--- /dev/null
+++ b/docs/dyn/androidenterprise_v1.collections.html
@@ -0,0 +1,274 @@
+<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="androidenterprise_v1.html">Google Play MDM API</a> . <a href="androidenterprise_v1.collections.html">collections</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(enterpriseId, collectionId)</a></code></p>
+<p class="firstline">Deletes a collection.</p>
+<p class="toc_element">
+ <code><a href="#get">get(enterpriseId, collectionId)</a></code></p>
+<p class="firstline">Retrieves the details of a collection.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(enterpriseId, body)</a></code></p>
+<p class="firstline">Creates a new collection.</p>
+<p class="toc_element">
+ <code><a href="#list">list(enterpriseId)</a></code></p>
+<p class="firstline">Retrieves the IDs of all the collections for an enterprise.</p>
+<p class="toc_element">
+ <code><a href="#patch">patch(enterpriseId, collectionId, body)</a></code></p>
+<p class="firstline">Updates a collection. This method supports patch semantics.</p>
+<p class="toc_element">
+ <code><a href="#update">update(enterpriseId, collectionId, body)</a></code></p>
+<p class="firstline">Updates a collection.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(enterpriseId, collectionId)</code>
+ <pre>Deletes a collection.
+
+Args:
+ enterpriseId: string, The ID of the enterprise. (required)
+ collectionId: string, The ID of the collection. (required)
+</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(enterpriseId, collectionId)</code>
+ <pre>Retrieves the details of a collection.
+
+Args:
+ enterpriseId: string, The ID of the enterprise. (required)
+ collectionId: string, The ID of the collection. (required)
+
+Returns:
+ An object of the form:
+
+ { # A collection resource defines a named set of apps that is visible to a set of users in the Google Play Store app running on those users' managed devices. Those users can then install any of those apps if they wish (which will trigger creation of install and entitlement resources). A user cannot install an app on a managed device unless the app is listed in at least one collection that is visible to that user.
+ #
+ # Note that the API can be used to directly install an app regardless of whether it is in any collection - so an enterprise has a choice of either directly pushing apps to users, or allowing users to install apps if they want. Which is appropriate will depend on the enterprise's policies and the purpose of the apps concerned.
+ "kind": "androidenterprise#collection", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#collection".
+ "productId": [ # The IDs of the products in the collection, in the order in which they should be displayed.
+ "A String",
+ ],
+ "name": "A String", # A user-friendly name for the collection (should be unique), e.g. "Accounting apps".
+ "visibility": "A String", # Whether this collection is visible to all users, or only to the users that have been granted access through the collection_viewers api. Even if a collection is visible to allUsers, it is possible to add and remove viewers, but this will have no effect until the collection's visibility changes to viewersOnly.
+ "collectionId": "A String", # Arbitrary unique ID, allocated by the API on creation.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(enterpriseId, body)</code>
+ <pre>Creates a new collection.
+
+Args:
+ enterpriseId: string, The ID of the enterprise. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A collection resource defines a named set of apps that is visible to a set of users in the Google Play Store app running on those users' managed devices. Those users can then install any of those apps if they wish (which will trigger creation of install and entitlement resources). A user cannot install an app on a managed device unless the app is listed in at least one collection that is visible to that user.
+ #
+ # Note that the API can be used to directly install an app regardless of whether it is in any collection - so an enterprise has a choice of either directly pushing apps to users, or allowing users to install apps if they want. Which is appropriate will depend on the enterprise's policies and the purpose of the apps concerned.
+ "kind": "androidenterprise#collection", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#collection".
+ "productId": [ # The IDs of the products in the collection, in the order in which they should be displayed.
+ "A String",
+ ],
+ "name": "A String", # A user-friendly name for the collection (should be unique), e.g. "Accounting apps".
+ "visibility": "A String", # Whether this collection is visible to all users, or only to the users that have been granted access through the collection_viewers api. Even if a collection is visible to allUsers, it is possible to add and remove viewers, but this will have no effect until the collection's visibility changes to viewersOnly.
+ "collectionId": "A String", # Arbitrary unique ID, allocated by the API on creation.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # A collection resource defines a named set of apps that is visible to a set of users in the Google Play Store app running on those users' managed devices. Those users can then install any of those apps if they wish (which will trigger creation of install and entitlement resources). A user cannot install an app on a managed device unless the app is listed in at least one collection that is visible to that user.
+ #
+ # Note that the API can be used to directly install an app regardless of whether it is in any collection - so an enterprise has a choice of either directly pushing apps to users, or allowing users to install apps if they want. Which is appropriate will depend on the enterprise's policies and the purpose of the apps concerned.
+ "kind": "androidenterprise#collection", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#collection".
+ "productId": [ # The IDs of the products in the collection, in the order in which they should be displayed.
+ "A String",
+ ],
+ "name": "A String", # A user-friendly name for the collection (should be unique), e.g. "Accounting apps".
+ "visibility": "A String", # Whether this collection is visible to all users, or only to the users that have been granted access through the collection_viewers api. Even if a collection is visible to allUsers, it is possible to add and remove viewers, but this will have no effect until the collection's visibility changes to viewersOnly.
+ "collectionId": "A String", # Arbitrary unique ID, allocated by the API on creation.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(enterpriseId)</code>
+ <pre>Retrieves the IDs of all the collections for an enterprise.
+
+Args:
+ enterpriseId: string, The ID of the enterprise. (required)
+
+Returns:
+ An object of the form:
+
+ { # The collection resources for the enterprise.
+ "kind": "androidenterprise#collectionsListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#collectionsListResponse".
+ "collection": [ # An ordered collection of products which can be made visible on the Google Play Store app to a selected group of users.
+ { # A collection resource defines a named set of apps that is visible to a set of users in the Google Play Store app running on those users' managed devices. Those users can then install any of those apps if they wish (which will trigger creation of install and entitlement resources). A user cannot install an app on a managed device unless the app is listed in at least one collection that is visible to that user.
+ #
+ # Note that the API can be used to directly install an app regardless of whether it is in any collection - so an enterprise has a choice of either directly pushing apps to users, or allowing users to install apps if they want. Which is appropriate will depend on the enterprise's policies and the purpose of the apps concerned.
+ "kind": "androidenterprise#collection", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#collection".
+ "productId": [ # The IDs of the products in the collection, in the order in which they should be displayed.
+ "A String",
+ ],
+ "name": "A String", # A user-friendly name for the collection (should be unique), e.g. "Accounting apps".
+ "visibility": "A String", # Whether this collection is visible to all users, or only to the users that have been granted access through the collection_viewers api. Even if a collection is visible to allUsers, it is possible to add and remove viewers, but this will have no effect until the collection's visibility changes to viewersOnly.
+ "collectionId": "A String", # Arbitrary unique ID, allocated by the API on creation.
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="patch">patch(enterpriseId, collectionId, body)</code>
+ <pre>Updates a collection. This method supports patch semantics.
+
+Args:
+ enterpriseId: string, The ID of the enterprise. (required)
+ collectionId: string, The ID of the collection. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A collection resource defines a named set of apps that is visible to a set of users in the Google Play Store app running on those users' managed devices. Those users can then install any of those apps if they wish (which will trigger creation of install and entitlement resources). A user cannot install an app on a managed device unless the app is listed in at least one collection that is visible to that user.
+ #
+ # Note that the API can be used to directly install an app regardless of whether it is in any collection - so an enterprise has a choice of either directly pushing apps to users, or allowing users to install apps if they want. Which is appropriate will depend on the enterprise's policies and the purpose of the apps concerned.
+ "kind": "androidenterprise#collection", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#collection".
+ "productId": [ # The IDs of the products in the collection, in the order in which they should be displayed.
+ "A String",
+ ],
+ "name": "A String", # A user-friendly name for the collection (should be unique), e.g. "Accounting apps".
+ "visibility": "A String", # Whether this collection is visible to all users, or only to the users that have been granted access through the collection_viewers api. Even if a collection is visible to allUsers, it is possible to add and remove viewers, but this will have no effect until the collection's visibility changes to viewersOnly.
+ "collectionId": "A String", # Arbitrary unique ID, allocated by the API on creation.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # A collection resource defines a named set of apps that is visible to a set of users in the Google Play Store app running on those users' managed devices. Those users can then install any of those apps if they wish (which will trigger creation of install and entitlement resources). A user cannot install an app on a managed device unless the app is listed in at least one collection that is visible to that user.
+ #
+ # Note that the API can be used to directly install an app regardless of whether it is in any collection - so an enterprise has a choice of either directly pushing apps to users, or allowing users to install apps if they want. Which is appropriate will depend on the enterprise's policies and the purpose of the apps concerned.
+ "kind": "androidenterprise#collection", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#collection".
+ "productId": [ # The IDs of the products in the collection, in the order in which they should be displayed.
+ "A String",
+ ],
+ "name": "A String", # A user-friendly name for the collection (should be unique), e.g. "Accounting apps".
+ "visibility": "A String", # Whether this collection is visible to all users, or only to the users that have been granted access through the collection_viewers api. Even if a collection is visible to allUsers, it is possible to add and remove viewers, but this will have no effect until the collection's visibility changes to viewersOnly.
+ "collectionId": "A String", # Arbitrary unique ID, allocated by the API on creation.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(enterpriseId, collectionId, body)</code>
+ <pre>Updates a collection.
+
+Args:
+ enterpriseId: string, The ID of the enterprise. (required)
+ collectionId: string, The ID of the collection. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A collection resource defines a named set of apps that is visible to a set of users in the Google Play Store app running on those users' managed devices. Those users can then install any of those apps if they wish (which will trigger creation of install and entitlement resources). A user cannot install an app on a managed device unless the app is listed in at least one collection that is visible to that user.
+ #
+ # Note that the API can be used to directly install an app regardless of whether it is in any collection - so an enterprise has a choice of either directly pushing apps to users, or allowing users to install apps if they want. Which is appropriate will depend on the enterprise's policies and the purpose of the apps concerned.
+ "kind": "androidenterprise#collection", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#collection".
+ "productId": [ # The IDs of the products in the collection, in the order in which they should be displayed.
+ "A String",
+ ],
+ "name": "A String", # A user-friendly name for the collection (should be unique), e.g. "Accounting apps".
+ "visibility": "A String", # Whether this collection is visible to all users, or only to the users that have been granted access through the collection_viewers api. Even if a collection is visible to allUsers, it is possible to add and remove viewers, but this will have no effect until the collection's visibility changes to viewersOnly.
+ "collectionId": "A String", # Arbitrary unique ID, allocated by the API on creation.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # A collection resource defines a named set of apps that is visible to a set of users in the Google Play Store app running on those users' managed devices. Those users can then install any of those apps if they wish (which will trigger creation of install and entitlement resources). A user cannot install an app on a managed device unless the app is listed in at least one collection that is visible to that user.
+ #
+ # Note that the API can be used to directly install an app regardless of whether it is in any collection - so an enterprise has a choice of either directly pushing apps to users, or allowing users to install apps if they want. Which is appropriate will depend on the enterprise's policies and the purpose of the apps concerned.
+ "kind": "androidenterprise#collection", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#collection".
+ "productId": [ # The IDs of the products in the collection, in the order in which they should be displayed.
+ "A String",
+ ],
+ "name": "A String", # A user-friendly name for the collection (should be unique), e.g. "Accounting apps".
+ "visibility": "A String", # Whether this collection is visible to all users, or only to the users that have been granted access through the collection_viewers api. Even if a collection is visible to allUsers, it is possible to add and remove viewers, but this will have no effect until the collection's visibility changes to viewersOnly.
+ "collectionId": "A String", # Arbitrary unique ID, allocated by the API on creation.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/androidenterprise_v1.collectionviewers.html b/docs/dyn/androidenterprise_v1.collectionviewers.html
new file mode 100644
index 0000000..a41ecfe
--- /dev/null
+++ b/docs/dyn/androidenterprise_v1.collectionviewers.html
@@ -0,0 +1,226 @@
+<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="androidenterprise_v1.html">Google Play MDM API</a> . <a href="androidenterprise_v1.collectionviewers.html">collectionviewers</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(enterpriseId, collectionId, userId)</a></code></p>
+<p class="firstline">Removes the user from the list of those specifically allowed to see the collection. If the collection's visibility is set to viewersOnly then only such users will see the collection.</p>
+<p class="toc_element">
+ <code><a href="#get">get(enterpriseId, collectionId, userId)</a></code></p>
+<p class="firstline">Retrieves the ID of the user if they have been specifically allowed to see the collection. If the collection's visibility is set to viewersOnly then only these users will see the collection.</p>
+<p class="toc_element">
+ <code><a href="#list">list(enterpriseId, collectionId)</a></code></p>
+<p class="firstline">Retrieves the IDs of the users who have been specifically allowed to see the collection. If the collection's visibility is set to viewersOnly then only these users will see the collection.</p>
+<p class="toc_element">
+ <code><a href="#patch">patch(enterpriseId, collectionId, userId, body)</a></code></p>
+<p class="firstline">Adds the user to the list of those specifically allowed to see the collection. If the collection's visibility is set to viewersOnly then only such users will see the collection. This method supports patch semantics.</p>
+<p class="toc_element">
+ <code><a href="#update">update(enterpriseId, collectionId, userId, body)</a></code></p>
+<p class="firstline">Adds the user to the list of those specifically allowed to see the collection. If the collection's visibility is set to viewersOnly then only such users will see the collection.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(enterpriseId, collectionId, userId)</code>
+ <pre>Removes the user from the list of those specifically allowed to see the collection. If the collection's visibility is set to viewersOnly then only such users will see the collection.
+
+Args:
+ enterpriseId: string, The ID of the enterprise. (required)
+ collectionId: string, The ID of the collection. (required)
+ userId: string, The ID of the user. (required)
+</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(enterpriseId, collectionId, userId)</code>
+ <pre>Retrieves the ID of the user if they have been specifically allowed to see the collection. If the collection's visibility is set to viewersOnly then only these users will see the collection.
+
+Args:
+ enterpriseId: string, The ID of the enterprise. (required)
+ collectionId: string, The ID of the collection. (required)
+ userId: string, The ID of the user. (required)
+
+Returns:
+ An object of the form:
+
+ { # A user resource represents an individual user within the enterprise's domain.
+ #
+ # Note that each user is associated with a Google account based on the user's corporate email address (which must be in one of the enterprise's domains). As part of installing an MDM app to manage a device the Google account must be provisioned to the device, and so the user resource must be created before that. This can be done using the Google Admin SDK Directory API.
+ #
+ # The ID for a user is an opaque string. It can be retrieved using the list method queried by the user's primary email address.
+ "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
+ "primaryEmail": "A String", # The user's primary email, e.g. "jsmith@example.com".
+ "id": "A String", # The unique ID for the user.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(enterpriseId, collectionId)</code>
+ <pre>Retrieves the IDs of the users who have been specifically allowed to see the collection. If the collection's visibility is set to viewersOnly then only these users will see the collection.
+
+Args:
+ enterpriseId: string, The ID of the enterprise. (required)
+ collectionId: string, The ID of the collection. (required)
+
+Returns:
+ An object of the form:
+
+ { # The user resources for the collection.
+ "kind": "androidenterprise#collectionViewersListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#collectionViewersListResponse".
+ "user": [ # A user of an enterprise.
+ { # A user resource represents an individual user within the enterprise's domain.
+ #
+ # Note that each user is associated with a Google account based on the user's corporate email address (which must be in one of the enterprise's domains). As part of installing an MDM app to manage a device the Google account must be provisioned to the device, and so the user resource must be created before that. This can be done using the Google Admin SDK Directory API.
+ #
+ # The ID for a user is an opaque string. It can be retrieved using the list method queried by the user's primary email address.
+ "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
+ "primaryEmail": "A String", # The user's primary email, e.g. "jsmith@example.com".
+ "id": "A String", # The unique ID for the user.
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="patch">patch(enterpriseId, collectionId, userId, body)</code>
+ <pre>Adds the user to the list of those specifically allowed to see the collection. If the collection's visibility is set to viewersOnly then only such users will see the collection. This method supports patch semantics.
+
+Args:
+ enterpriseId: string, The ID of the enterprise. (required)
+ collectionId: string, The ID of the collection. (required)
+ userId: string, The ID of the user. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A user resource represents an individual user within the enterprise's domain.
+ #
+ # Note that each user is associated with a Google account based on the user's corporate email address (which must be in one of the enterprise's domains). As part of installing an MDM app to manage a device the Google account must be provisioned to the device, and so the user resource must be created before that. This can be done using the Google Admin SDK Directory API.
+ #
+ # The ID for a user is an opaque string. It can be retrieved using the list method queried by the user's primary email address.
+ "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
+ "primaryEmail": "A String", # The user's primary email, e.g. "jsmith@example.com".
+ "id": "A String", # The unique ID for the user.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # A user resource represents an individual user within the enterprise's domain.
+ #
+ # Note that each user is associated with a Google account based on the user's corporate email address (which must be in one of the enterprise's domains). As part of installing an MDM app to manage a device the Google account must be provisioned to the device, and so the user resource must be created before that. This can be done using the Google Admin SDK Directory API.
+ #
+ # The ID for a user is an opaque string. It can be retrieved using the list method queried by the user's primary email address.
+ "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
+ "primaryEmail": "A String", # The user's primary email, e.g. "jsmith@example.com".
+ "id": "A String", # The unique ID for the user.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(enterpriseId, collectionId, userId, body)</code>
+ <pre>Adds the user to the list of those specifically allowed to see the collection. If the collection's visibility is set to viewersOnly then only such users will see the collection.
+
+Args:
+ enterpriseId: string, The ID of the enterprise. (required)
+ collectionId: string, The ID of the collection. (required)
+ userId: string, The ID of the user. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A user resource represents an individual user within the enterprise's domain.
+ #
+ # Note that each user is associated with a Google account based on the user's corporate email address (which must be in one of the enterprise's domains). As part of installing an MDM app to manage a device the Google account must be provisioned to the device, and so the user resource must be created before that. This can be done using the Google Admin SDK Directory API.
+ #
+ # The ID for a user is an opaque string. It can be retrieved using the list method queried by the user's primary email address.
+ "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
+ "primaryEmail": "A String", # The user's primary email, e.g. "jsmith@example.com".
+ "id": "A String", # The unique ID for the user.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # A user resource represents an individual user within the enterprise's domain.
+ #
+ # Note that each user is associated with a Google account based on the user's corporate email address (which must be in one of the enterprise's domains). As part of installing an MDM app to manage a device the Google account must be provisioned to the device, and so the user resource must be created before that. This can be done using the Google Admin SDK Directory API.
+ #
+ # The ID for a user is an opaque string. It can be retrieved using the list method queried by the user's primary email address.
+ "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
+ "primaryEmail": "A String", # The user's primary email, e.g. "jsmith@example.com".
+ "id": "A String", # The unique ID for the user.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/androidenterprise_v1.devices.html b/docs/dyn/androidenterprise_v1.devices.html
new file mode 100644
index 0000000..8347a45
--- /dev/null
+++ b/docs/dyn/androidenterprise_v1.devices.html
@@ -0,0 +1,178 @@
+<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="androidenterprise_v1.html">Google Play MDM API</a> . <a href="androidenterprise_v1.devices.html">devices</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#get">get(enterpriseId, userId, deviceId)</a></code></p>
+<p class="firstline">Retrieves the details of a device.</p>
+<p class="toc_element">
+ <code><a href="#getState">getState(enterpriseId, userId, deviceId)</a></code></p>
+<p class="firstline">Retrieves whether a device is enabled or disabled for access by the user to Google services. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services.</p>
+<p class="toc_element">
+ <code><a href="#list">list(enterpriseId, userId)</a></code></p>
+<p class="firstline">Retrieves the IDs of all of a user's devices.</p>
+<p class="toc_element">
+ <code><a href="#setState">setState(enterpriseId, userId, deviceId, body)</a></code></p>
+<p class="firstline">Sets whether a device is enabled or disabled for access by the user to Google services. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="get">get(enterpriseId, userId, deviceId)</code>
+ <pre>Retrieves the details of a device.
+
+Args:
+ enterpriseId: string, The ID of the enterprise. (required)
+ userId: string, The ID of the user. (required)
+ deviceId: string, The ID of the device. (required)
+
+Returns:
+ An object of the form:
+
+ { # A device resource represents a mobile device managed by the MDM and belonging to a specific enterprise user.
+ #
+ # This collection cannot be modified via the API; it is automatically populated as devices are set up to be managed.
+ "kind": "androidenterprise#device", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#device".
+ "androidId": "A String", # The Google Play Services Android ID for the device encoded as a lowercase hex string, e.g. "123456789abcdef0".
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="getState">getState(enterpriseId, userId, deviceId)</code>
+ <pre>Retrieves whether a device is enabled or disabled for access by the user to Google services. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services.
+
+Args:
+ enterpriseId: string, The ID of the enterprise. (required)
+ userId: string, The ID of the user. (required)
+ deviceId: string, The ID of the device. (required)
+
+Returns:
+ An object of the form:
+
+ { # The state of a user's device, as accessed by the getState and setState methods on device resources.
+ "kind": "androidenterprise#deviceState", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#deviceState".
+ "accountState": "A String", # The state of the Google account on the device. "enabled" indicates that the Google account on the device can be used to access Google services (including Google Play), while "disabled" means that it cannot. A new device is initially in the "disabled" state.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(enterpriseId, userId)</code>
+ <pre>Retrieves the IDs of all of a user's devices.
+
+Args:
+ enterpriseId: string, The ID of the enterprise. (required)
+ userId: string, The ID of the user. (required)
+
+Returns:
+ An object of the form:
+
+ { # The device resources for the user.
+ "device": [ # A managed device.
+ { # A device resource represents a mobile device managed by the MDM and belonging to a specific enterprise user.
+ #
+ # This collection cannot be modified via the API; it is automatically populated as devices are set up to be managed.
+ "kind": "androidenterprise#device", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#device".
+ "androidId": "A String", # The Google Play Services Android ID for the device encoded as a lowercase hex string, e.g. "123456789abcdef0".
+ },
+ ],
+ "kind": "androidenterprise#devicesListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#devicesListResponse".
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setState">setState(enterpriseId, userId, deviceId, body)</code>
+ <pre>Sets whether a device is enabled or disabled for access by the user to Google services. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services.
+
+Args:
+ enterpriseId: string, The ID of the enterprise. (required)
+ userId: string, The ID of the user. (required)
+ deviceId: string, The ID of the device. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The state of a user's device, as accessed by the getState and setState methods on device resources.
+ "kind": "androidenterprise#deviceState", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#deviceState".
+ "accountState": "A String", # The state of the Google account on the device. "enabled" indicates that the Google account on the device can be used to access Google services (including Google Play), while "disabled" means that it cannot. A new device is initially in the "disabled" state.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # The state of a user's device, as accessed by the getState and setState methods on device resources.
+ "kind": "androidenterprise#deviceState", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#deviceState".
+ "accountState": "A String", # The state of the Google account on the device. "enabled" indicates that the Google account on the device can be used to access Google services (including Google Play), while "disabled" means that it cannot. A new device is initially in the "disabled" state.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/androidenterprise_v1.enterprises.html b/docs/dyn/androidenterprise_v1.enterprises.html
new file mode 100644
index 0000000..d8a1800
--- /dev/null
+++ b/docs/dyn/androidenterprise_v1.enterprises.html
@@ -0,0 +1,286 @@
+<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="androidenterprise_v1.html">Google Play MDM API</a> . <a href="androidenterprise_v1.enterprises.html">enterprises</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(enterpriseId)</a></code></p>
+<p class="firstline">Deletes the binding between the MDM and enterprise. This is now deprecated; use this to unenroll customers that were previously enrolled with the 'insert' call, then enroll them again with the 'enroll' call.</p>
+<p class="toc_element">
+ <code><a href="#enroll">enroll(token, body)</a></code></p>
+<p class="firstline">Enrolls an enterprise with the calling MDM.</p>
+<p class="toc_element">
+ <code><a href="#get">get(enterpriseId)</a></code></p>
+<p class="firstline">Retrieves the name and domain of an enterprise.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(token, body)</a></code></p>
+<p class="firstline">Establishes the binding between the MDM and an enterprise. This is now deprecated; use enroll instead.</p>
+<p class="toc_element">
+ <code><a href="#list">list(domain)</a></code></p>
+<p class="firstline">Looks up an enterprise by domain name.</p>
+<p class="toc_element">
+ <code><a href="#setAccount">setAccount(enterpriseId, body)</a></code></p>
+<p class="firstline">Set the account that will be used to authenticate to the API as the enterprise.</p>
+<p class="toc_element">
+ <code><a href="#unenroll">unenroll(enterpriseId)</a></code></p>
+<p class="firstline">Unenrolls an enterprise from the calling MDM.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(enterpriseId)</code>
+ <pre>Deletes the binding between the MDM and enterprise. This is now deprecated; use this to unenroll customers that were previously enrolled with the 'insert' call, then enroll them again with the 'enroll' call.
+
+Args:
+ enterpriseId: string, The ID of the enterprise. (required)
+</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="enroll">enroll(token, body)</code>
+ <pre>Enrolls an enterprise with the calling MDM.
+
+Args:
+ token: string, The token provided by the enterprise to register the MDM. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An enterprise resource represents a binding between an organisation and their MDM.
+ #
+ # To create an enterprise, an admin of the enterprise must first go through a Play for Work sign-up flow. At the end of this the admin will be presented with a token (a short opaque alphanumeric string). They must then present this to the MDM, who then supplies it to the enroll method. Until this is done the MDM will not have any access to the enterprise.
+ #
+ # After calling enroll the MDM should call setAccount to specify the service account that will be allowed to act on behalf of the enterprise, which will be required for access to the enterprise's data through this API. Only one call of setAccount is allowed for a given enterprise; the only way to change the account later is to unenroll the enterprise and enroll it again (obtaining a new token).
+ #
+ # The MDM can unenroll an enterprise in order to sever the binding between them. Re-enrolling an enterprise is possible, but requires a new token to be retrieved. Enterprises.unenroll requires the MDM's credentials (as enroll does), not the enterprise's. Enterprises.unenroll can only be used for enterprises that were previously enrolled with the enroll call. Any enterprises that were enrolled using the (deprecated) Enterprises.insert call must be unenrolled with Enterprises.delete and can then be re-enrolled using the Enterprises.enroll call.
+ #
+ # The ID for an enterprise is an opaque string. It is returned by insert and enroll and can also be retrieved if the enterprise's primary domain is known using the list method.
+ "kind": "androidenterprise#enterprise", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprise".
+ "primaryDomain": "A String", # The enterprise's primary domain, e.g. "example.com".
+ "id": "A String", # The unique ID for the enterprise.
+ "name": "A String", # The name of the enterprise, e.g. "Example Inc".
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An enterprise resource represents a binding between an organisation and their MDM.
+ #
+ # To create an enterprise, an admin of the enterprise must first go through a Play for Work sign-up flow. At the end of this the admin will be presented with a token (a short opaque alphanumeric string). They must then present this to the MDM, who then supplies it to the enroll method. Until this is done the MDM will not have any access to the enterprise.
+ #
+ # After calling enroll the MDM should call setAccount to specify the service account that will be allowed to act on behalf of the enterprise, which will be required for access to the enterprise's data through this API. Only one call of setAccount is allowed for a given enterprise; the only way to change the account later is to unenroll the enterprise and enroll it again (obtaining a new token).
+ #
+ # The MDM can unenroll an enterprise in order to sever the binding between them. Re-enrolling an enterprise is possible, but requires a new token to be retrieved. Enterprises.unenroll requires the MDM's credentials (as enroll does), not the enterprise's. Enterprises.unenroll can only be used for enterprises that were previously enrolled with the enroll call. Any enterprises that were enrolled using the (deprecated) Enterprises.insert call must be unenrolled with Enterprises.delete and can then be re-enrolled using the Enterprises.enroll call.
+ #
+ # The ID for an enterprise is an opaque string. It is returned by insert and enroll and can also be retrieved if the enterprise's primary domain is known using the list method.
+ "kind": "androidenterprise#enterprise", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprise".
+ "primaryDomain": "A String", # The enterprise's primary domain, e.g. "example.com".
+ "id": "A String", # The unique ID for the enterprise.
+ "name": "A String", # The name of the enterprise, e.g. "Example Inc".
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(enterpriseId)</code>
+ <pre>Retrieves the name and domain of an enterprise.
+
+Args:
+ enterpriseId: string, The ID of the enterprise. (required)
+
+Returns:
+ An object of the form:
+
+ { # An enterprise resource represents a binding between an organisation and their MDM.
+ #
+ # To create an enterprise, an admin of the enterprise must first go through a Play for Work sign-up flow. At the end of this the admin will be presented with a token (a short opaque alphanumeric string). They must then present this to the MDM, who then supplies it to the enroll method. Until this is done the MDM will not have any access to the enterprise.
+ #
+ # After calling enroll the MDM should call setAccount to specify the service account that will be allowed to act on behalf of the enterprise, which will be required for access to the enterprise's data through this API. Only one call of setAccount is allowed for a given enterprise; the only way to change the account later is to unenroll the enterprise and enroll it again (obtaining a new token).
+ #
+ # The MDM can unenroll an enterprise in order to sever the binding between them. Re-enrolling an enterprise is possible, but requires a new token to be retrieved. Enterprises.unenroll requires the MDM's credentials (as enroll does), not the enterprise's. Enterprises.unenroll can only be used for enterprises that were previously enrolled with the enroll call. Any enterprises that were enrolled using the (deprecated) Enterprises.insert call must be unenrolled with Enterprises.delete and can then be re-enrolled using the Enterprises.enroll call.
+ #
+ # The ID for an enterprise is an opaque string. It is returned by insert and enroll and can also be retrieved if the enterprise's primary domain is known using the list method.
+ "kind": "androidenterprise#enterprise", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprise".
+ "primaryDomain": "A String", # The enterprise's primary domain, e.g. "example.com".
+ "id": "A String", # The unique ID for the enterprise.
+ "name": "A String", # The name of the enterprise, e.g. "Example Inc".
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(token, body)</code>
+ <pre>Establishes the binding between the MDM and an enterprise. This is now deprecated; use enroll instead.
+
+Args:
+ token: string, The token provided by the enterprise to register the MDM. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An enterprise resource represents a binding between an organisation and their MDM.
+ #
+ # To create an enterprise, an admin of the enterprise must first go through a Play for Work sign-up flow. At the end of this the admin will be presented with a token (a short opaque alphanumeric string). They must then present this to the MDM, who then supplies it to the enroll method. Until this is done the MDM will not have any access to the enterprise.
+ #
+ # After calling enroll the MDM should call setAccount to specify the service account that will be allowed to act on behalf of the enterprise, which will be required for access to the enterprise's data through this API. Only one call of setAccount is allowed for a given enterprise; the only way to change the account later is to unenroll the enterprise and enroll it again (obtaining a new token).
+ #
+ # The MDM can unenroll an enterprise in order to sever the binding between them. Re-enrolling an enterprise is possible, but requires a new token to be retrieved. Enterprises.unenroll requires the MDM's credentials (as enroll does), not the enterprise's. Enterprises.unenroll can only be used for enterprises that were previously enrolled with the enroll call. Any enterprises that were enrolled using the (deprecated) Enterprises.insert call must be unenrolled with Enterprises.delete and can then be re-enrolled using the Enterprises.enroll call.
+ #
+ # The ID for an enterprise is an opaque string. It is returned by insert and enroll and can also be retrieved if the enterprise's primary domain is known using the list method.
+ "kind": "androidenterprise#enterprise", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprise".
+ "primaryDomain": "A String", # The enterprise's primary domain, e.g. "example.com".
+ "id": "A String", # The unique ID for the enterprise.
+ "name": "A String", # The name of the enterprise, e.g. "Example Inc".
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An enterprise resource represents a binding between an organisation and their MDM.
+ #
+ # To create an enterprise, an admin of the enterprise must first go through a Play for Work sign-up flow. At the end of this the admin will be presented with a token (a short opaque alphanumeric string). They must then present this to the MDM, who then supplies it to the enroll method. Until this is done the MDM will not have any access to the enterprise.
+ #
+ # After calling enroll the MDM should call setAccount to specify the service account that will be allowed to act on behalf of the enterprise, which will be required for access to the enterprise's data through this API. Only one call of setAccount is allowed for a given enterprise; the only way to change the account later is to unenroll the enterprise and enroll it again (obtaining a new token).
+ #
+ # The MDM can unenroll an enterprise in order to sever the binding between them. Re-enrolling an enterprise is possible, but requires a new token to be retrieved. Enterprises.unenroll requires the MDM's credentials (as enroll does), not the enterprise's. Enterprises.unenroll can only be used for enterprises that were previously enrolled with the enroll call. Any enterprises that were enrolled using the (deprecated) Enterprises.insert call must be unenrolled with Enterprises.delete and can then be re-enrolled using the Enterprises.enroll call.
+ #
+ # The ID for an enterprise is an opaque string. It is returned by insert and enroll and can also be retrieved if the enterprise's primary domain is known using the list method.
+ "kind": "androidenterprise#enterprise", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprise".
+ "primaryDomain": "A String", # The enterprise's primary domain, e.g. "example.com".
+ "id": "A String", # The unique ID for the enterprise.
+ "name": "A String", # The name of the enterprise, e.g. "Example Inc".
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(domain)</code>
+ <pre>Looks up an enterprise by domain name.
+
+Args:
+ domain: string, The exact primary domain name of the enterprise to look up. (required)
+
+Returns:
+ An object of the form:
+
+ { # The matching enterprise resources.
+ "kind": "androidenterprise#enterprisesListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprisesListResponse".
+ "enterprise": [ # An enterprise.
+ { # An enterprise resource represents a binding between an organisation and their MDM.
+ #
+ # To create an enterprise, an admin of the enterprise must first go through a Play for Work sign-up flow. At the end of this the admin will be presented with a token (a short opaque alphanumeric string). They must then present this to the MDM, who then supplies it to the enroll method. Until this is done the MDM will not have any access to the enterprise.
+ #
+ # After calling enroll the MDM should call setAccount to specify the service account that will be allowed to act on behalf of the enterprise, which will be required for access to the enterprise's data through this API. Only one call of setAccount is allowed for a given enterprise; the only way to change the account later is to unenroll the enterprise and enroll it again (obtaining a new token).
+ #
+ # The MDM can unenroll an enterprise in order to sever the binding between them. Re-enrolling an enterprise is possible, but requires a new token to be retrieved. Enterprises.unenroll requires the MDM's credentials (as enroll does), not the enterprise's. Enterprises.unenroll can only be used for enterprises that were previously enrolled with the enroll call. Any enterprises that were enrolled using the (deprecated) Enterprises.insert call must be unenrolled with Enterprises.delete and can then be re-enrolled using the Enterprises.enroll call.
+ #
+ # The ID for an enterprise is an opaque string. It is returned by insert and enroll and can also be retrieved if the enterprise's primary domain is known using the list method.
+ "kind": "androidenterprise#enterprise", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprise".
+ "primaryDomain": "A String", # The enterprise's primary domain, e.g. "example.com".
+ "id": "A String", # The unique ID for the enterprise.
+ "name": "A String", # The name of the enterprise, e.g. "Example Inc".
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setAccount">setAccount(enterpriseId, body)</code>
+ <pre>Set the account that will be used to authenticate to the API as the enterprise.
+
+Args:
+ enterpriseId: string, The ID of the enterprise. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A service account that can be used to authenticate as the enterprise to API calls that require such authentication.
+ "kind": "androidenterprise#enterpriseAccount", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterpriseAccount".
+ "accountEmail": "A String", # The email address of the service account.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # A service account that can be used to authenticate as the enterprise to API calls that require such authentication.
+ "kind": "androidenterprise#enterpriseAccount", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterpriseAccount".
+ "accountEmail": "A String", # The email address of the service account.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="unenroll">unenroll(enterpriseId)</code>
+ <pre>Unenrolls an enterprise from the calling MDM.
+
+Args:
+ enterpriseId: string, The ID of the enterprise. (required)
+</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/androidenterprise_v1.entitlements.html b/docs/dyn/androidenterprise_v1.entitlements.html
new file mode 100644
index 0000000..645bf3c
--- /dev/null
+++ b/docs/dyn/androidenterprise_v1.entitlements.html
@@ -0,0 +1,252 @@
+<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="androidenterprise_v1.html">Google Play MDM API</a> . <a href="androidenterprise_v1.entitlements.html">entitlements</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(enterpriseId, userId, entitlementId)</a></code></p>
+<p class="firstline">Removes an entitlement to an app for a user and uninstalls it.</p>
+<p class="toc_element">
+ <code><a href="#get">get(enterpriseId, userId, entitlementId)</a></code></p>
+<p class="firstline">Retrieves details of an entitlement.</p>
+<p class="toc_element">
+ <code><a href="#list">list(enterpriseId, userId)</a></code></p>
+<p class="firstline">List of all entitlements for the specified user. Only the ID is set.</p>
+<p class="toc_element">
+ <code><a href="#patch">patch(enterpriseId, userId, entitlementId, body, install=None)</a></code></p>
+<p class="firstline">Adds or updates an entitlement to an app for a user. This method supports patch semantics.</p>
+<p class="toc_element">
+ <code><a href="#update">update(enterpriseId, userId, entitlementId, body, install=None)</a></code></p>
+<p class="firstline">Adds or updates an entitlement to an app for a user.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(enterpriseId, userId, entitlementId)</code>
+ <pre>Removes an entitlement to an app for a user and uninstalls it.
+
+Args:
+ enterpriseId: string, The ID of the enterprise. (required)
+ userId: string, The ID of the user. (required)
+ entitlementId: string, The ID of the entitlement, e.g. "app:com.google.android.gm". (required)
+</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(enterpriseId, userId, entitlementId)</code>
+ <pre>Retrieves details of an entitlement.
+
+Args:
+ enterpriseId: string, The ID of the enterprise. (required)
+ userId: string, The ID of the user. (required)
+ entitlementId: string, The ID of the entitlement, e.g. "app:com.google.android.gm". (required)
+
+Returns:
+ An object of the form:
+
+ { # The existence of an entitlement resource means that a user has the right to use a particular app on any of their devices. This might be because the app is free or because they have been allocated a license to the app from a group license purchased by the enterprise.
+ #
+ # It should always be true that a user has an app installed on one of their devices only if they have an entitlement to it. So if an entitlement is deleted, the app will be uninstalled from all devices. Similarly if the user installs an app (and is permitted to do so), or the MDM triggers an install of the app, an entitlement to that app is automatically created. If this is impossible - e.g. the enterprise has not purchased sufficient licenses - then installation fails.
+ #
+ # Note that entitlements are always user specific, not device specific; a user may have an entitlement even though they have not installed the app anywhere. Once they have an entitlement they can install the app on multiple devices.
+ #
+ # The API can be used to create an entitlement. If the app is a free app, a group license for that app is created. If it's a paid app, creating the entitlement consumes one license; it remains consumed until the entitlement is removed. Optionally an installation of the app on all the user's managed devices can be triggered at the time the entitlement is created. An entitlement cannot be created for an app if the app requires permissions that the enterprise has not yet accepted.
+ #
+ # Entitlements for paid apps that are due to purchases by the user on a non-managed profile will have "userPurchase" as entitlement reason; those entitlements cannot be removed via the API.
+ "kind": "androidenterprise#entitlement", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#entitlement".
+ "reason": "A String", # The reason for the entitlement, e.g. "free" for free apps. This is temporary, it will be replaced by the acquisition kind field of group licenses.
+ "productId": "A String", # The ID of the product that the entitlement is for, e.g. "app:com.google.android.gm".
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(enterpriseId, userId)</code>
+ <pre>List of all entitlements for the specified user. Only the ID is set.
+
+Args:
+ enterpriseId: string, The ID of the enterprise. (required)
+ userId: string, The ID of the user. (required)
+
+Returns:
+ An object of the form:
+
+ { # The entitlement resources for the user.
+ "kind": "androidenterprise#entitlementsListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#entitlementsListResponse".
+ "entitlement": [ # An entitlement of a user to a product (e.g. an app). For example, a free app that they have installed, or a paid app that they have been allocated a license to.
+ { # The existence of an entitlement resource means that a user has the right to use a particular app on any of their devices. This might be because the app is free or because they have been allocated a license to the app from a group license purchased by the enterprise.
+ #
+ # It should always be true that a user has an app installed on one of their devices only if they have an entitlement to it. So if an entitlement is deleted, the app will be uninstalled from all devices. Similarly if the user installs an app (and is permitted to do so), or the MDM triggers an install of the app, an entitlement to that app is automatically created. If this is impossible - e.g. the enterprise has not purchased sufficient licenses - then installation fails.
+ #
+ # Note that entitlements are always user specific, not device specific; a user may have an entitlement even though they have not installed the app anywhere. Once they have an entitlement they can install the app on multiple devices.
+ #
+ # The API can be used to create an entitlement. If the app is a free app, a group license for that app is created. If it's a paid app, creating the entitlement consumes one license; it remains consumed until the entitlement is removed. Optionally an installation of the app on all the user's managed devices can be triggered at the time the entitlement is created. An entitlement cannot be created for an app if the app requires permissions that the enterprise has not yet accepted.
+ #
+ # Entitlements for paid apps that are due to purchases by the user on a non-managed profile will have "userPurchase" as entitlement reason; those entitlements cannot be removed via the API.
+ "kind": "androidenterprise#entitlement", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#entitlement".
+ "reason": "A String", # The reason for the entitlement, e.g. "free" for free apps. This is temporary, it will be replaced by the acquisition kind field of group licenses.
+ "productId": "A String", # The ID of the product that the entitlement is for, e.g. "app:com.google.android.gm".
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="patch">patch(enterpriseId, userId, entitlementId, body, install=None)</code>
+ <pre>Adds or updates an entitlement to an app for a user. This method supports patch semantics.
+
+Args:
+ enterpriseId: string, The ID of the enterprise. (required)
+ userId: string, The ID of the user. (required)
+ entitlementId: string, The ID of the entitlement, e.g. "app:com.google.android.gm". (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The existence of an entitlement resource means that a user has the right to use a particular app on any of their devices. This might be because the app is free or because they have been allocated a license to the app from a group license purchased by the enterprise.
+ #
+ # It should always be true that a user has an app installed on one of their devices only if they have an entitlement to it. So if an entitlement is deleted, the app will be uninstalled from all devices. Similarly if the user installs an app (and is permitted to do so), or the MDM triggers an install of the app, an entitlement to that app is automatically created. If this is impossible - e.g. the enterprise has not purchased sufficient licenses - then installation fails.
+ #
+ # Note that entitlements are always user specific, not device specific; a user may have an entitlement even though they have not installed the app anywhere. Once they have an entitlement they can install the app on multiple devices.
+ #
+ # The API can be used to create an entitlement. If the app is a free app, a group license for that app is created. If it's a paid app, creating the entitlement consumes one license; it remains consumed until the entitlement is removed. Optionally an installation of the app on all the user's managed devices can be triggered at the time the entitlement is created. An entitlement cannot be created for an app if the app requires permissions that the enterprise has not yet accepted.
+ #
+ # Entitlements for paid apps that are due to purchases by the user on a non-managed profile will have "userPurchase" as entitlement reason; those entitlements cannot be removed via the API.
+ "kind": "androidenterprise#entitlement", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#entitlement".
+ "reason": "A String", # The reason for the entitlement, e.g. "free" for free apps. This is temporary, it will be replaced by the acquisition kind field of group licenses.
+ "productId": "A String", # The ID of the product that the entitlement is for, e.g. "app:com.google.android.gm".
+ }
+
+ install: boolean, Set to true to also install the product on all the user's devices where possible. Failure to install on one or more devices will not prevent this operation from returning successfully, as long as the entitlement was successfully assigned to the user.
+
+Returns:
+ An object of the form:
+
+ { # The existence of an entitlement resource means that a user has the right to use a particular app on any of their devices. This might be because the app is free or because they have been allocated a license to the app from a group license purchased by the enterprise.
+ #
+ # It should always be true that a user has an app installed on one of their devices only if they have an entitlement to it. So if an entitlement is deleted, the app will be uninstalled from all devices. Similarly if the user installs an app (and is permitted to do so), or the MDM triggers an install of the app, an entitlement to that app is automatically created. If this is impossible - e.g. the enterprise has not purchased sufficient licenses - then installation fails.
+ #
+ # Note that entitlements are always user specific, not device specific; a user may have an entitlement even though they have not installed the app anywhere. Once they have an entitlement they can install the app on multiple devices.
+ #
+ # The API can be used to create an entitlement. If the app is a free app, a group license for that app is created. If it's a paid app, creating the entitlement consumes one license; it remains consumed until the entitlement is removed. Optionally an installation of the app on all the user's managed devices can be triggered at the time the entitlement is created. An entitlement cannot be created for an app if the app requires permissions that the enterprise has not yet accepted.
+ #
+ # Entitlements for paid apps that are due to purchases by the user on a non-managed profile will have "userPurchase" as entitlement reason; those entitlements cannot be removed via the API.
+ "kind": "androidenterprise#entitlement", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#entitlement".
+ "reason": "A String", # The reason for the entitlement, e.g. "free" for free apps. This is temporary, it will be replaced by the acquisition kind field of group licenses.
+ "productId": "A String", # The ID of the product that the entitlement is for, e.g. "app:com.google.android.gm".
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(enterpriseId, userId, entitlementId, body, install=None)</code>
+ <pre>Adds or updates an entitlement to an app for a user.
+
+Args:
+ enterpriseId: string, The ID of the enterprise. (required)
+ userId: string, The ID of the user. (required)
+ entitlementId: string, The ID of the entitlement, e.g. "app:com.google.android.gm". (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The existence of an entitlement resource means that a user has the right to use a particular app on any of their devices. This might be because the app is free or because they have been allocated a license to the app from a group license purchased by the enterprise.
+ #
+ # It should always be true that a user has an app installed on one of their devices only if they have an entitlement to it. So if an entitlement is deleted, the app will be uninstalled from all devices. Similarly if the user installs an app (and is permitted to do so), or the MDM triggers an install of the app, an entitlement to that app is automatically created. If this is impossible - e.g. the enterprise has not purchased sufficient licenses - then installation fails.
+ #
+ # Note that entitlements are always user specific, not device specific; a user may have an entitlement even though they have not installed the app anywhere. Once they have an entitlement they can install the app on multiple devices.
+ #
+ # The API can be used to create an entitlement. If the app is a free app, a group license for that app is created. If it's a paid app, creating the entitlement consumes one license; it remains consumed until the entitlement is removed. Optionally an installation of the app on all the user's managed devices can be triggered at the time the entitlement is created. An entitlement cannot be created for an app if the app requires permissions that the enterprise has not yet accepted.
+ #
+ # Entitlements for paid apps that are due to purchases by the user on a non-managed profile will have "userPurchase" as entitlement reason; those entitlements cannot be removed via the API.
+ "kind": "androidenterprise#entitlement", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#entitlement".
+ "reason": "A String", # The reason for the entitlement, e.g. "free" for free apps. This is temporary, it will be replaced by the acquisition kind field of group licenses.
+ "productId": "A String", # The ID of the product that the entitlement is for, e.g. "app:com.google.android.gm".
+ }
+
+ install: boolean, Set to true to also install the product on all the user's devices where possible. Failure to install on one or more devices will not prevent this operation from returning successfully, as long as the entitlement was successfully assigned to the user.
+
+Returns:
+ An object of the form:
+
+ { # The existence of an entitlement resource means that a user has the right to use a particular app on any of their devices. This might be because the app is free or because they have been allocated a license to the app from a group license purchased by the enterprise.
+ #
+ # It should always be true that a user has an app installed on one of their devices only if they have an entitlement to it. So if an entitlement is deleted, the app will be uninstalled from all devices. Similarly if the user installs an app (and is permitted to do so), or the MDM triggers an install of the app, an entitlement to that app is automatically created. If this is impossible - e.g. the enterprise has not purchased sufficient licenses - then installation fails.
+ #
+ # Note that entitlements are always user specific, not device specific; a user may have an entitlement even though they have not installed the app anywhere. Once they have an entitlement they can install the app on multiple devices.
+ #
+ # The API can be used to create an entitlement. If the app is a free app, a group license for that app is created. If it's a paid app, creating the entitlement consumes one license; it remains consumed until the entitlement is removed. Optionally an installation of the app on all the user's managed devices can be triggered at the time the entitlement is created. An entitlement cannot be created for an app if the app requires permissions that the enterprise has not yet accepted.
+ #
+ # Entitlements for paid apps that are due to purchases by the user on a non-managed profile will have "userPurchase" as entitlement reason; those entitlements cannot be removed via the API.
+ "kind": "androidenterprise#entitlement", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#entitlement".
+ "reason": "A String", # The reason for the entitlement, e.g. "free" for free apps. This is temporary, it will be replaced by the acquisition kind field of group licenses.
+ "productId": "A String", # The ID of the product that the entitlement is for, e.g. "app:com.google.android.gm".
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/androidenterprise_v1.grouplicenses.html b/docs/dyn/androidenterprise_v1.grouplicenses.html
new file mode 100644
index 0000000..90e1069
--- /dev/null
+++ b/docs/dyn/androidenterprise_v1.grouplicenses.html
@@ -0,0 +1,138 @@
+<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="androidenterprise_v1.html">Google Play MDM API</a> . <a href="androidenterprise_v1.grouplicenses.html">grouplicenses</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#get">get(enterpriseId, groupLicenseId)</a></code></p>
+<p class="firstline">Retrieves details of an enterprise's group license for a product.</p>
+<p class="toc_element">
+ <code><a href="#list">list(enterpriseId)</a></code></p>
+<p class="firstline">Retrieves IDs of all products for which the enterprise has a group license.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="get">get(enterpriseId, groupLicenseId)</code>
+ <pre>Retrieves details of an enterprise's group license for a product.
+
+Args:
+ enterpriseId: string, The ID of the enterprise. (required)
+ groupLicenseId: string, The ID of the product the group license is for, e.g. "app:com.google.android.gm". (required)
+
+Returns:
+ An object of the form:
+
+ { # A group license object indicates a product that an enterprise admin has approved for use in the enterprise. The product may be free or paid. For free products, a group license object is created in these cases: if the enterprise admin approves a product in Google Play, if the product is added to a collection, or if an entitlement for the product is created for a user via the API. For paid products, a group license object is only created as part of the first bulk purchase of that product in Google Play done by the enterprise admin.
+ #
+ # The API can be used to query group licenses; the available information includes the total number of licenses purchased (for paid products) and the total number of licenses that have been provisioned, i.e. the total number of user entitlements in existence for the product.
+ #
+ # Group license objects are never deleted; if e.g. a free app is added to a collection and then removed, the group license will remain, allowing to keep track of any remaining entitlements. An enterprise admin may indicate they are no longer interested in the group license by marking it as unapproved in Google Play.
+ "kind": "androidenterprise#groupLicense", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#groupLicense".
+ "numPurchased": 42, # The number of purchased licenses (possibly in multiple purchases). If this field is omitted then there is no limit on the number of licenses that can be provisioned (e.g. if the acquisition kind is "free").
+ "numProvisioned": 42, # The total number of provisioned licenses for this product. Returned by read operations, but ignored in write operations.
+ "acquisitionKind": "A String", # How this group license was acquired. "bulkPurchase" means that this group license object was created because the enterprise purchased licenses for this product; this is "free" otherwise (for free products).
+ "approval": "A String", # Whether the product to which this group license relates is currently approved by the enterprise, as either "approved" or "unapproved". Products are approved when a group license is first created, but this approval may be revoked by an enterprise admin via Google Play. Unapproved products will not be visible to end users in collections and new entitlements to them should not normally be created.
+ "productId": "A String", # The ID of the product that the license is for, e.g. "app:com.google.android.gm".
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(enterpriseId)</code>
+ <pre>Retrieves IDs of all products for which the enterprise has a group license.
+
+Args:
+ enterpriseId: string, The ID of the enterprise. (required)
+
+Returns:
+ An object of the form:
+
+ { # The grouplicense resources for the enterprise.
+ "groupLicense": [ # A group license for a product approved for use in the enterprise.
+ { # A group license object indicates a product that an enterprise admin has approved for use in the enterprise. The product may be free or paid. For free products, a group license object is created in these cases: if the enterprise admin approves a product in Google Play, if the product is added to a collection, or if an entitlement for the product is created for a user via the API. For paid products, a group license object is only created as part of the first bulk purchase of that product in Google Play done by the enterprise admin.
+ #
+ # The API can be used to query group licenses; the available information includes the total number of licenses purchased (for paid products) and the total number of licenses that have been provisioned, i.e. the total number of user entitlements in existence for the product.
+ #
+ # Group license objects are never deleted; if e.g. a free app is added to a collection and then removed, the group license will remain, allowing to keep track of any remaining entitlements. An enterprise admin may indicate they are no longer interested in the group license by marking it as unapproved in Google Play.
+ "kind": "androidenterprise#groupLicense", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#groupLicense".
+ "numPurchased": 42, # The number of purchased licenses (possibly in multiple purchases). If this field is omitted then there is no limit on the number of licenses that can be provisioned (e.g. if the acquisition kind is "free").
+ "numProvisioned": 42, # The total number of provisioned licenses for this product. Returned by read operations, but ignored in write operations.
+ "acquisitionKind": "A String", # How this group license was acquired. "bulkPurchase" means that this group license object was created because the enterprise purchased licenses for this product; this is "free" otherwise (for free products).
+ "approval": "A String", # Whether the product to which this group license relates is currently approved by the enterprise, as either "approved" or "unapproved". Products are approved when a group license is first created, but this approval may be revoked by an enterprise admin via Google Play. Unapproved products will not be visible to end users in collections and new entitlements to them should not normally be created.
+ "productId": "A String", # The ID of the product that the license is for, e.g. "app:com.google.android.gm".
+ },
+ ],
+ "kind": "androidenterprise#groupLicensesListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#groupLicensesListResponse".
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/androidenterprise_v1.grouplicenseusers.html b/docs/dyn/androidenterprise_v1.grouplicenseusers.html
new file mode 100644
index 0000000..c798b07
--- /dev/null
+++ b/docs/dyn/androidenterprise_v1.grouplicenseusers.html
@@ -0,0 +1,108 @@
+<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="androidenterprise_v1.html">Google Play MDM API</a> . <a href="androidenterprise_v1.grouplicenseusers.html">grouplicenseusers</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#list">list(enterpriseId, groupLicenseId)</a></code></p>
+<p class="firstline">Retrieves the IDs of the users who have been granted entitlements under the license.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="list">list(enterpriseId, groupLicenseId)</code>
+ <pre>Retrieves the IDs of the users who have been granted entitlements under the license.
+
+Args:
+ enterpriseId: string, The ID of the enterprise. (required)
+ groupLicenseId: string, The ID of the product the group license is for, e.g. "app:com.google.android.gm". (required)
+
+Returns:
+ An object of the form:
+
+ { # The user resources for the group license.
+ "kind": "androidenterprise#groupLicenseUsersListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#groupLicenseUsersListResponse".
+ "user": [ # A user of an enterprise.
+ { # A user resource represents an individual user within the enterprise's domain.
+ #
+ # Note that each user is associated with a Google account based on the user's corporate email address (which must be in one of the enterprise's domains). As part of installing an MDM app to manage a device the Google account must be provisioned to the device, and so the user resource must be created before that. This can be done using the Google Admin SDK Directory API.
+ #
+ # The ID for a user is an opaque string. It can be retrieved using the list method queried by the user's primary email address.
+ "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
+ "primaryEmail": "A String", # The user's primary email, e.g. "jsmith@example.com".
+ "id": "A String", # The unique ID for the user.
+ },
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/androidenterprise_v1.html b/docs/dyn/androidenterprise_v1.html
new file mode 100644
index 0000000..c40010c
--- /dev/null
+++ b/docs/dyn/androidenterprise_v1.html
@@ -0,0 +1,132 @@
+<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="androidenterprise_v1.html">Google Play MDM API</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="androidenterprise_v1.collections.html">collections()</a></code>
+</p>
+<p class="firstline">Returns the collections Resource.</p>
+
+<p class="toc_element">
+ <code><a href="androidenterprise_v1.collectionviewers.html">collectionviewers()</a></code>
+</p>
+<p class="firstline">Returns the collectionviewers Resource.</p>
+
+<p class="toc_element">
+ <code><a href="androidenterprise_v1.devices.html">devices()</a></code>
+</p>
+<p class="firstline">Returns the devices Resource.</p>
+
+<p class="toc_element">
+ <code><a href="androidenterprise_v1.enterprises.html">enterprises()</a></code>
+</p>
+<p class="firstline">Returns the enterprises Resource.</p>
+
+<p class="toc_element">
+ <code><a href="androidenterprise_v1.entitlements.html">entitlements()</a></code>
+</p>
+<p class="firstline">Returns the entitlements Resource.</p>
+
+<p class="toc_element">
+ <code><a href="androidenterprise_v1.grouplicenses.html">grouplicenses()</a></code>
+</p>
+<p class="firstline">Returns the grouplicenses Resource.</p>
+
+<p class="toc_element">
+ <code><a href="androidenterprise_v1.grouplicenseusers.html">grouplicenseusers()</a></code>
+</p>
+<p class="firstline">Returns the grouplicenseusers Resource.</p>
+
+<p class="toc_element">
+ <code><a href="androidenterprise_v1.installs.html">installs()</a></code>
+</p>
+<p class="firstline">Returns the installs Resource.</p>
+
+<p class="toc_element">
+ <code><a href="androidenterprise_v1.permissions.html">permissions()</a></code>
+</p>
+<p class="firstline">Returns the permissions Resource.</p>
+
+<p class="toc_element">
+ <code><a href="androidenterprise_v1.products.html">products()</a></code>
+</p>
+<p class="firstline">Returns the products Resource.</p>
+
+<p class="toc_element">
+ <code><a href="androidenterprise_v1.users.html">users()</a></code>
+</p>
+<p class="firstline">Returns the users Resource.</p>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/androidenterprise_v1.installs.html b/docs/dyn/androidenterprise_v1.installs.html
new file mode 100644
index 0000000..de5f9d9
--- /dev/null
+++ b/docs/dyn/androidenterprise_v1.installs.html
@@ -0,0 +1,273 @@
+<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="androidenterprise_v1.html">Google Play MDM API</a> . <a href="androidenterprise_v1.installs.html">installs</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(enterpriseId, userId, deviceId, installId)</a></code></p>
+<p class="firstline">Requests to remove an app from a device. A call to get or list will still show the app as installed on the device until it is actually removed.</p>
+<p class="toc_element">
+ <code><a href="#get">get(enterpriseId, userId, deviceId, installId)</a></code></p>
+<p class="firstline">Retrieves details of an installation of an app on a device.</p>
+<p class="toc_element">
+ <code><a href="#list">list(enterpriseId, userId, deviceId)</a></code></p>
+<p class="firstline">Retrieves the details of all apps installed on the specified device.</p>
+<p class="toc_element">
+ <code><a href="#patch">patch(enterpriseId, userId, deviceId, installId, body)</a></code></p>
+<p class="firstline">Requests to install the latest version of an app to a device. If the app is already installed then it is updated to the latest version if necessary. This method supports patch semantics.</p>
+<p class="toc_element">
+ <code><a href="#update">update(enterpriseId, userId, deviceId, installId, body)</a></code></p>
+<p class="firstline">Requests to install the latest version of an app to a device. If the app is already installed then it is updated to the latest version if necessary.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(enterpriseId, userId, deviceId, installId)</code>
+ <pre>Requests to remove an app from a device. A call to get or list will still show the app as installed on the device until it is actually removed.
+
+Args:
+ enterpriseId: string, The ID of the enterprise. (required)
+ userId: string, The ID of the user. (required)
+ deviceId: string, The Android ID of the device. (required)
+ installId: string, The ID of the product represented by the install, e.g. "app:com.google.android.gm". (required)
+</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(enterpriseId, userId, deviceId, installId)</code>
+ <pre>Retrieves details of an installation of an app on a device.
+
+Args:
+ enterpriseId: string, The ID of the enterprise. (required)
+ userId: string, The ID of the user. (required)
+ deviceId: string, The Android ID of the device. (required)
+ installId: string, The ID of the product represented by the install, e.g. "app:com.google.android.gm". (required)
+
+Returns:
+ An object of the form:
+
+ { # The existence of an install resource indicates that an app is installed on a particular device (or that an install is pending).
+ #
+ # The API can be used to create an install resource using the update method. This triggers the actual install of the app on the device. If the user does not already have an entitlement for the app then an attempt is made to create one. If this fails (e.g. because the app is not free and there is no available license) then the creation of the install fails.
+ #
+ # The API can also be used to update an installed app. If the update method is used on an existing install then the app will be updated to the latest available version.
+ #
+ # Note that it is not possible to force the installation of a specific version of an app; the version code is read-only.
+ #
+ # If a user installs an app themselves (as permitted by the enterprise), then again an install resource and possibly an entitlement resource are automatically created.
+ #
+ # The API can also be used to delete an install resource, which triggers the removal of the app from the device. Note that deleting an install does not automatically remove the corresponding entitlement, even if there are no remaining installs. The install resource will also be deleted if the user uninstalls the app themselves.
+ "installState": "A String", # Install state. The state "installPending" means that an install request has recently been made and download to the device is in progress. The state "installed" means that the app has been installed. This field is read-only.
+ "versionCode": 42, # The version of the installed product. Guaranteed to be set only if the install state is "installed".
+ "kind": "androidenterprise#install", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#install".
+ "productId": "A String", # The ID of the product that the install is for, e.g. "app:com.google.android.gm".
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(enterpriseId, userId, deviceId)</code>
+ <pre>Retrieves the details of all apps installed on the specified device.
+
+Args:
+ enterpriseId: string, The ID of the enterprise. (required)
+ userId: string, The ID of the user. (required)
+ deviceId: string, The Android ID of the device. (required)
+
+Returns:
+ An object of the form:
+
+ { # The install resources for the device.
+ "kind": "androidenterprise#installsListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#installsListResponse".
+ "install": [ # An installation of an app for a user on a specific device. The existence of an install implies that the user must have an entitlement to the app.
+ { # The existence of an install resource indicates that an app is installed on a particular device (or that an install is pending).
+ #
+ # The API can be used to create an install resource using the update method. This triggers the actual install of the app on the device. If the user does not already have an entitlement for the app then an attempt is made to create one. If this fails (e.g. because the app is not free and there is no available license) then the creation of the install fails.
+ #
+ # The API can also be used to update an installed app. If the update method is used on an existing install then the app will be updated to the latest available version.
+ #
+ # Note that it is not possible to force the installation of a specific version of an app; the version code is read-only.
+ #
+ # If a user installs an app themselves (as permitted by the enterprise), then again an install resource and possibly an entitlement resource are automatically created.
+ #
+ # The API can also be used to delete an install resource, which triggers the removal of the app from the device. Note that deleting an install does not automatically remove the corresponding entitlement, even if there are no remaining installs. The install resource will also be deleted if the user uninstalls the app themselves.
+ "installState": "A String", # Install state. The state "installPending" means that an install request has recently been made and download to the device is in progress. The state "installed" means that the app has been installed. This field is read-only.
+ "versionCode": 42, # The version of the installed product. Guaranteed to be set only if the install state is "installed".
+ "kind": "androidenterprise#install", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#install".
+ "productId": "A String", # The ID of the product that the install is for, e.g. "app:com.google.android.gm".
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="patch">patch(enterpriseId, userId, deviceId, installId, body)</code>
+ <pre>Requests to install the latest version of an app to a device. If the app is already installed then it is updated to the latest version if necessary. This method supports patch semantics.
+
+Args:
+ enterpriseId: string, The ID of the enterprise. (required)
+ userId: string, The ID of the user. (required)
+ deviceId: string, The Android ID of the device. (required)
+ installId: string, The ID of the product represented by the install, e.g. "app:com.google.android.gm". (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The existence of an install resource indicates that an app is installed on a particular device (or that an install is pending).
+ #
+ # The API can be used to create an install resource using the update method. This triggers the actual install of the app on the device. If the user does not already have an entitlement for the app then an attempt is made to create one. If this fails (e.g. because the app is not free and there is no available license) then the creation of the install fails.
+ #
+ # The API can also be used to update an installed app. If the update method is used on an existing install then the app will be updated to the latest available version.
+ #
+ # Note that it is not possible to force the installation of a specific version of an app; the version code is read-only.
+ #
+ # If a user installs an app themselves (as permitted by the enterprise), then again an install resource and possibly an entitlement resource are automatically created.
+ #
+ # The API can also be used to delete an install resource, which triggers the removal of the app from the device. Note that deleting an install does not automatically remove the corresponding entitlement, even if there are no remaining installs. The install resource will also be deleted if the user uninstalls the app themselves.
+ "installState": "A String", # Install state. The state "installPending" means that an install request has recently been made and download to the device is in progress. The state "installed" means that the app has been installed. This field is read-only.
+ "versionCode": 42, # The version of the installed product. Guaranteed to be set only if the install state is "installed".
+ "kind": "androidenterprise#install", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#install".
+ "productId": "A String", # The ID of the product that the install is for, e.g. "app:com.google.android.gm".
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # The existence of an install resource indicates that an app is installed on a particular device (or that an install is pending).
+ #
+ # The API can be used to create an install resource using the update method. This triggers the actual install of the app on the device. If the user does not already have an entitlement for the app then an attempt is made to create one. If this fails (e.g. because the app is not free and there is no available license) then the creation of the install fails.
+ #
+ # The API can also be used to update an installed app. If the update method is used on an existing install then the app will be updated to the latest available version.
+ #
+ # Note that it is not possible to force the installation of a specific version of an app; the version code is read-only.
+ #
+ # If a user installs an app themselves (as permitted by the enterprise), then again an install resource and possibly an entitlement resource are automatically created.
+ #
+ # The API can also be used to delete an install resource, which triggers the removal of the app from the device. Note that deleting an install does not automatically remove the corresponding entitlement, even if there are no remaining installs. The install resource will also be deleted if the user uninstalls the app themselves.
+ "installState": "A String", # Install state. The state "installPending" means that an install request has recently been made and download to the device is in progress. The state "installed" means that the app has been installed. This field is read-only.
+ "versionCode": 42, # The version of the installed product. Guaranteed to be set only if the install state is "installed".
+ "kind": "androidenterprise#install", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#install".
+ "productId": "A String", # The ID of the product that the install is for, e.g. "app:com.google.android.gm".
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(enterpriseId, userId, deviceId, installId, body)</code>
+ <pre>Requests to install the latest version of an app to a device. If the app is already installed then it is updated to the latest version if necessary.
+
+Args:
+ enterpriseId: string, The ID of the enterprise. (required)
+ userId: string, The ID of the user. (required)
+ deviceId: string, The Android ID of the device. (required)
+ installId: string, The ID of the product represented by the install, e.g. "app:com.google.android.gm". (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The existence of an install resource indicates that an app is installed on a particular device (or that an install is pending).
+ #
+ # The API can be used to create an install resource using the update method. This triggers the actual install of the app on the device. If the user does not already have an entitlement for the app then an attempt is made to create one. If this fails (e.g. because the app is not free and there is no available license) then the creation of the install fails.
+ #
+ # The API can also be used to update an installed app. If the update method is used on an existing install then the app will be updated to the latest available version.
+ #
+ # Note that it is not possible to force the installation of a specific version of an app; the version code is read-only.
+ #
+ # If a user installs an app themselves (as permitted by the enterprise), then again an install resource and possibly an entitlement resource are automatically created.
+ #
+ # The API can also be used to delete an install resource, which triggers the removal of the app from the device. Note that deleting an install does not automatically remove the corresponding entitlement, even if there are no remaining installs. The install resource will also be deleted if the user uninstalls the app themselves.
+ "installState": "A String", # Install state. The state "installPending" means that an install request has recently been made and download to the device is in progress. The state "installed" means that the app has been installed. This field is read-only.
+ "versionCode": 42, # The version of the installed product. Guaranteed to be set only if the install state is "installed".
+ "kind": "androidenterprise#install", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#install".
+ "productId": "A String", # The ID of the product that the install is for, e.g. "app:com.google.android.gm".
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # The existence of an install resource indicates that an app is installed on a particular device (or that an install is pending).
+ #
+ # The API can be used to create an install resource using the update method. This triggers the actual install of the app on the device. If the user does not already have an entitlement for the app then an attempt is made to create one. If this fails (e.g. because the app is not free and there is no available license) then the creation of the install fails.
+ #
+ # The API can also be used to update an installed app. If the update method is used on an existing install then the app will be updated to the latest available version.
+ #
+ # Note that it is not possible to force the installation of a specific version of an app; the version code is read-only.
+ #
+ # If a user installs an app themselves (as permitted by the enterprise), then again an install resource and possibly an entitlement resource are automatically created.
+ #
+ # The API can also be used to delete an install resource, which triggers the removal of the app from the device. Note that deleting an install does not automatically remove the corresponding entitlement, even if there are no remaining installs. The install resource will also be deleted if the user uninstalls the app themselves.
+ "installState": "A String", # Install state. The state "installPending" means that an install request has recently been made and download to the device is in progress. The state "installed" means that the app has been installed. This field is read-only.
+ "versionCode": 42, # The version of the installed product. Guaranteed to be set only if the install state is "installed".
+ "kind": "androidenterprise#install", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#install".
+ "productId": "A String", # The ID of the product that the install is for, e.g. "app:com.google.android.gm".
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/androidenterprise_v1.permissions.html b/docs/dyn/androidenterprise_v1.permissions.html
new file mode 100644
index 0000000..522ed0c
--- /dev/null
+++ b/docs/dyn/androidenterprise_v1.permissions.html
@@ -0,0 +1,102 @@
+<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="androidenterprise_v1.html">Google Play MDM API</a> . <a href="androidenterprise_v1.permissions.html">permissions</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#get">get(permissionId, language=None)</a></code></p>
+<p class="firstline">Retrieves details of an Android app permission for display to an enterprise admin.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="get">get(permissionId, language=None)</code>
+ <pre>Retrieves details of an Android app permission for display to an enterprise admin.
+
+Args:
+ permissionId: string, The ID of the permission. (required)
+ language: string, The BCP47 tag for the user's preferred language (e.g. "en-US", "de")
+
+Returns:
+ An object of the form:
+
+ { # A permission represents some extra capability, to be granted to an Android app, which requires explicit consent. An enterprise admin must consent to these permissions on behalf of their users before an entitlement for the app can be created.
+ #
+ # The permissions collection is read-only. The information provided for each permission (localized name and description) is intended to be used in the MDM user interface when obtaining consent from the enterprise.
+ "permissionId": "A String", # An opaque string uniquely identifying the permission.
+ "kind": "androidenterprise#permission", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#permission".
+ "description": "A String", # A longer description of the permissions giving more details of what it affects.
+ "name": "A String", # The name of the permission.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/androidenterprise_v1.products.html b/docs/dyn/androidenterprise_v1.products.html
new file mode 100644
index 0000000..9c45f97
--- /dev/null
+++ b/docs/dyn/androidenterprise_v1.products.html
@@ -0,0 +1,221 @@
+<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="androidenterprise_v1.html">Google Play MDM API</a> . <a href="androidenterprise_v1.products.html">products</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#get">get(enterpriseId, productId, language=None)</a></code></p>
+<p class="firstline">Retrieves details of a product for display to an enterprise admin.</p>
+<p class="toc_element">
+ <code><a href="#getAppRestrictionsSchema">getAppRestrictionsSchema(enterpriseId, productId, language=None)</a></code></p>
+<p class="firstline">Retrieves the schema defining app restrictions configurable for this product. All products have a schema, but this may be empty if no app restrictions are defined.</p>
+<p class="toc_element">
+ <code><a href="#getPermissions">getPermissions(enterpriseId, productId)</a></code></p>
+<p class="firstline">Retrieves the Android app permissions required by this app.</p>
+<p class="toc_element">
+ <code><a href="#updatePermissions">updatePermissions(enterpriseId, productId, body)</a></code></p>
+<p class="firstline">Updates the set of Android app permissions for this app that have been accepted by the enterprise.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="get">get(enterpriseId, productId, language=None)</code>
+ <pre>Retrieves details of a product for display to an enterprise admin.
+
+Args:
+ enterpriseId: string, The ID of the enterprise. (required)
+ productId: string, The ID of the product, e.g. "app:com.google.android.gm". (required)
+ language: string, The BCP47 tag for the user's preferred language (e.g. "en-US", "de").
+
+Returns:
+ An object of the form:
+
+ { # A product represents an app in the Google Play Store that is available to at least some users in the enterprise. (Some apps are restricted to a single enterprise, and no information about them is made available outside that enterprise.)
+ #
+ # The information provided for each product (localized name, icon, link to the full Google Play details page) is intended to allow a basic representation of the product within an MDM user interface.
+ "kind": "androidenterprise#product", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#product".
+ "title": "A String", # The name of the product.
+ "workDetailsUrl": "A String", # A link to the Google Play for Work details page for the product, for use by an Enterprise administrator.
+ "iconUrl": "A String", # A link to an image that can be used as an icon for the product.
+ "authorName": "A String", # The name of the author of the product (e.g. the app developer).
+ "detailsUrl": "A String", # A link to the (consumer) Google Play details page for the product.
+ "productId": "A String", # A string of the form "app:
+ # " - e.g. "app:com.google.android.gm" represents the GMail app.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="getAppRestrictionsSchema">getAppRestrictionsSchema(enterpriseId, productId, language=None)</code>
+ <pre>Retrieves the schema defining app restrictions configurable for this product. All products have a schema, but this may be empty if no app restrictions are defined.
+
+Args:
+ enterpriseId: string, The ID of the enterprise. (required)
+ productId: string, The ID of the product. (required)
+ language: string, The BCP47 tag for the user's preferred language (e.g. "en-US", "de").
+
+Returns:
+ An object of the form:
+
+ { # Represents the list of app restrictions available to be pre-configured for the product.
+ "restrictions": [ # The set of restrictions that make up this schema.
+ { # A restriction in the App Restriction Schema represents a piece of configuration that may be pre-applied.
+ "restrictionType": "A String", # The type of the restriction.
+ "title": "A String", # The name of the restriction.
+ "defaultValue": { # A typed value for the restriction. # The default value of the restriction.
+ "valueBool": True or False, # The boolean value - this will only be present if type is bool.
+ "valueString": "A String", # The string value - this will be present for types string, choice and hidden.
+ "type": "A String", # The type of the value being provided.
+ "valueMultiselect": [ # The list of string values - this will only be present if type is multiselect.
+ "A String",
+ ],
+ "valueInteger": 42, # The integer value - this will only be present if type is integer.
+ },
+ "entryValue": [ # For choice or multiselect restrictions, the list of possible entries' machine-readable values.
+ "A String",
+ ],
+ "key": "A String", # The unique key that the product uses to identify the restriction, e.g. "com.google.android.gm.fieldname".
+ "entry": [ # For choice or multiselect restrictions, the list of possible entries' human-readable names.
+ "A String",
+ ],
+ "description": "A String", # A longer description of the restriction, giving more detail of what it affects.
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="getPermissions">getPermissions(enterpriseId, productId)</code>
+ <pre>Retrieves the Android app permissions required by this app.
+
+Args:
+ enterpriseId: string, The ID of the enterprise. (required)
+ productId: string, The ID of the product. (required)
+
+Returns:
+ An object of the form:
+
+ { # Information about the permissions required by a specific app and whether they have been accepted by the enterprise.
+ "kind": "androidenterprise#productPermissions", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#productPermissions".
+ "productId": "A String", # The ID of the app that the permissions relate to, e.g. "app:com.google.android.gm".
+ "permission": [ # The permissions required by the app.
+ { # A product permissions resource represents the set of permissions required by a specific app and whether or not they have been accepted by an enterprise admin.
+ #
+ # The API can be used to read the set of permissions, and also to update the set to indicate that permissions have been accepted.
+ "permissionId": "A String", # An opaque string uniquely identifying the permission.
+ "state": "A String", # Whether the permission has been accepted or not.
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="updatePermissions">updatePermissions(enterpriseId, productId, body)</code>
+ <pre>Updates the set of Android app permissions for this app that have been accepted by the enterprise.
+
+Args:
+ enterpriseId: string, The ID of the enterprise. (required)
+ productId: string, The ID of the product. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Information about the permissions required by a specific app and whether they have been accepted by the enterprise.
+ "kind": "androidenterprise#productPermissions", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#productPermissions".
+ "productId": "A String", # The ID of the app that the permissions relate to, e.g. "app:com.google.android.gm".
+ "permission": [ # The permissions required by the app.
+ { # A product permissions resource represents the set of permissions required by a specific app and whether or not they have been accepted by an enterprise admin.
+ #
+ # The API can be used to read the set of permissions, and also to update the set to indicate that permissions have been accepted.
+ "permissionId": "A String", # An opaque string uniquely identifying the permission.
+ "state": "A String", # Whether the permission has been accepted or not.
+ },
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # Information about the permissions required by a specific app and whether they have been accepted by the enterprise.
+ "kind": "androidenterprise#productPermissions", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#productPermissions".
+ "productId": "A String", # The ID of the app that the permissions relate to, e.g. "app:com.google.android.gm".
+ "permission": [ # The permissions required by the app.
+ { # A product permissions resource represents the set of permissions required by a specific app and whether or not they have been accepted by an enterprise admin.
+ #
+ # The API can be used to read the set of permissions, and also to update the set to indicate that permissions have been accepted.
+ "permissionId": "A String", # An opaque string uniquely identifying the permission.
+ "state": "A String", # Whether the permission has been accepted or not.
+ },
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/androidenterprise_v1.users.html b/docs/dyn/androidenterprise_v1.users.html
new file mode 100644
index 0000000..41c87b6
--- /dev/null
+++ b/docs/dyn/androidenterprise_v1.users.html
@@ -0,0 +1,167 @@
+<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="androidenterprise_v1.html">Google Play MDM API</a> . <a href="androidenterprise_v1.users.html">users</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#generateToken">generateToken(enterpriseId, userId)</a></code></p>
+<p class="firstline">Generates a token (activation code) to allow this user to configure their work account in the Android Setup Wizard. Revokes any previously generated token.</p>
+<p class="toc_element">
+ <code><a href="#get">get(enterpriseId, userId)</a></code></p>
+<p class="firstline">Retrieves a user's details.</p>
+<p class="toc_element">
+ <code><a href="#list">list(enterpriseId, email)</a></code></p>
+<p class="firstline">Looks up a user by email address.</p>
+<p class="toc_element">
+ <code><a href="#revokeToken">revokeToken(enterpriseId, userId)</a></code></p>
+<p class="firstline">Revokes a previously generated token (activation code) for the user.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="generateToken">generateToken(enterpriseId, userId)</code>
+ <pre>Generates a token (activation code) to allow this user to configure their work account in the Android Setup Wizard. Revokes any previously generated token.
+
+Args:
+ enterpriseId: string, The ID of the enterprise. (required)
+ userId: string, The ID of the user. (required)
+
+Returns:
+ An object of the form:
+
+ { # A UserToken is used by a user when setting up a managed device or profile with their work account on a device. When the user enters their email address and token (activation code) the appropriate MDM app can be automatically downloaded.
+ "kind": "androidenterprise#userToken", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#userToken".
+ "userId": "A String", # The unique ID for the user.
+ "token": "A String", # The token (activation code) to be entered by the user. This consists of a sequence of decimal digits. Note that the leading digit may be 0.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(enterpriseId, userId)</code>
+ <pre>Retrieves a user's details.
+
+Args:
+ enterpriseId: string, The ID of the enterprise. (required)
+ userId: string, The ID of the user. (required)
+
+Returns:
+ An object of the form:
+
+ { # A user resource represents an individual user within the enterprise's domain.
+ #
+ # Note that each user is associated with a Google account based on the user's corporate email address (which must be in one of the enterprise's domains). As part of installing an MDM app to manage a device the Google account must be provisioned to the device, and so the user resource must be created before that. This can be done using the Google Admin SDK Directory API.
+ #
+ # The ID for a user is an opaque string. It can be retrieved using the list method queried by the user's primary email address.
+ "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
+ "primaryEmail": "A String", # The user's primary email, e.g. "jsmith@example.com".
+ "id": "A String", # The unique ID for the user.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(enterpriseId, email)</code>
+ <pre>Looks up a user by email address.
+
+Args:
+ enterpriseId: string, The ID of the enterprise. (required)
+ email: string, The exact primary email address of the user to look up. (required)
+
+Returns:
+ An object of the form:
+
+ { # The matching user resources.
+ "kind": "androidenterprise#usersListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#usersListResponse".
+ "user": [ # A user of an enterprise.
+ { # A user resource represents an individual user within the enterprise's domain.
+ #
+ # Note that each user is associated with a Google account based on the user's corporate email address (which must be in one of the enterprise's domains). As part of installing an MDM app to manage a device the Google account must be provisioned to the device, and so the user resource must be created before that. This can be done using the Google Admin SDK Directory API.
+ #
+ # The ID for a user is an opaque string. It can be retrieved using the list method queried by the user's primary email address.
+ "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
+ "primaryEmail": "A String", # The user's primary email, e.g. "jsmith@example.com".
+ "id": "A String", # The unique ID for the user.
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="revokeToken">revokeToken(enterpriseId, userId)</code>
+ <pre>Revokes a previously generated token (activation code) for the user.
+
+Args:
+ enterpriseId: string, The ID of the enterprise. (required)
+ userId: string, The ID of the user. (required)
+</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_v1.addresses.html b/docs/dyn/compute_v1.addresses.html
index ad6e877..7be781c 100644
--- a/docs/dyn/compute_v1.addresses.html
+++ b/docs/dyn/compute_v1.addresses.html
@@ -101,7 +101,7 @@
<pre>Retrieves the list of addresses grouped by scope.
Args:
- project: string, Name of the project scoping this request. (required)
+ project: string, Project ID for this request. (required)
maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
filter: string, Optional. Filter expression for filtering listed resources.
@@ -110,40 +110,40 @@
An object of the form:
{
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": { # A map of scoped address lists.
- "a_key": { # Name of the scope containing this set of addresses.
- "warning": { # Informational warning which replaces the list of addresses when the list is empty.
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+ "items": { # [Output Only] A map of scoped address lists.
+ "a_key": { # [Output Only] Name of the scope containing this set of addresses.
+ "warning": { # [Output Only] Informational warning which replaces the list of addresses when the list is empty.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
- "addresses": [ # List of addresses contained in this scope.
+ "addresses": [ # [Output Only] List of addresses contained in this scope.
{ # A reserved address resource.
- "status": "A String", # The status of the address (output only).
- "kind": "compute#address", # Type of the resource.
+ "status": "A String", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
+ "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "region": "A String", # URL of the region where the regional address resides (output only). This field is not applicable to global addresses.
- "address": "A String", # The IP address represented by this resource.
- "users": [ # The resources that are using this address resource.
+ "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses.
+ "address": "A String", # The static external IP address represented by this resource.
+ "users": [ # [Output Only] The URLs of the resources that are using this address.
"A String",
],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for the resource.
+ "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
},
],
},
},
- "kind": "compute#addressAggregatedList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
+ "kind": "compute#addressAggregatedList", # [Output Only] Type of resource. Always compute#addressAggregatedList for aggregated lists of addresses.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for this resource.
}</pre>
</div>
@@ -166,44 +166,44 @@
<pre>Deletes the specified address resource.
Args:
- project: string, Name of the project scoping this request. (required)
- region: string, Name of the region scoping this request. (required)
+ project: string, Project ID for this request. (required)
+ region: string, The name of the region for this request. (required)
address: string, Name of the address resource to delete. (required)
Returns:
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -212,9 +212,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -223,26 +223,26 @@
<pre>Returns the specified address resource.
Args:
- project: string, Name of the project scoping this request. (required)
- region: string, Name of the region scoping this request. (required)
+ project: string, Project ID for this request. (required)
+ region: string, The name of the region for this request. (required)
address: string, Name of the address resource to return. (required)
Returns:
An object of the form:
{ # A reserved address resource.
- "status": "A String", # The status of the address (output only).
- "kind": "compute#address", # Type of the resource.
+ "status": "A String", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
+ "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "region": "A String", # URL of the region where the regional address resides (output only). This field is not applicable to global addresses.
- "address": "A String", # The IP address represented by this resource.
- "users": [ # The resources that are using this address resource.
+ "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses.
+ "address": "A String", # The static external IP address represented by this resource.
+ "users": [ # [Output Only] The URLs of the resources that are using this address.
"A String",
],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for the resource.
+ "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
}</pre>
</div>
@@ -251,24 +251,24 @@
<pre>Creates an address resource in the specified project using the data included in the request.
Args:
- project: string, Name of the project scoping this request. (required)
- region: string, Name of the region scoping this request. (required)
+ project: string, Project ID for this request. (required)
+ region: string, The name of the region for this request. (required)
body: object, The request body. (required)
The object takes the form of:
{ # A reserved address resource.
- "status": "A String", # The status of the address (output only).
- "kind": "compute#address", # Type of the resource.
+ "status": "A String", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
+ "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "region": "A String", # URL of the region where the regional address resides (output only). This field is not applicable to global addresses.
- "address": "A String", # The IP address represented by this resource.
- "users": [ # The resources that are using this address resource.
+ "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses.
+ "address": "A String", # The static external IP address represented by this resource.
+ "users": [ # [Output Only] The URLs of the resources that are using this address.
"A String",
],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for the resource.
+ "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
}
@@ -276,36 +276,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -314,9 +314,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -325,8 +325,8 @@
<pre>Retrieves the list of address resources contained within the specified region.
Args:
- project: string, Name of the project scoping this request. (required)
- region: string, Name of the region scoping this request. (required)
+ project: string, Project ID for this request. (required)
+ region: string, The name of the region for this request. (required)
maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
filter: string, Optional. Filter expression for filtering listed resources.
@@ -335,26 +335,26 @@
An object of the form:
{ # Contains a list of address resources.
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # A list of Address resources.
+ "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+ "items": [ # [Output Only] A list of Address resources.
{ # A reserved address resource.
- "status": "A String", # The status of the address (output only).
- "kind": "compute#address", # Type of the resource.
+ "status": "A String", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
+ "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "region": "A String", # URL of the region where the regional address resides (output only). This field is not applicable to global addresses.
- "address": "A String", # The IP address represented by this resource.
- "users": [ # The resources that are using this address resource.
+ "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses.
+ "address": "A String", # The static external IP address represented by this resource.
+ "users": [ # [Output Only] The URLs of the resources that are using this address.
"A String",
],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for the resource.
+ "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
},
],
- "kind": "compute#addressList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
+ "kind": "compute#addressList", # [Output Only] Type of resource. Always compute#addressList for lists of addresses.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for the resource.
}</pre>
</div>
diff --git a/docs/dyn/compute_v1.backendServices.html b/docs/dyn/compute_v1.backendServices.html
index 8e3806c..6423376 100644
--- a/docs/dyn/compute_v1.backendServices.html
+++ b/docs/dyn/compute_v1.backendServices.html
@@ -111,36 +111,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -149,9 +149,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -268,36 +268,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -306,9 +306,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -419,36 +419,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -457,9 +457,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -506,36 +506,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -544,9 +544,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
diff --git a/docs/dyn/compute_v1.diskTypes.html b/docs/dyn/compute_v1.diskTypes.html
index 329e747..67028e5 100644
--- a/docs/dyn/compute_v1.diskTypes.html
+++ b/docs/dyn/compute_v1.diskTypes.html
@@ -95,7 +95,7 @@
<pre>Retrieves the list of disk type resources grouped by scope.
Args:
- project: string, Name of the project scoping this request. (required)
+ project: string, Project ID for this request. (required)
maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
filter: string, Optional. Filter expression for filtering listed resources.
@@ -104,44 +104,44 @@
An object of the form:
{
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": { # A map of scoped disk type lists.
- "a_key": { # Name of the scope containing this set of disk types.
- "warning": { # Informational warning which replaces the list of disk types when the list is empty.
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+ "items": { # [Output Only] A map of scoped disk type lists.
+ "a_key": { # [Output Only] Name of the scope containing this set of disk types.
+ "warning": { # [Output Only] Informational warning which replaces the list of disk types when the list is empty.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
- "diskTypes": [ # List of disk types contained in this scope.
+ "diskTypes": [ # [Output Only] List of disk types contained in this scope.
{ # A disk type resource.
- "kind": "compute#diskType", # Type of the resource.
- "description": "A String", # An optional textual description of the resource.
- "zone": "A String", # Url of the zone where the disk type resides (output only).
- "validDiskSize": "A String", # An optional textual descroption of the valid disk size, e.g., "10GB-10TB".
- "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this disk type.
+ "kind": "compute#diskType", # [Output Only] Type of the resource. Always compute#diskType for disk types.
+ "description": "A String", # [Output Only] An optional textual description of the resource.
+ "zone": "A String", # [Output Only] URL of the zone where the disk type resides.
+ "validDiskSize": "A String", # [Output Only] An optional textual description of the valid disk size, such as "10GB-10TB".
+ "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this disk type.
"deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
"deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
- "state": "A String", # The deprecation state. Can be "DEPRECATED", "OBSOLETE", or "DELETED". Operations which create a new resource using a "DEPRECATED" resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. New uses of "OBSOLETE" or "DELETED" resources will result in an error.
+ "state": "A String", # The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.
"obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
- "replacement": "A String", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
+ "replacement": "A String", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
},
- "defaultDiskSizeGb": "A String", # Server defined default disk size in gb (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource.
+ "defaultDiskSizeGb": "A String", # [Output Only] Server defined default disk size in GB.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for the resource.
+ "name": "A String", # [Output Only] Name of the resource.
},
],
},
},
- "kind": "compute#diskTypeAggregatedList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
+ "kind": "compute#diskTypeAggregatedList", # [Output Only] Type of resource. Always compute#diskTypeAggregatedList.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for this resource.
}</pre>
</div>
@@ -164,30 +164,30 @@
<pre>Returns the specified disk type resource.
Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
diskType: string, Name of the disk type resource to return. (required)
Returns:
An object of the form:
{ # A disk type resource.
- "kind": "compute#diskType", # Type of the resource.
- "description": "A String", # An optional textual description of the resource.
- "zone": "A String", # Url of the zone where the disk type resides (output only).
- "validDiskSize": "A String", # An optional textual descroption of the valid disk size, e.g., "10GB-10TB".
- "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this disk type.
+ "kind": "compute#diskType", # [Output Only] Type of the resource. Always compute#diskType for disk types.
+ "description": "A String", # [Output Only] An optional textual description of the resource.
+ "zone": "A String", # [Output Only] URL of the zone where the disk type resides.
+ "validDiskSize": "A String", # [Output Only] An optional textual description of the valid disk size, such as "10GB-10TB".
+ "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this disk type.
"deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
"deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
- "state": "A String", # The deprecation state. Can be "DEPRECATED", "OBSOLETE", or "DELETED". Operations which create a new resource using a "DEPRECATED" resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. New uses of "OBSOLETE" or "DELETED" resources will result in an error.
+ "state": "A String", # The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.
"obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
- "replacement": "A String", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
+ "replacement": "A String", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
},
- "defaultDiskSizeGb": "A String", # Server defined default disk size in gb (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource.
+ "defaultDiskSizeGb": "A String", # [Output Only] Server defined default disk size in GB.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for the resource.
+ "name": "A String", # [Output Only] Name of the resource.
}</pre>
</div>
@@ -196,8 +196,8 @@
<pre>Retrieves the list of disk type resources available to the specified project.
Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
filter: string, Optional. Filter expression for filtering listed resources.
@@ -206,30 +206,30 @@
An object of the form:
{ # Contains a list of disk type resources.
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # A list of DiskType resources.
+ "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+ "items": [ # [Output Only] A list of Disk Type resources.
{ # A disk type resource.
- "kind": "compute#diskType", # Type of the resource.
- "description": "A String", # An optional textual description of the resource.
- "zone": "A String", # Url of the zone where the disk type resides (output only).
- "validDiskSize": "A String", # An optional textual descroption of the valid disk size, e.g., "10GB-10TB".
- "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this disk type.
+ "kind": "compute#diskType", # [Output Only] Type of the resource. Always compute#diskType for disk types.
+ "description": "A String", # [Output Only] An optional textual description of the resource.
+ "zone": "A String", # [Output Only] URL of the zone where the disk type resides.
+ "validDiskSize": "A String", # [Output Only] An optional textual description of the valid disk size, such as "10GB-10TB".
+ "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this disk type.
"deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
"deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
- "state": "A String", # The deprecation state. Can be "DEPRECATED", "OBSOLETE", or "DELETED". Operations which create a new resource using a "DEPRECATED" resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. New uses of "OBSOLETE" or "DELETED" resources will result in an error.
+ "state": "A String", # The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.
"obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
- "replacement": "A String", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
+ "replacement": "A String", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
},
- "defaultDiskSizeGb": "A String", # Server defined default disk size in gb (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource.
+ "defaultDiskSizeGb": "A String", # [Output Only] Server defined default disk size in GB.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for the resource.
+ "name": "A String", # [Output Only] Name of the resource.
},
],
- "kind": "compute#diskTypeList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
+ "kind": "compute#diskTypeList", # [Output Only] Type of resource. Always compute#diskTypeList for disk types.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for this resource.
}</pre>
</div>
diff --git a/docs/dyn/compute_v1.disks.html b/docs/dyn/compute_v1.disks.html
index b23f53a..aa9ddad 100644
--- a/docs/dyn/compute_v1.disks.html
+++ b/docs/dyn/compute_v1.disks.html
@@ -85,16 +85,16 @@
<p class="firstline">A description of how to use this function</p>
<p class="toc_element">
<code><a href="#delete">delete(project, zone, disk)</a></code></p>
-<p class="firstline">Deletes the specified persistent disk resource.</p>
+<p class="firstline">Deletes the specified persistent disk.</p>
<p class="toc_element">
<code><a href="#get">get(project, zone, disk)</a></code></p>
-<p class="firstline">Returns the specified persistent disk resource.</p>
+<p class="firstline">Returns a specified persistent disk.</p>
<p class="toc_element">
<code><a href="#insert">insert(project, zone, body, sourceImage=None)</a></code></p>
-<p class="firstline">Creates a persistent disk resource in the specified project using the data included in the request.</p>
+<p class="firstline">Creates a persistent disk in the specified project using the data included in the request.</p>
<p class="toc_element">
<code><a href="#list">list(project, zone, maxResults=None, pageToken=None, filter=None)</a></code></p>
-<p class="firstline">Retrieves the list of persistent disk resources contained within the specified zone.</p>
+<p class="firstline">Retrieves the list of persistent disks contained within the specified zone.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
@@ -104,7 +104,7 @@
<pre>Retrieves the list of disks grouped by scope.
Args:
- project: string, Name of the project scoping this request. (required)
+ project: string, Project ID for this request. (required)
maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
filter: string, Optional. Filter expression for filtering listed resources.
@@ -113,46 +113,61 @@
An object of the form:
{
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": { # A map of scoped disk lists.
- "a_key": { # Name of the scope containing this set of disks.
- "disks": [ # List of disks contained in this scope.
- { # A persistent disk resource.
- "status": "A String", # The status of disk creation (output only).
- "sourceSnapshot": "A String", # The source snapshot used to create this disk.
- "kind": "compute#disk", # Type of the resource.
+ "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+ "items": { # [Output Only] A map of scoped disk lists.
+ "a_key": { # [Output Only] Name of the scope containing this set of disks.
+ "disks": [ # [Output Only] List of disks contained in this scope.
+ { # A Disk resource.
+ "status": "A String", # [Output Only] The status of disk creation. Applicable statuses includes: CREATING, FAILED, READY, RESTORING.
+ "sourceSnapshot": "A String", # The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot
+ # - projects/project/global/snapshots/snapshot
+ # - global/snapshots/snapshot
+ "kind": "compute#disk", # [Output Only] Type of the resource. Always compute#disk for disks.
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sizeGb": "A String", # Size of the persistent disk, specified in GB. This parameter is optional when creating a disk from a disk image or a snapshot, otherwise it is required.
+ "sizeGb": "A String", # Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk.
+ #
+ # If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot.
"type": "A String", # URL of the disk type resource describing which disk type to use to create the disk; provided by the client when the disk is created.
"options": "A String", # Internal use only.
- "sourceImageId": "A String", # The 'id' value of the image used to create this disk. This value may be used to determine whether the disk was created from the current or a previous instance of a given image.
- "sourceSnapshotId": "A String", # The 'id' value of the snapshot used to create this disk. This value may be used to determine whether the disk was created from the current or a previous instance of a given disk snapshot.
- "sourceImage": "A String", # The source image used to create this disk.
- "licenses": [ # Public visible licenses.
+ "sourceImageId": "A String", # The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.
+ "sourceSnapshotId": "A String", # [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.
+ "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted from the system, this field will not be set, even if an image with the same name has been re-created.
+ #
+ # When creating a disk, you can provide a private (custom) image using the following input, and Compute Engine will use the corresponding image from your project. For example:
+ #
+ # global/images/my-private-image
+ #
+ # Or you can provide an image from a publicly-available project. For example, to use a Debian image from the debian-cloud project, make sure to include the project in the URL:
+ #
+ # projects/debian-cloud/global/images/debian-7-wheezy-vYYYYMMDD
+ #
+ # where vYYYYMMDD is the image version. The fully-qualified URL will also work in both cases.
+ "licenses": [ # Any applicable publicly visible licenses.
"A String",
],
- "zone": "A String", # URL of the zone where the disk resides (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
+ "zone": "A String", # [Output Only] URL of the zone where the disk resides.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
+ "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
},
],
- "warning": { # Informational warning which replaces the list of disks when the list is empty.
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "warning": { # [Output Only] Informational warning which replaces the list of disks when the list is empty.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
},
},
- "kind": "compute#diskAggregatedList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
+ "kind": "compute#diskAggregatedList", # [Output Only] Type of resource. Always compute#diskAggregatedList for aggregated lists of persistent disks.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for this resource.
}</pre>
</div>
@@ -175,9 +190,9 @@
<pre>A description of how to use this function
Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
- disk: string, Name of the persistent disk resource to snapshot. (required)
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ disk: string, Name of the persistent disk to snapshot. (required)
body: object, The request body. (required)
The object takes the form of:
@@ -204,36 +219,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -242,55 +257,55 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(project, zone, disk)</code>
- <pre>Deletes the specified persistent disk resource.
+ <pre>Deletes the specified persistent disk.
Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
- disk: string, Name of the persistent disk resource to delete. (required)
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ disk: string, Name of the persistent disk to delete. (required)
Returns:
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -299,75 +314,105 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(project, zone, disk)</code>
- <pre>Returns the specified persistent disk resource.
+ <pre>Returns a specified persistent disk.
Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
- disk: string, Name of the persistent disk resource to return. (required)
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ disk: string, Name of the persistent disk to return. (required)
Returns:
An object of the form:
- { # A persistent disk resource.
- "status": "A String", # The status of disk creation (output only).
- "sourceSnapshot": "A String", # The source snapshot used to create this disk.
- "kind": "compute#disk", # Type of the resource.
+ { # A Disk resource.
+ "status": "A String", # [Output Only] The status of disk creation. Applicable statuses includes: CREATING, FAILED, READY, RESTORING.
+ "sourceSnapshot": "A String", # The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot
+ # - projects/project/global/snapshots/snapshot
+ # - global/snapshots/snapshot
+ "kind": "compute#disk", # [Output Only] Type of the resource. Always compute#disk for disks.
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sizeGb": "A String", # Size of the persistent disk, specified in GB. This parameter is optional when creating a disk from a disk image or a snapshot, otherwise it is required.
+ "sizeGb": "A String", # Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk.
+ #
+ # If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot.
"type": "A String", # URL of the disk type resource describing which disk type to use to create the disk; provided by the client when the disk is created.
"options": "A String", # Internal use only.
- "sourceImageId": "A String", # The 'id' value of the image used to create this disk. This value may be used to determine whether the disk was created from the current or a previous instance of a given image.
- "sourceSnapshotId": "A String", # The 'id' value of the snapshot used to create this disk. This value may be used to determine whether the disk was created from the current or a previous instance of a given disk snapshot.
- "sourceImage": "A String", # The source image used to create this disk.
- "licenses": [ # Public visible licenses.
+ "sourceImageId": "A String", # The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.
+ "sourceSnapshotId": "A String", # [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.
+ "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted from the system, this field will not be set, even if an image with the same name has been re-created.
+ #
+ # When creating a disk, you can provide a private (custom) image using the following input, and Compute Engine will use the corresponding image from your project. For example:
+ #
+ # global/images/my-private-image
+ #
+ # Or you can provide an image from a publicly-available project. For example, to use a Debian image from the debian-cloud project, make sure to include the project in the URL:
+ #
+ # projects/debian-cloud/global/images/debian-7-wheezy-vYYYYMMDD
+ #
+ # where vYYYYMMDD is the image version. The fully-qualified URL will also work in both cases.
+ "licenses": [ # Any applicable publicly visible licenses.
"A String",
],
- "zone": "A String", # URL of the zone where the disk resides (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
+ "zone": "A String", # [Output Only] URL of the zone where the disk resides.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
+ "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(project, zone, body, sourceImage=None)</code>
- <pre>Creates a persistent disk resource in the specified project using the data included in the request.
+ <pre>Creates a persistent disk in the specified project using the data included in the request.
Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
body: object, The request body. (required)
The object takes the form of:
-{ # A persistent disk resource.
- "status": "A String", # The status of disk creation (output only).
- "sourceSnapshot": "A String", # The source snapshot used to create this disk.
- "kind": "compute#disk", # Type of the resource.
+{ # A Disk resource.
+ "status": "A String", # [Output Only] The status of disk creation. Applicable statuses includes: CREATING, FAILED, READY, RESTORING.
+ "sourceSnapshot": "A String", # The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot
+ # - projects/project/global/snapshots/snapshot
+ # - global/snapshots/snapshot
+ "kind": "compute#disk", # [Output Only] Type of the resource. Always compute#disk for disks.
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sizeGb": "A String", # Size of the persistent disk, specified in GB. This parameter is optional when creating a disk from a disk image or a snapshot, otherwise it is required.
+ "sizeGb": "A String", # Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk.
+ #
+ # If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot.
"type": "A String", # URL of the disk type resource describing which disk type to use to create the disk; provided by the client when the disk is created.
"options": "A String", # Internal use only.
- "sourceImageId": "A String", # The 'id' value of the image used to create this disk. This value may be used to determine whether the disk was created from the current or a previous instance of a given image.
- "sourceSnapshotId": "A String", # The 'id' value of the snapshot used to create this disk. This value may be used to determine whether the disk was created from the current or a previous instance of a given disk snapshot.
- "sourceImage": "A String", # The source image used to create this disk.
- "licenses": [ # Public visible licenses.
+ "sourceImageId": "A String", # The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.
+ "sourceSnapshotId": "A String", # [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.
+ "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted from the system, this field will not be set, even if an image with the same name has been re-created.
+ #
+ # When creating a disk, you can provide a private (custom) image using the following input, and Compute Engine will use the corresponding image from your project. For example:
+ #
+ # global/images/my-private-image
+ #
+ # Or you can provide an image from a publicly-available project. For example, to use a Debian image from the debian-cloud project, make sure to include the project in the URL:
+ #
+ # projects/debian-cloud/global/images/debian-7-wheezy-vYYYYMMDD
+ #
+ # where vYYYYMMDD is the image version. The fully-qualified URL will also work in both cases.
+ "licenses": [ # Any applicable publicly visible licenses.
"A String",
],
- "zone": "A String", # URL of the zone where the disk resides (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
+ "zone": "A String", # [Output Only] URL of the zone where the disk resides.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
+ "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
}
sourceImage: string, Optional. Source image to restore onto a disk.
@@ -376,36 +421,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -414,19 +459,19 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(project, zone, maxResults=None, pageToken=None, filter=None)</code>
- <pre>Retrieves the list of persistent disk resources contained within the specified zone.
+ <pre>Retrieves the list of persistent disks contained within the specified zone.
Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
filter: string, Optional. Filter expression for filtering listed resources.
@@ -434,33 +479,48 @@
Returns:
An object of the form:
- { # Contains a list of persistent disk resources.
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # A list of Disk resources.
- { # A persistent disk resource.
- "status": "A String", # The status of disk creation (output only).
- "sourceSnapshot": "A String", # The source snapshot used to create this disk.
- "kind": "compute#disk", # Type of the resource.
+ { # A list of Disk resources.
+ "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+ "items": [ # [Output Only] A list of persistent disks.
+ { # A Disk resource.
+ "status": "A String", # [Output Only] The status of disk creation. Applicable statuses includes: CREATING, FAILED, READY, RESTORING.
+ "sourceSnapshot": "A String", # The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot
+ # - projects/project/global/snapshots/snapshot
+ # - global/snapshots/snapshot
+ "kind": "compute#disk", # [Output Only] Type of the resource. Always compute#disk for disks.
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sizeGb": "A String", # Size of the persistent disk, specified in GB. This parameter is optional when creating a disk from a disk image or a snapshot, otherwise it is required.
+ "sizeGb": "A String", # Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk.
+ #
+ # If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot.
"type": "A String", # URL of the disk type resource describing which disk type to use to create the disk; provided by the client when the disk is created.
"options": "A String", # Internal use only.
- "sourceImageId": "A String", # The 'id' value of the image used to create this disk. This value may be used to determine whether the disk was created from the current or a previous instance of a given image.
- "sourceSnapshotId": "A String", # The 'id' value of the snapshot used to create this disk. This value may be used to determine whether the disk was created from the current or a previous instance of a given disk snapshot.
- "sourceImage": "A String", # The source image used to create this disk.
- "licenses": [ # Public visible licenses.
+ "sourceImageId": "A String", # The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.
+ "sourceSnapshotId": "A String", # [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.
+ "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted from the system, this field will not be set, even if an image with the same name has been re-created.
+ #
+ # When creating a disk, you can provide a private (custom) image using the following input, and Compute Engine will use the corresponding image from your project. For example:
+ #
+ # global/images/my-private-image
+ #
+ # Or you can provide an image from a publicly-available project. For example, to use a Debian image from the debian-cloud project, make sure to include the project in the URL:
+ #
+ # projects/debian-cloud/global/images/debian-7-wheezy-vYYYYMMDD
+ #
+ # where vYYYYMMDD is the image version. The fully-qualified URL will also work in both cases.
+ "licenses": [ # Any applicable publicly visible licenses.
"A String",
],
- "zone": "A String", # URL of the zone where the disk resides (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
+ "zone": "A String", # [Output Only] URL of the zone where the disk resides.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
+ "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
},
],
- "kind": "compute#diskList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
+ "kind": "compute#diskList", # [Output Only] Type of resource. Always compute#diskList for lists of disks.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for this resource.
}</pre>
</div>
diff --git a/docs/dyn/compute_v1.firewalls.html b/docs/dyn/compute_v1.firewalls.html
index caa017b..d4671ae 100644
--- a/docs/dyn/compute_v1.firewalls.html
+++ b/docs/dyn/compute_v1.firewalls.html
@@ -101,43 +101,43 @@
<pre>Deletes the specified firewall resource.
Args:
- project: string, Name of the project scoping this request. (required)
+ project: string, Project ID for this request. (required)
firewall: string, Name of the firewall resource to delete. (required)
Returns:
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -146,9 +146,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -157,39 +157,48 @@
<pre>Returns the specified firewall resource.
Args:
- project: string, Name of the project scoping this request. (required)
+ project: string, Project ID for this request. (required)
firewall: string, Name of the firewall resource to return. (required)
Returns:
An object of the form:
- { # A firewall resource.
- "kind": "compute#firewall", # Type of the resource.
+ { # A Firewall resource.
+ "kind": "compute#firewall", # [Output Ony] Type of the resource. Always compute#firewall for firewall rules.
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
+ "sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set.
+ #
+ # If both properties are set, an inbound connection is allowed if the range or the tag of the source matches the sourceRanges OR matches the sourceTags property; the connection does not need to match both properties.
"A String",
],
- "sourceRanges": [ # A list of IP address blocks expressed in CIDR format which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
+ "sourceRanges": [ # The IP address blocks that this rule applies to, expressed in CIDR format. One or both of sourceRanges and sourceTags may be set.
+ #
+ # If both properties are set, an inbound connection is allowed if the range or the tag of the source matches the sourceRanges OR matches the sourceTags property; the connection does not need to match both properties.
"A String",
],
- "network": "A String", # URL of the network to which this firewall is applied; provided by the client when the firewall is created.
- "targetTags": [ # A list of instance tags indicating sets of instances located on network which may make network connections as specified in allowed. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
+ "network": "A String", # URL of the network resource for this firewall rule. This field is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
+ # global/networks/default
+ # If you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
+ # - projects/myproject/global/networks/my-network
+ # - global/networks/default
+ "targetTags": [ # A list of instance tags indicating sets of instances located on network which may make network connections as specified in allowed[]. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
"A String",
],
"allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
{
- "IPProtocol": "A String", # Required; this is the IP protocol that is allowed for this rule. This can either be one of the following well known protocol strings ["tcp", "udp", "icmp", "esp", "ah", "sctp"], or the IP protocol number.
- "ports": [ # An optional list of ports which are allowed. It is an error to specify this for any protocol that isn't UDP or TCP. Each entry must be either an integer or a range. If not specified, connections through any port are allowed.
+ "IPProtocol": "A String", # The IP protocol that is allowed for this rule. The protocol type is required when creating a firewall. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
+ "ports": [ # An optional list of ports which are allowed. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, connections through any port are allowed
#
- # Example inputs include: ["22"], ["80","443"] and ["12345-12349"].
+ # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
"A String",
],
},
],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339text format.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for the resource.
+ "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
}</pre>
</div>
@@ -198,37 +207,46 @@
<pre>Creates a firewall resource in the specified project using the data included in the request.
Args:
- project: string, Name of the project scoping this request. (required)
+ project: string, Project ID for this request. (required)
body: object, The request body. (required)
The object takes the form of:
-{ # A firewall resource.
- "kind": "compute#firewall", # Type of the resource.
+{ # A Firewall resource.
+ "kind": "compute#firewall", # [Output Ony] Type of the resource. Always compute#firewall for firewall rules.
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
+ "sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set.
+ #
+ # If both properties are set, an inbound connection is allowed if the range or the tag of the source matches the sourceRanges OR matches the sourceTags property; the connection does not need to match both properties.
"A String",
],
- "sourceRanges": [ # A list of IP address blocks expressed in CIDR format which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
+ "sourceRanges": [ # The IP address blocks that this rule applies to, expressed in CIDR format. One or both of sourceRanges and sourceTags may be set.
+ #
+ # If both properties are set, an inbound connection is allowed if the range or the tag of the source matches the sourceRanges OR matches the sourceTags property; the connection does not need to match both properties.
"A String",
],
- "network": "A String", # URL of the network to which this firewall is applied; provided by the client when the firewall is created.
- "targetTags": [ # A list of instance tags indicating sets of instances located on network which may make network connections as specified in allowed. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
+ "network": "A String", # URL of the network resource for this firewall rule. This field is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
+ # global/networks/default
+ # If you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
+ # - projects/myproject/global/networks/my-network
+ # - global/networks/default
+ "targetTags": [ # A list of instance tags indicating sets of instances located on network which may make network connections as specified in allowed[]. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
"A String",
],
"allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
{
- "IPProtocol": "A String", # Required; this is the IP protocol that is allowed for this rule. This can either be one of the following well known protocol strings ["tcp", "udp", "icmp", "esp", "ah", "sctp"], or the IP protocol number.
- "ports": [ # An optional list of ports which are allowed. It is an error to specify this for any protocol that isn't UDP or TCP. Each entry must be either an integer or a range. If not specified, connections through any port are allowed.
+ "IPProtocol": "A String", # The IP protocol that is allowed for this rule. The protocol type is required when creating a firewall. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
+ "ports": [ # An optional list of ports which are allowed. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, connections through any port are allowed
#
- # Example inputs include: ["22"], ["80","443"] and ["12345-12349"].
+ # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
"A String",
],
},
],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339text format.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for the resource.
+ "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
}
@@ -236,36 +254,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -274,9 +292,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -285,7 +303,7 @@
<pre>Retrieves the list of firewall resources available to the specified project.
Args:
- project: string, Name of the project scoping this request. (required)
+ project: string, Project ID for this request. (required)
maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
filter: string, Optional. Filter expression for filtering listed resources.
@@ -293,41 +311,50 @@
Returns:
An object of the form:
- { # Contains a list of firewall resources.
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # A list of Firewall resources.
- { # A firewall resource.
- "kind": "compute#firewall", # Type of the resource.
+ { # Contains a list of Firewall resources.
+ "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+ "items": [ # [Output Only] A list of Firewall resources.
+ { # A Firewall resource.
+ "kind": "compute#firewall", # [Output Ony] Type of the resource. Always compute#firewall for firewall rules.
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
+ "sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set.
+ #
+ # If both properties are set, an inbound connection is allowed if the range or the tag of the source matches the sourceRanges OR matches the sourceTags property; the connection does not need to match both properties.
"A String",
],
- "sourceRanges": [ # A list of IP address blocks expressed in CIDR format which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
+ "sourceRanges": [ # The IP address blocks that this rule applies to, expressed in CIDR format. One or both of sourceRanges and sourceTags may be set.
+ #
+ # If both properties are set, an inbound connection is allowed if the range or the tag of the source matches the sourceRanges OR matches the sourceTags property; the connection does not need to match both properties.
"A String",
],
- "network": "A String", # URL of the network to which this firewall is applied; provided by the client when the firewall is created.
- "targetTags": [ # A list of instance tags indicating sets of instances located on network which may make network connections as specified in allowed. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
+ "network": "A String", # URL of the network resource for this firewall rule. This field is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
+ # global/networks/default
+ # If you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
+ # - projects/myproject/global/networks/my-network
+ # - global/networks/default
+ "targetTags": [ # A list of instance tags indicating sets of instances located on network which may make network connections as specified in allowed[]. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
"A String",
],
"allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
{
- "IPProtocol": "A String", # Required; this is the IP protocol that is allowed for this rule. This can either be one of the following well known protocol strings ["tcp", "udp", "icmp", "esp", "ah", "sctp"], or the IP protocol number.
- "ports": [ # An optional list of ports which are allowed. It is an error to specify this for any protocol that isn't UDP or TCP. Each entry must be either an integer or a range. If not specified, connections through any port are allowed.
+ "IPProtocol": "A String", # The IP protocol that is allowed for this rule. The protocol type is required when creating a firewall. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
+ "ports": [ # An optional list of ports which are allowed. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, connections through any port are allowed
#
- # Example inputs include: ["22"], ["80","443"] and ["12345-12349"].
+ # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
"A String",
],
},
],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339text format.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for the resource.
+ "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
},
],
- "kind": "compute#firewallList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
+ "kind": "compute#firewallList", # [Output Only] Type of resource. Always compute#firewallList for lists of firewalls.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for this resource.
}</pre>
</div>
@@ -350,38 +377,47 @@
<pre>Updates the specified firewall resource with the data included in the request. This method supports patch semantics.
Args:
- project: string, Name of the project scoping this request. (required)
+ project: string, Project ID for this request. (required)
firewall: string, Name of the firewall resource to update. (required)
body: object, The request body. (required)
The object takes the form of:
-{ # A firewall resource.
- "kind": "compute#firewall", # Type of the resource.
+{ # A Firewall resource.
+ "kind": "compute#firewall", # [Output Ony] Type of the resource. Always compute#firewall for firewall rules.
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
+ "sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set.
+ #
+ # If both properties are set, an inbound connection is allowed if the range or the tag of the source matches the sourceRanges OR matches the sourceTags property; the connection does not need to match both properties.
"A String",
],
- "sourceRanges": [ # A list of IP address blocks expressed in CIDR format which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
+ "sourceRanges": [ # The IP address blocks that this rule applies to, expressed in CIDR format. One or both of sourceRanges and sourceTags may be set.
+ #
+ # If both properties are set, an inbound connection is allowed if the range or the tag of the source matches the sourceRanges OR matches the sourceTags property; the connection does not need to match both properties.
"A String",
],
- "network": "A String", # URL of the network to which this firewall is applied; provided by the client when the firewall is created.
- "targetTags": [ # A list of instance tags indicating sets of instances located on network which may make network connections as specified in allowed. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
+ "network": "A String", # URL of the network resource for this firewall rule. This field is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
+ # global/networks/default
+ # If you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
+ # - projects/myproject/global/networks/my-network
+ # - global/networks/default
+ "targetTags": [ # A list of instance tags indicating sets of instances located on network which may make network connections as specified in allowed[]. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
"A String",
],
"allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
{
- "IPProtocol": "A String", # Required; this is the IP protocol that is allowed for this rule. This can either be one of the following well known protocol strings ["tcp", "udp", "icmp", "esp", "ah", "sctp"], or the IP protocol number.
- "ports": [ # An optional list of ports which are allowed. It is an error to specify this for any protocol that isn't UDP or TCP. Each entry must be either an integer or a range. If not specified, connections through any port are allowed.
+ "IPProtocol": "A String", # The IP protocol that is allowed for this rule. The protocol type is required when creating a firewall. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
+ "ports": [ # An optional list of ports which are allowed. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, connections through any port are allowed
#
- # Example inputs include: ["22"], ["80","443"] and ["12345-12349"].
+ # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
"A String",
],
},
],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339text format.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for the resource.
+ "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
}
@@ -389,36 +425,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -427,9 +463,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -438,38 +474,47 @@
<pre>Updates the specified firewall resource with the data included in the request.
Args:
- project: string, Name of the project scoping this request. (required)
+ project: string, Project ID for this request. (required)
firewall: string, Name of the firewall resource to update. (required)
body: object, The request body. (required)
The object takes the form of:
-{ # A firewall resource.
- "kind": "compute#firewall", # Type of the resource.
+{ # A Firewall resource.
+ "kind": "compute#firewall", # [Output Ony] Type of the resource. Always compute#firewall for firewall rules.
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
+ "sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set.
+ #
+ # If both properties are set, an inbound connection is allowed if the range or the tag of the source matches the sourceRanges OR matches the sourceTags property; the connection does not need to match both properties.
"A String",
],
- "sourceRanges": [ # A list of IP address blocks expressed in CIDR format which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
+ "sourceRanges": [ # The IP address blocks that this rule applies to, expressed in CIDR format. One or both of sourceRanges and sourceTags may be set.
+ #
+ # If both properties are set, an inbound connection is allowed if the range or the tag of the source matches the sourceRanges OR matches the sourceTags property; the connection does not need to match both properties.
"A String",
],
- "network": "A String", # URL of the network to which this firewall is applied; provided by the client when the firewall is created.
- "targetTags": [ # A list of instance tags indicating sets of instances located on network which may make network connections as specified in allowed. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
+ "network": "A String", # URL of the network resource for this firewall rule. This field is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
+ # global/networks/default
+ # If you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
+ # - projects/myproject/global/networks/my-network
+ # - global/networks/default
+ "targetTags": [ # A list of instance tags indicating sets of instances located on network which may make network connections as specified in allowed[]. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
"A String",
],
"allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
{
- "IPProtocol": "A String", # Required; this is the IP protocol that is allowed for this rule. This can either be one of the following well known protocol strings ["tcp", "udp", "icmp", "esp", "ah", "sctp"], or the IP protocol number.
- "ports": [ # An optional list of ports which are allowed. It is an error to specify this for any protocol that isn't UDP or TCP. Each entry must be either an integer or a range. If not specified, connections through any port are allowed.
+ "IPProtocol": "A String", # The IP protocol that is allowed for this rule. The protocol type is required when creating a firewall. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
+ "ports": [ # An optional list of ports which are allowed. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, connections through any port are allowed
#
- # Example inputs include: ["22"], ["80","443"] and ["12345-12349"].
+ # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
"A String",
],
},
],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339text format.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for the resource.
+ "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
}
@@ -477,36 +522,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -515,9 +560,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
diff --git a/docs/dyn/compute_v1.forwardingRules.html b/docs/dyn/compute_v1.forwardingRules.html
index e0992b3..991bcdf 100644
--- a/docs/dyn/compute_v1.forwardingRules.html
+++ b/docs/dyn/compute_v1.forwardingRules.html
@@ -132,12 +132,12 @@
},
],
"warning": { # Informational warning which replaces the list of forwarding rules when the list is empty.
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
@@ -176,36 +176,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -214,9 +214,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -276,36 +276,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -314,9 +314,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -391,36 +391,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -429,9 +429,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
diff --git a/docs/dyn/compute_v1.globalAddresses.html b/docs/dyn/compute_v1.globalAddresses.html
index 7277c65..0e259b2 100644
--- a/docs/dyn/compute_v1.globalAddresses.html
+++ b/docs/dyn/compute_v1.globalAddresses.html
@@ -95,43 +95,43 @@
<pre>Deletes the specified address resource.
Args:
- project: string, Name of the project scoping this request. (required)
+ project: string, Project ID for this request. (required)
address: string, Name of the address resource to delete. (required)
Returns:
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -140,9 +140,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -151,25 +151,25 @@
<pre>Returns the specified address resource.
Args:
- project: string, Name of the project scoping this request. (required)
+ project: string, Project ID for this request. (required)
address: string, Name of the address resource to return. (required)
Returns:
An object of the form:
{ # A reserved address resource.
- "status": "A String", # The status of the address (output only).
- "kind": "compute#address", # Type of the resource.
+ "status": "A String", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
+ "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "region": "A String", # URL of the region where the regional address resides (output only). This field is not applicable to global addresses.
- "address": "A String", # The IP address represented by this resource.
- "users": [ # The resources that are using this address resource.
+ "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses.
+ "address": "A String", # The static external IP address represented by this resource.
+ "users": [ # [Output Only] The URLs of the resources that are using this address.
"A String",
],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for the resource.
+ "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
}</pre>
</div>
@@ -178,23 +178,23 @@
<pre>Creates an address resource in the specified project using the data included in the request.
Args:
- project: string, Name of the project scoping this request. (required)
+ project: string, Project ID for this request. (required)
body: object, The request body. (required)
The object takes the form of:
{ # A reserved address resource.
- "status": "A String", # The status of the address (output only).
- "kind": "compute#address", # Type of the resource.
+ "status": "A String", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
+ "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "region": "A String", # URL of the region where the regional address resides (output only). This field is not applicable to global addresses.
- "address": "A String", # The IP address represented by this resource.
- "users": [ # The resources that are using this address resource.
+ "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses.
+ "address": "A String", # The static external IP address represented by this resource.
+ "users": [ # [Output Only] The URLs of the resources that are using this address.
"A String",
],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for the resource.
+ "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
}
@@ -202,36 +202,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -240,9 +240,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -251,7 +251,7 @@
<pre>Retrieves the list of global address resources.
Args:
- project: string, Name of the project scoping this request. (required)
+ project: string, Project ID for this request. (required)
maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
filter: string, Optional. Filter expression for filtering listed resources.
@@ -260,26 +260,26 @@
An object of the form:
{ # Contains a list of address resources.
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # A list of Address resources.
+ "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+ "items": [ # [Output Only] A list of Address resources.
{ # A reserved address resource.
- "status": "A String", # The status of the address (output only).
- "kind": "compute#address", # Type of the resource.
+ "status": "A String", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
+ "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "region": "A String", # URL of the region where the regional address resides (output only). This field is not applicable to global addresses.
- "address": "A String", # The IP address represented by this resource.
- "users": [ # The resources that are using this address resource.
+ "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses.
+ "address": "A String", # The static external IP address represented by this resource.
+ "users": [ # [Output Only] The URLs of the resources that are using this address.
"A String",
],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for the resource.
+ "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
},
],
- "kind": "compute#addressList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
+ "kind": "compute#addressList", # [Output Only] Type of resource. Always compute#addressList for lists of addresses.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for the resource.
}</pre>
</div>
diff --git a/docs/dyn/compute_v1.globalForwardingRules.html b/docs/dyn/compute_v1.globalForwardingRules.html
index d91364a..a87b191 100644
--- a/docs/dyn/compute_v1.globalForwardingRules.html
+++ b/docs/dyn/compute_v1.globalForwardingRules.html
@@ -105,36 +105,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -143,9 +143,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -203,36 +203,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -241,9 +241,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -316,36 +316,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -354,9 +354,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
diff --git a/docs/dyn/compute_v1.globalOperations.html b/docs/dyn/compute_v1.globalOperations.html
index 95aebbc..9f3bb3a 100644
--- a/docs/dyn/compute_v1.globalOperations.html
+++ b/docs/dyn/compute_v1.globalOperations.html
@@ -98,7 +98,7 @@
<pre>Retrieves the list of all operations grouped by scope.
Args:
- project: string, Name of the project scoping this request. (required)
+ project: string, Project ID for this request. (required)
maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
filter: string, Optional. Filter expression for filtering listed resources.
@@ -112,36 +112,36 @@
"a_key": { # [Output Only] Name of the scope containing this set of operations.
"operations": [ # [Output Only] List of operations contained in this scope.
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -150,24 +150,24 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
},
],
"warning": { # [Output Only] Informational warning which replaces the list of operations when the list is empty.
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
},
},
- "kind": "compute#operationAggregatedList", # Type of resource.
+ "kind": "compute#operationAggregatedList", # [Output Only] Type of resource. Always compute#operationAggregatedList for aggregated lists of operations.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
"selfLink": "A String", # [Output Only] Server defined URL for this resource.
}</pre>
@@ -192,7 +192,7 @@
<pre>Deletes the specified operation resource.
Args:
- project: string, Name of the project scoping this request. (required)
+ project: string, Project ID for this request. (required)
operation: string, Name of the operation resource to delete. (required)
</pre>
</div>
@@ -202,43 +202,43 @@
<pre>Retrieves the specified operation resource.
Args:
- project: string, Name of the project scoping this request. (required)
+ project: string, Project ID for this request. (required)
operation: string, Name of the operation resource to return. (required)
Returns:
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -247,9 +247,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -258,7 +258,7 @@
<pre>Retrieves the list of operation resources contained within the specified project.
Args:
- project: string, Name of the project scoping this request. (required)
+ project: string, Project ID for this request. (required)
maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
filter: string, Optional. Filter expression for filtering listed resources.
@@ -270,36 +270,36 @@
"nextPageToken": "A String", # [Output Only] A token used to continue a truncate.
"items": [ # [Output Only] The operation resources.
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -308,12 +308,12 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
},
],
- "kind": "compute#operationList", # Type of resource. Always compute#operations for Operations resource.
+ "kind": "compute#operationList", # [Output Only] Type of resource. Always compute#operations for Operations resource.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
"selfLink": "A String", # [Output Only] Server defined URL for this resource.
}</pre>
diff --git a/docs/dyn/compute_v1.httpHealthChecks.html b/docs/dyn/compute_v1.httpHealthChecks.html
index 3103db1..1a13a33 100644
--- a/docs/dyn/compute_v1.httpHealthChecks.html
+++ b/docs/dyn/compute_v1.httpHealthChecks.html
@@ -108,36 +108,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -146,9 +146,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -210,36 +210,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -248,9 +248,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -337,36 +337,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -375,9 +375,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -412,36 +412,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -450,9 +450,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
diff --git a/docs/dyn/compute_v1.images.html b/docs/dyn/compute_v1.images.html
index d22becb..9d7ecc6 100644
--- a/docs/dyn/compute_v1.images.html
+++ b/docs/dyn/compute_v1.images.html
@@ -79,7 +79,7 @@
<p class="firstline">Deletes the specified image resource.</p>
<p class="toc_element">
<code><a href="#deprecate">deprecate(project, image, body)</a></code></p>
-<p class="firstline">Sets the deprecation status of an image. If no message body is given, clears the deprecation status instead.</p>
+<p class="firstline">Sets the deprecation status of an image.</p>
<p class="toc_element">
<code><a href="#get">get(project, image)</a></code></p>
<p class="firstline">Returns the specified image resource.</p>
@@ -98,43 +98,43 @@
<pre>Deletes the specified image resource.
Args:
- project: string, Name of the project scoping this request. (required)
+ project: string, Project ID for this request. (required)
image: string, Name of the image resource to delete. (required)
Returns:
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -143,18 +143,20 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
<div class="method">
<code class="details" id="deprecate">deprecate(project, image, body)</code>
- <pre>Sets the deprecation status of an image. If no message body is given, clears the deprecation status instead.
+ <pre>Sets the deprecation status of an image.
+
+If an empty request body is given, clears the deprecation status instead.
Args:
- project: string, Name of the project scoping this request. (required)
+ project: string, Project ID for this request. (required)
image: string, Image name. (required)
body: object, The request body. (required)
The object takes the form of:
@@ -162,9 +164,9 @@
{ # Deprecation status for a public resource.
"deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
"deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
- "state": "A String", # The deprecation state. Can be "DEPRECATED", "OBSOLETE", or "DELETED". Operations which create a new resource using a "DEPRECATED" resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. New uses of "OBSOLETE" or "DELETED" resources will result in an error.
+ "state": "A String", # The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.
"obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
- "replacement": "A String", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
+ "replacement": "A String", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
}
@@ -172,36 +174,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -210,9 +212,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -221,40 +223,43 @@
<pre>Returns the specified image resource.
Args:
- project: string, Name of the project scoping this request. (required)
+ project: string, Project ID for this request. (required)
image: string, Name of the image resource to return. (required)
Returns:
An object of the form:
- { # A disk image resource.
- "status": "A String", # Status of the image (output only). It will be one of the following READY - after image has been successfully created and is ready for use FAILED - if creating the image fails for some reason PENDING - the image creation is in progress An image can be used to create other resources suck as instances only after the image has been successfully created and the status is set to READY.
- "kind": "compute#image", # Type of the resource.
+ { # An Image resource.
+ "status": "A String", # [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.
+ "kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images.
"description": "A String", # Textual description of the resource; provided by the client when the resource is created.
- "rawDisk": { # The raw disk image parameters.
- "containerType": "A String", # The format used to encode and transmit the block device. Should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.
- "source": "A String", # The full Google Cloud Storage URL where the disk image is stored; provided by the client when the disk image is created.
+ "rawDisk": { # The parameters of the raw disk image.
+ "containerType": "A String", # The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.
+ "source": "A String", # The full Google Cloud Storage URL where the disk image is stored. You must provide either this property or the sourceDisk property but not both.
"sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
},
"deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this image.
"deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
"deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
- "state": "A String", # The deprecation state. Can be "DEPRECATED", "OBSOLETE", or "DELETED". Operations which create a new resource using a "DEPRECATED" resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. New uses of "OBSOLETE" or "DELETED" resources will result in an error.
+ "state": "A String", # The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.
"obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
- "replacement": "A String", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
+ "replacement": "A String", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
},
"archiveSizeBytes": "A String", # Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).
- "sourceDiskId": "A String", # The 'id' value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.
- "diskSizeGb": "A String", # Size of the image when restored onto a disk (in GiB).
- "sourceDisk": "A String", # The source disk used to create this image.
- "licenses": [ # Public visible licenses.
+ "sourceDiskId": "A String", # The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.
+ "diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB).
+ "sourceDisk": "A String", # URL of the The source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disk/disk
+ # - projects/project/zones/zone/disk/disk
+ # - zones/zone/disks/disk
+ "licenses": [ # Any applicable publicly visible licenses.
"A String",
],
- "sourceType": "RAW", # Must be "RAW"; provided by the client when the disk image is created.
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
+ "sourceType": "RAW", # The type of the image used to create this disk. The default and only value is RAW
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for the resource.
+ "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
}</pre>
</div>
@@ -263,38 +268,41 @@
<pre>Creates an image resource in the specified project using the data included in the request.
Args:
- project: string, Name of the project scoping this request. (required)
+ project: string, Project ID for this request. (required)
body: object, The request body. (required)
The object takes the form of:
-{ # A disk image resource.
- "status": "A String", # Status of the image (output only). It will be one of the following READY - after image has been successfully created and is ready for use FAILED - if creating the image fails for some reason PENDING - the image creation is in progress An image can be used to create other resources suck as instances only after the image has been successfully created and the status is set to READY.
- "kind": "compute#image", # Type of the resource.
+{ # An Image resource.
+ "status": "A String", # [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.
+ "kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images.
"description": "A String", # Textual description of the resource; provided by the client when the resource is created.
- "rawDisk": { # The raw disk image parameters.
- "containerType": "A String", # The format used to encode and transmit the block device. Should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.
- "source": "A String", # The full Google Cloud Storage URL where the disk image is stored; provided by the client when the disk image is created.
+ "rawDisk": { # The parameters of the raw disk image.
+ "containerType": "A String", # The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.
+ "source": "A String", # The full Google Cloud Storage URL where the disk image is stored. You must provide either this property or the sourceDisk property but not both.
"sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
},
"deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this image.
"deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
"deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
- "state": "A String", # The deprecation state. Can be "DEPRECATED", "OBSOLETE", or "DELETED". Operations which create a new resource using a "DEPRECATED" resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. New uses of "OBSOLETE" or "DELETED" resources will result in an error.
+ "state": "A String", # The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.
"obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
- "replacement": "A String", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
+ "replacement": "A String", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
},
"archiveSizeBytes": "A String", # Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).
- "sourceDiskId": "A String", # The 'id' value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.
- "diskSizeGb": "A String", # Size of the image when restored onto a disk (in GiB).
- "sourceDisk": "A String", # The source disk used to create this image.
- "licenses": [ # Public visible licenses.
+ "sourceDiskId": "A String", # The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.
+ "diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB).
+ "sourceDisk": "A String", # URL of the The source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disk/disk
+ # - projects/project/zones/zone/disk/disk
+ # - zones/zone/disks/disk
+ "licenses": [ # Any applicable publicly visible licenses.
"A String",
],
- "sourceType": "RAW", # Must be "RAW"; provided by the client when the disk image is created.
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
+ "sourceType": "RAW", # The type of the image used to create this disk. The default and only value is RAW
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for the resource.
+ "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
}
@@ -302,36 +310,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -340,9 +348,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -351,7 +359,7 @@
<pre>Retrieves the list of image resources available to the specified project.
Args:
- project: string, Name of the project scoping this request. (required)
+ project: string, Project ID for this request. (required)
maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
filter: string, Optional. Filter expression for filtering listed resources.
@@ -359,37 +367,40 @@
Returns:
An object of the form:
- { # Contains a list of disk image resources.
+ { # Contains a list of Image resources.
"nextPageToken": "A String", # A token used to continue a truncated list request (output only).
"items": [ # A list of Image resources.
- { # A disk image resource.
- "status": "A String", # Status of the image (output only). It will be one of the following READY - after image has been successfully created and is ready for use FAILED - if creating the image fails for some reason PENDING - the image creation is in progress An image can be used to create other resources suck as instances only after the image has been successfully created and the status is set to READY.
- "kind": "compute#image", # Type of the resource.
+ { # An Image resource.
+ "status": "A String", # [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.
+ "kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images.
"description": "A String", # Textual description of the resource; provided by the client when the resource is created.
- "rawDisk": { # The raw disk image parameters.
- "containerType": "A String", # The format used to encode and transmit the block device. Should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.
- "source": "A String", # The full Google Cloud Storage URL where the disk image is stored; provided by the client when the disk image is created.
+ "rawDisk": { # The parameters of the raw disk image.
+ "containerType": "A String", # The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.
+ "source": "A String", # The full Google Cloud Storage URL where the disk image is stored. You must provide either this property or the sourceDisk property but not both.
"sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
},
"deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this image.
"deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
"deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
- "state": "A String", # The deprecation state. Can be "DEPRECATED", "OBSOLETE", or "DELETED". Operations which create a new resource using a "DEPRECATED" resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. New uses of "OBSOLETE" or "DELETED" resources will result in an error.
+ "state": "A String", # The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.
"obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
- "replacement": "A String", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
+ "replacement": "A String", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
},
"archiveSizeBytes": "A String", # Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).
- "sourceDiskId": "A String", # The 'id' value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.
- "diskSizeGb": "A String", # Size of the image when restored onto a disk (in GiB).
- "sourceDisk": "A String", # The source disk used to create this image.
- "licenses": [ # Public visible licenses.
+ "sourceDiskId": "A String", # The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.
+ "diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB).
+ "sourceDisk": "A String", # URL of the The source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disk/disk
+ # - projects/project/zones/zone/disk/disk
+ # - zones/zone/disks/disk
+ "licenses": [ # Any applicable publicly visible licenses.
"A String",
],
- "sourceType": "RAW", # Must be "RAW"; provided by the client when the disk image is created.
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
+ "sourceType": "RAW", # The type of the image used to create this disk. The default and only value is RAW
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for the resource.
+ "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
},
],
"kind": "compute#imageList", # Type of resource.
diff --git a/docs/dyn/compute_v1.instanceTemplates.html b/docs/dyn/compute_v1.instanceTemplates.html
index cec70e0..0334cf8 100644
--- a/docs/dyn/compute_v1.instanceTemplates.html
+++ b/docs/dyn/compute_v1.instanceTemplates.html
@@ -102,36 +102,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -140,9 +140,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -169,33 +169,56 @@
"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
"A String",
],
- "fingerprint": "A String", # Fingerprint of this resource. A hash of the tags stored in this object. This field is used optimistic locking. An up-to-date tags fingerprint must be provided in order to modify tags.
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+ #
+ # To see the latest fingerprint, make get() request to the instance.
},
"disks": [ # Array of disks associated with instance created based on this template.
{ # An instance-attached disk resource.
- "deviceName": "A String", # Persistent disk only; must be unique within the instance when specified. This represents a unique device name that is reflected into the /dev/ tree of a Linux operating system running within the instance. If not specified, a default will be chosen by the system.
- "kind": "compute#attachedDisk", # Type of the resource.
- "initializeParams": { # Initialization parameters for the new disk (input-only). Can only be specified on the boot disk or local SSDs. Mutually exclusive with 'source'. # Initialization parameters.
- "diskSizeGb": "A String", # Size of the disk in base-2 GB.
- "diskName": "A String", # Name of the disk (when not provided defaults to the name of the instance).
- "sourceImage": "A String", # The source image used to create this disk.
- "diskType": "A String", # URL of the disk type resource describing which disk type to use to create the disk; provided by the client when the disk is created.
+ "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/ tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
+ #
+ # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
+ "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
+ "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
+ "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
+ "sourceImage": "A String", # A source image used to create the disk. You can provide a private (custom) image, and Compute Engine will use the corresponding image from your project. For example:
+ #
+ # global/images/my-private-image
+ #
+ # Or you can provide an image from a publicly-available project. For example, to use a Debian image from the debian-cloud project, make sure to include the project in the URL:
+ #
+ # projects/debian-cloud/global/images/debian-7-wheezy-vYYYYMMDD
+ #
+ # where vYYYYMMDD is the image version. The fully-qualified URL will also work in both cases.
+ "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
+ #
+ # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+ #
+ # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+ # - projects/project/zones/zone/diskTypes/diskType
+ # - zones/zone/diskTypes/diskType
},
- "autoDelete": True or False, # Whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
- "index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, the server will choose an appropriate value (output only).
- "boot": True or False, # Indicates that this is a boot disk. VM will use the first partition of the disk for its root filesystem.
- "licenses": [ # Public visible licenses.
+ "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
+ "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
+ "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
+ "licenses": [ # [Output Only] Any valid publicly visible licenses.
"A String",
],
- "mode": "A String", # The mode in which to attach this disk, either "READ_WRITE" or "READ_ONLY".
+ "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
"interface": "A String",
- "type": "A String", # Type of the disk, either "SCRATCH" or "PERSISTENT". Note that persistent disks must be created before you can specify them here.
- "source": "A String", # Persistent disk only; the URL of the persistent disk resource.
+ "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
+ "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks.
},
],
- "scheduling": { # Scheduling options for an Instance. # Scheduling options for the instances created based on this template.
- "automaticRestart": True or False, # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user).
- "onHostMaintenance": "A String", # How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance.
+ "scheduling": { # Sets the scheduling options for an Instance. # Scheduling options for the instances created based on this template.
+ "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user).
+ "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. The default behavior is MIGRATE. For more information, see Setting maintenance behavior.
},
"canIpForward": True or False, # Allows instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, say true. If unsure, leave this set to false.
"serviceAccounts": [ # A list of service accounts each with specified scopes, for which access tokens are to be made available to the instances created based on this template, through metadata queries.
@@ -213,22 +236,29 @@
"key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
},
],
- "kind": "compute#metadata", # Type of the resource.
- "fingerprint": "A String", # Fingerprint of this resource. A hash of the metadata's contents. This field is used for optimistic locking. An up-to-date metadata fingerprint must be provided in order to modify metadata.
+ "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
},
"networkInterfaces": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instances created based based on this template will have no external internet access.
{ # A network interface resource attached to an instance.
- "accessConfigs": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
+ "accessConfigs": [ # An array of configurations for this interface. Currently, <codeONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
{ # An access configuration attached to an instance's network interface.
- "kind": "compute#accessConfig", # Type of the resource.
- "type": "ONE_TO_ONE_NAT", # Type of configuration. Must be set to "ONE_TO_ONE_NAT". This configures port-for-port NAT to the internet.
+ "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
+ "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
"name": "A String", # Name of this access configuration.
- "natIP": "A String", # An external IP address associated with this instance. Specify an unused static IP address available to the project. If not specified, the external IP will be drawn from a shared ephemeral pool.
+ "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
},
],
- "networkIP": "A String", # An optional IPV4 internal network address assigned to the instance for this network interface (output only).
- "name": "A String", # Name of the network interface, determined by the server; for network devices, these are e.g. eth0, eth1, etc. (output only).
- "network": "A String", # URL of the network resource attached to this interface.
+ "networkIP": "A String", # [Output Only] An optional IPV4 internal network address assigned to the instance for this network interface.
+ "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
+ "network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
+ #
+ # global/networks/default
+ #
+ # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
+ # - projects/project/global/networks/network
+ # - global/networks/default
},
],
},
@@ -258,33 +288,56 @@
"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
"A String",
],
- "fingerprint": "A String", # Fingerprint of this resource. A hash of the tags stored in this object. This field is used optimistic locking. An up-to-date tags fingerprint must be provided in order to modify tags.
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+ #
+ # To see the latest fingerprint, make get() request to the instance.
},
"disks": [ # Array of disks associated with instance created based on this template.
{ # An instance-attached disk resource.
- "deviceName": "A String", # Persistent disk only; must be unique within the instance when specified. This represents a unique device name that is reflected into the /dev/ tree of a Linux operating system running within the instance. If not specified, a default will be chosen by the system.
- "kind": "compute#attachedDisk", # Type of the resource.
- "initializeParams": { # Initialization parameters for the new disk (input-only). Can only be specified on the boot disk or local SSDs. Mutually exclusive with 'source'. # Initialization parameters.
- "diskSizeGb": "A String", # Size of the disk in base-2 GB.
- "diskName": "A String", # Name of the disk (when not provided defaults to the name of the instance).
- "sourceImage": "A String", # The source image used to create this disk.
- "diskType": "A String", # URL of the disk type resource describing which disk type to use to create the disk; provided by the client when the disk is created.
+ "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/ tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
+ #
+ # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
+ "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
+ "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
+ "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
+ "sourceImage": "A String", # A source image used to create the disk. You can provide a private (custom) image, and Compute Engine will use the corresponding image from your project. For example:
+ #
+ # global/images/my-private-image
+ #
+ # Or you can provide an image from a publicly-available project. For example, to use a Debian image from the debian-cloud project, make sure to include the project in the URL:
+ #
+ # projects/debian-cloud/global/images/debian-7-wheezy-vYYYYMMDD
+ #
+ # where vYYYYMMDD is the image version. The fully-qualified URL will also work in both cases.
+ "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
+ #
+ # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+ #
+ # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+ # - projects/project/zones/zone/diskTypes/diskType
+ # - zones/zone/diskTypes/diskType
},
- "autoDelete": True or False, # Whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
- "index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, the server will choose an appropriate value (output only).
- "boot": True or False, # Indicates that this is a boot disk. VM will use the first partition of the disk for its root filesystem.
- "licenses": [ # Public visible licenses.
+ "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
+ "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
+ "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
+ "licenses": [ # [Output Only] Any valid publicly visible licenses.
"A String",
],
- "mode": "A String", # The mode in which to attach this disk, either "READ_WRITE" or "READ_ONLY".
+ "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
"interface": "A String",
- "type": "A String", # Type of the disk, either "SCRATCH" or "PERSISTENT". Note that persistent disks must be created before you can specify them here.
- "source": "A String", # Persistent disk only; the URL of the persistent disk resource.
+ "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
+ "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks.
},
],
- "scheduling": { # Scheduling options for an Instance. # Scheduling options for the instances created based on this template.
- "automaticRestart": True or False, # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user).
- "onHostMaintenance": "A String", # How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance.
+ "scheduling": { # Sets the scheduling options for an Instance. # Scheduling options for the instances created based on this template.
+ "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user).
+ "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. The default behavior is MIGRATE. For more information, see Setting maintenance behavior.
},
"canIpForward": True or False, # Allows instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, say true. If unsure, leave this set to false.
"serviceAccounts": [ # A list of service accounts each with specified scopes, for which access tokens are to be made available to the instances created based on this template, through metadata queries.
@@ -302,22 +355,29 @@
"key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
},
],
- "kind": "compute#metadata", # Type of the resource.
- "fingerprint": "A String", # Fingerprint of this resource. A hash of the metadata's contents. This field is used for optimistic locking. An up-to-date metadata fingerprint must be provided in order to modify metadata.
+ "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
},
"networkInterfaces": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instances created based based on this template will have no external internet access.
{ # A network interface resource attached to an instance.
- "accessConfigs": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
+ "accessConfigs": [ # An array of configurations for this interface. Currently, <codeONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
{ # An access configuration attached to an instance's network interface.
- "kind": "compute#accessConfig", # Type of the resource.
- "type": "ONE_TO_ONE_NAT", # Type of configuration. Must be set to "ONE_TO_ONE_NAT". This configures port-for-port NAT to the internet.
+ "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
+ "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
"name": "A String", # Name of this access configuration.
- "natIP": "A String", # An external IP address associated with this instance. Specify an unused static IP address available to the project. If not specified, the external IP will be drawn from a shared ephemeral pool.
+ "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
},
],
- "networkIP": "A String", # An optional IPV4 internal network address assigned to the instance for this network interface (output only).
- "name": "A String", # Name of the network interface, determined by the server; for network devices, these are e.g. eth0, eth1, etc. (output only).
- "network": "A String", # URL of the network resource attached to this interface.
+ "networkIP": "A String", # [Output Only] An optional IPV4 internal network address assigned to the instance for this network interface.
+ "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
+ "network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
+ #
+ # global/networks/default
+ #
+ # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
+ # - projects/project/global/networks/network
+ # - global/networks/default
},
],
},
@@ -330,36 +390,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -368,9 +428,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -402,33 +462,56 @@
"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
"A String",
],
- "fingerprint": "A String", # Fingerprint of this resource. A hash of the tags stored in this object. This field is used optimistic locking. An up-to-date tags fingerprint must be provided in order to modify tags.
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+ #
+ # To see the latest fingerprint, make get() request to the instance.
},
"disks": [ # Array of disks associated with instance created based on this template.
{ # An instance-attached disk resource.
- "deviceName": "A String", # Persistent disk only; must be unique within the instance when specified. This represents a unique device name that is reflected into the /dev/ tree of a Linux operating system running within the instance. If not specified, a default will be chosen by the system.
- "kind": "compute#attachedDisk", # Type of the resource.
- "initializeParams": { # Initialization parameters for the new disk (input-only). Can only be specified on the boot disk or local SSDs. Mutually exclusive with 'source'. # Initialization parameters.
- "diskSizeGb": "A String", # Size of the disk in base-2 GB.
- "diskName": "A String", # Name of the disk (when not provided defaults to the name of the instance).
- "sourceImage": "A String", # The source image used to create this disk.
- "diskType": "A String", # URL of the disk type resource describing which disk type to use to create the disk; provided by the client when the disk is created.
+ "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/ tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
+ #
+ # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
+ "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
+ "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
+ "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
+ "sourceImage": "A String", # A source image used to create the disk. You can provide a private (custom) image, and Compute Engine will use the corresponding image from your project. For example:
+ #
+ # global/images/my-private-image
+ #
+ # Or you can provide an image from a publicly-available project. For example, to use a Debian image from the debian-cloud project, make sure to include the project in the URL:
+ #
+ # projects/debian-cloud/global/images/debian-7-wheezy-vYYYYMMDD
+ #
+ # where vYYYYMMDD is the image version. The fully-qualified URL will also work in both cases.
+ "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
+ #
+ # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+ #
+ # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+ # - projects/project/zones/zone/diskTypes/diskType
+ # - zones/zone/diskTypes/diskType
},
- "autoDelete": True or False, # Whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
- "index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, the server will choose an appropriate value (output only).
- "boot": True or False, # Indicates that this is a boot disk. VM will use the first partition of the disk for its root filesystem.
- "licenses": [ # Public visible licenses.
+ "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
+ "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
+ "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
+ "licenses": [ # [Output Only] Any valid publicly visible licenses.
"A String",
],
- "mode": "A String", # The mode in which to attach this disk, either "READ_WRITE" or "READ_ONLY".
+ "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
"interface": "A String",
- "type": "A String", # Type of the disk, either "SCRATCH" or "PERSISTENT". Note that persistent disks must be created before you can specify them here.
- "source": "A String", # Persistent disk only; the URL of the persistent disk resource.
+ "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
+ "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks.
},
],
- "scheduling": { # Scheduling options for an Instance. # Scheduling options for the instances created based on this template.
- "automaticRestart": True or False, # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user).
- "onHostMaintenance": "A String", # How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance.
+ "scheduling": { # Sets the scheduling options for an Instance. # Scheduling options for the instances created based on this template.
+ "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user).
+ "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. The default behavior is MIGRATE. For more information, see Setting maintenance behavior.
},
"canIpForward": True or False, # Allows instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, say true. If unsure, leave this set to false.
"serviceAccounts": [ # A list of service accounts each with specified scopes, for which access tokens are to be made available to the instances created based on this template, through metadata queries.
@@ -446,22 +529,29 @@
"key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
},
],
- "kind": "compute#metadata", # Type of the resource.
- "fingerprint": "A String", # Fingerprint of this resource. A hash of the metadata's contents. This field is used for optimistic locking. An up-to-date metadata fingerprint must be provided in order to modify metadata.
+ "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
},
"networkInterfaces": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instances created based based on this template will have no external internet access.
{ # A network interface resource attached to an instance.
- "accessConfigs": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
+ "accessConfigs": [ # An array of configurations for this interface. Currently, <codeONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
{ # An access configuration attached to an instance's network interface.
- "kind": "compute#accessConfig", # Type of the resource.
- "type": "ONE_TO_ONE_NAT", # Type of configuration. Must be set to "ONE_TO_ONE_NAT". This configures port-for-port NAT to the internet.
+ "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
+ "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
"name": "A String", # Name of this access configuration.
- "natIP": "A String", # An external IP address associated with this instance. Specify an unused static IP address available to the project. If not specified, the external IP will be drawn from a shared ephemeral pool.
+ "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
},
],
- "networkIP": "A String", # An optional IPV4 internal network address assigned to the instance for this network interface (output only).
- "name": "A String", # Name of the network interface, determined by the server; for network devices, these are e.g. eth0, eth1, etc. (output only).
- "network": "A String", # URL of the network resource attached to this interface.
+ "networkIP": "A String", # [Output Only] An optional IPV4 internal network address assigned to the instance for this network interface.
+ "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
+ "network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
+ #
+ # global/networks/default
+ #
+ # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
+ # - projects/project/global/networks/network
+ # - global/networks/default
},
],
},
diff --git a/docs/dyn/compute_v1.instances.html b/docs/dyn/compute_v1.instances.html
index 15eb1f0..d210ac5 100644
--- a/docs/dyn/compute_v1.instances.html
+++ b/docs/dyn/compute_v1.instances.html
@@ -85,10 +85,10 @@
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#attachDisk">attachDisk(project, zone, instance, body)</a></code></p>
-<p class="firstline">Attaches a disk resource to an instance.</p>
+<p class="firstline">Attaches a Disk resource to an instance.</p>
<p class="toc_element">
<code><a href="#delete">delete(project, zone, instance)</a></code></p>
-<p class="firstline">Deletes the specified instance resource.</p>
+<p class="firstline">Deletes the specified Instance resource. For more information, see Shutting down an instance.</p>
<p class="toc_element">
<code><a href="#deleteAccessConfig">deleteAccessConfig(project, zone, instance, accessConfig, networkInterface)</a></code></p>
<p class="firstline">Deletes an access config from an instance's network interface.</p>
@@ -115,7 +115,7 @@
<p class="firstline">Performs a hard reset on the instance.</p>
<p class="toc_element">
<code><a href="#setDiskAutoDelete">setDiskAutoDelete(project, zone, instance, autoDelete, deviceName)</a></code></p>
-<p class="firstline">Sets the auto-delete flag for a disk attached to an instance</p>
+<p class="firstline">Sets the auto-delete flag for a disk attached to an instance.</p>
<p class="toc_element">
<code><a href="#setMetadata">setMetadata(project, zone, instance, body)</a></code></p>
<p class="firstline">Sets metadata for the specified instance to the data included in the request.</p>
@@ -127,28 +127,28 @@
<p class="firstline">Sets tags for the specified instance to the data included in the request.</p>
<p class="toc_element">
<code><a href="#start">start(project, zone, instance)</a></code></p>
-<p class="firstline">Starts an instance</p>
+<p class="firstline">This method starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance.</p>
<p class="toc_element">
<code><a href="#stop">stop(project, zone, instance)</a></code></p>
-<p class="firstline">Stops an instance</p>
+<p class="firstline">This method stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur per-minute, virtual machine usage charges while they are stopped, but any resources that the virtual machine is using, such as persistent disks and static IP addresses,will continue to be charged until they are deleted. For more information, see Stopping an instance.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="addAccessConfig">addAccessConfig(project, zone, instance, networkInterface, body)</code>
<pre>Adds an access config to an instance's network interface.
Args:
- project: string, Project name. (required)
- zone: string, Name of the zone scoping this request. (required)
- instance: string, Instance name. (required)
- networkInterface: string, Network interface name. (required)
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ instance: string, The instance name for this request. (required)
+ networkInterface: string, The name of the network interface to add to this instance. (required)
body: object, The request body. (required)
The object takes the form of:
{ # An access configuration attached to an instance's network interface.
- "kind": "compute#accessConfig", # Type of the resource.
- "type": "ONE_TO_ONE_NAT", # Type of configuration. Must be set to "ONE_TO_ONE_NAT". This configures port-for-port NAT to the internet.
+ "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
+ "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
"name": "A String", # Name of this access configuration.
- "natIP": "A String", # An external IP address associated with this instance. Specify an unused static IP address available to the project. If not specified, the external IP will be drawn from a shared ephemeral pool.
+ "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
}
@@ -156,36 +156,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -194,9 +194,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -205,7 +205,7 @@
<pre>A description of how to use this function
Args:
- project: string, Name of the project scoping this request. (required)
+ project: string, Project ID for this request. (required)
maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
filter: string, Optional. Filter expression for filtering listed resources.
@@ -214,52 +214,77 @@
An object of the form:
{
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": { # A map of scoped instance lists.
+ "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+ "items": { # [Output Only] A map of scoped instance lists.
"a_key": { # Name of the scope containing this set of instances.
- "instances": [ # List of instances contained in this scope.
- { # An instance resource.
- "status": "A String", # Instance status. One of the following values: "PROVISIONING", "STAGING", "RUNNING", "STOPPING", "STOPPED", "TERMINATED" (output only).
- "kind": "compute#instance", # Type of the resource.
- "canIpForward": True or False, # Allows this instance to send packets with source IP addresses other than its own and receive packets with destination IP addresses other than its own. If this instance will be used as an IP gateway or it will be set as the next-hop in a Route resource, say true. If unsure, leave this set to false.
+ "instances": [ # [Output Only] List of instances contained in this scope.
+ { # An Instance resource.
+ "status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, STOPPED, TERMINATED.
+ "kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.
+ "canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "zone": "A String", # URL of the zone where the instance resides (output only).
- "tags": { # A set of instance tags. # A list of tags to be applied to this instance. Used to identify valid sources or targets for network firewalls. Provided by the client on instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
+ "zone": "A String", # [Output Only] URL of the zone where the instance resides.
+ "tags": { # A set of instance tags. # A list of tags to appy to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
"A String",
],
- "fingerprint": "A String", # Fingerprint of this resource. A hash of the tags stored in this object. This field is used optimistic locking. An up-to-date tags fingerprint must be provided in order to modify tags.
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+ #
+ # To see the latest fingerprint, make get() request to the instance.
},
"disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
{ # An instance-attached disk resource.
- "deviceName": "A String", # Persistent disk only; must be unique within the instance when specified. This represents a unique device name that is reflected into the /dev/ tree of a Linux operating system running within the instance. If not specified, a default will be chosen by the system.
- "kind": "compute#attachedDisk", # Type of the resource.
- "initializeParams": { # Initialization parameters for the new disk (input-only). Can only be specified on the boot disk or local SSDs. Mutually exclusive with 'source'. # Initialization parameters.
- "diskSizeGb": "A String", # Size of the disk in base-2 GB.
- "diskName": "A String", # Name of the disk (when not provided defaults to the name of the instance).
- "sourceImage": "A String", # The source image used to create this disk.
- "diskType": "A String", # URL of the disk type resource describing which disk type to use to create the disk; provided by the client when the disk is created.
+ "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/ tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
+ #
+ # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
+ "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
+ "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
+ "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
+ "sourceImage": "A String", # A source image used to create the disk. You can provide a private (custom) image, and Compute Engine will use the corresponding image from your project. For example:
+ #
+ # global/images/my-private-image
+ #
+ # Or you can provide an image from a publicly-available project. For example, to use a Debian image from the debian-cloud project, make sure to include the project in the URL:
+ #
+ # projects/debian-cloud/global/images/debian-7-wheezy-vYYYYMMDD
+ #
+ # where vYYYYMMDD is the image version. The fully-qualified URL will also work in both cases.
+ "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
+ #
+ # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+ #
+ # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+ # - projects/project/zones/zone/diskTypes/diskType
+ # - zones/zone/diskTypes/diskType
},
- "autoDelete": True or False, # Whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
- "index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, the server will choose an appropriate value (output only).
- "boot": True or False, # Indicates that this is a boot disk. VM will use the first partition of the disk for its root filesystem.
- "licenses": [ # Public visible licenses.
+ "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
+ "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
+ "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
+ "licenses": [ # [Output Only] Any valid publicly visible licenses.
"A String",
],
- "mode": "A String", # The mode in which to attach this disk, either "READ_WRITE" or "READ_ONLY".
+ "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
"interface": "A String",
- "type": "A String", # Type of the disk, either "SCRATCH" or "PERSISTENT". Note that persistent disks must be created before you can specify them here.
- "source": "A String", # Persistent disk only; the URL of the persistent disk resource.
+ "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
+ "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks.
},
],
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- "statusMessage": "A String", # An optional, human-readable explanation of the status (output only).
- "scheduling": { # Scheduling options for an Instance. # Scheduling options for this instance.
- "automaticRestart": True or False, # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user).
- "onHostMaintenance": "A String", # How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance.
+ "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
+ "scheduling": { # Sets the scheduling options for an Instance. # Scheduling options for this instance.
+ "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user).
+ "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. The default behavior is MIGRATE. For more information, see Setting maintenance behavior.
},
- "machineType": "A String", # URL of the machine type resource describing which machine type to use to host the instance; provided by the client when the instance is created.
- "serviceAccounts": [ # A list of service accounts each with specified scopes, for which access tokens are to be made available to the instance through metadata queries.
+ "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance. This is provided by the client when the instance is created. For example, the following is a valid partial url:
+ #
+ # zones/zone/machineTypes/machine-type
+ "serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Authenticating from Google Compute Engine for more information.
{ # A service account.
"scopes": [ # The list of scopes to be made available for this service account.
"A String",
@@ -267,51 +292,58 @@
"email": "A String", # Email address of the service account.
},
],
- "networkInterfaces": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
+ "networkInterfaces": [ # An array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet.
{ # A network interface resource attached to an instance.
- "accessConfigs": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
+ "accessConfigs": [ # An array of configurations for this interface. Currently, <codeONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
{ # An access configuration attached to an instance's network interface.
- "kind": "compute#accessConfig", # Type of the resource.
- "type": "ONE_TO_ONE_NAT", # Type of configuration. Must be set to "ONE_TO_ONE_NAT". This configures port-for-port NAT to the internet.
+ "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
+ "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
"name": "A String", # Name of this access configuration.
- "natIP": "A String", # An external IP address associated with this instance. Specify an unused static IP address available to the project. If not specified, the external IP will be drawn from a shared ephemeral pool.
+ "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
},
],
- "networkIP": "A String", # An optional IPV4 internal network address assigned to the instance for this network interface (output only).
- "name": "A String", # Name of the network interface, determined by the server; for network devices, these are e.g. eth0, eth1, etc. (output only).
- "network": "A String", # URL of the network resource attached to this interface.
+ "networkIP": "A String", # [Output Only] An optional IPV4 internal network address assigned to the instance for this network interface.
+ "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
+ "network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
+ #
+ # global/networks/default
+ #
+ # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
+ # - projects/project/global/networks/network
+ # - global/networks/default
},
],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- "metadata": { # A metadata key/value entry. # Metadata key/value pairs assigned to this instance. Consists of custom metadata or predefined keys; see Instance documentation for more information.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for this resource.
+ "metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.
"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
{
"value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes.
"key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
},
],
- "kind": "compute#metadata", # Type of the resource.
- "fingerprint": "A String", # Fingerprint of this resource. A hash of the metadata's contents. This field is used for optimistic locking. An up-to-date metadata fingerprint must be provided in order to modify metadata.
+ "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
},
},
],
- "warning": { # Informational warning which replaces the list of instances when the list is empty.
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "warning": { # [Output Only] Informational warning which replaces the list of instances when the list is empty.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
},
},
- "kind": "compute#instanceAggregatedList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
+ "kind": "compute#instanceAggregatedList", # [Output Only] Type of resource. Always compute#instanceAggregatedList for aggregated lists of Instance resources.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for this resource.
}</pre>
</div>
@@ -331,34 +363,55 @@
<div class="method">
<code class="details" id="attachDisk">attachDisk(project, zone, instance, body)</code>
- <pre>Attaches a disk resource to an instance.
+ <pre>Attaches a Disk resource to an instance.
Args:
- project: string, Project name. (required)
- zone: string, Name of the zone scoping this request. (required)
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
instance: string, Instance name. (required)
body: object, The request body. (required)
The object takes the form of:
{ # An instance-attached disk resource.
- "deviceName": "A String", # Persistent disk only; must be unique within the instance when specified. This represents a unique device name that is reflected into the /dev/ tree of a Linux operating system running within the instance. If not specified, a default will be chosen by the system.
- "kind": "compute#attachedDisk", # Type of the resource.
- "initializeParams": { # Initialization parameters for the new disk (input-only). Can only be specified on the boot disk or local SSDs. Mutually exclusive with 'source'. # Initialization parameters.
- "diskSizeGb": "A String", # Size of the disk in base-2 GB.
- "diskName": "A String", # Name of the disk (when not provided defaults to the name of the instance).
- "sourceImage": "A String", # The source image used to create this disk.
- "diskType": "A String", # URL of the disk type resource describing which disk type to use to create the disk; provided by the client when the disk is created.
+ "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/ tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
+ #
+ # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
+ "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
+ "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
+ "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
+ "sourceImage": "A String", # A source image used to create the disk. You can provide a private (custom) image, and Compute Engine will use the corresponding image from your project. For example:
+ #
+ # global/images/my-private-image
+ #
+ # Or you can provide an image from a publicly-available project. For example, to use a Debian image from the debian-cloud project, make sure to include the project in the URL:
+ #
+ # projects/debian-cloud/global/images/debian-7-wheezy-vYYYYMMDD
+ #
+ # where vYYYYMMDD is the image version. The fully-qualified URL will also work in both cases.
+ "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
+ #
+ # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+ #
+ # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+ # - projects/project/zones/zone/diskTypes/diskType
+ # - zones/zone/diskTypes/diskType
},
- "autoDelete": True or False, # Whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
- "index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, the server will choose an appropriate value (output only).
- "boot": True or False, # Indicates that this is a boot disk. VM will use the first partition of the disk for its root filesystem.
- "licenses": [ # Public visible licenses.
+ "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
+ "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
+ "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
+ "licenses": [ # [Output Only] Any valid publicly visible licenses.
"A String",
],
- "mode": "A String", # The mode in which to attach this disk, either "READ_WRITE" or "READ_ONLY".
+ "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
"interface": "A String",
- "type": "A String", # Type of the disk, either "SCRATCH" or "PERSISTENT". Note that persistent disks must be created before you can specify them here.
- "source": "A String", # Persistent disk only; the URL of the persistent disk resource.
+ "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
+ "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks.
}
@@ -366,36 +419,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -404,55 +457,55 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(project, zone, instance)</code>
- <pre>Deletes the specified instance resource.
+ <pre>Deletes the specified Instance resource. For more information, see Shutting down an instance.
Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
instance: string, Name of the instance resource to delete. (required)
Returns:
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -461,9 +514,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -472,46 +525,46 @@
<pre>Deletes an access config from an instance's network interface.
Args:
- project: string, Project name. (required)
- zone: string, Name of the zone scoping this request. (required)
- instance: string, Instance name. (required)
- accessConfig: string, Access config name. (required)
- networkInterface: string, Network interface name. (required)
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ instance: string, The instance name for this request. (required)
+ accessConfig: string, The name of the access config to delete. (required)
+ networkInterface: string, The name of the network interface. (required)
Returns:
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -520,9 +573,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -531,8 +584,8 @@
<pre>Detaches a disk from an instance.
Args:
- project: string, Project name. (required)
- zone: string, Name of the zone scoping this request. (required)
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
instance: string, Instance name. (required)
deviceName: string, Disk device name to detach. (required)
@@ -540,36 +593,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -578,9 +631,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -589,55 +642,80 @@
<pre>Returns the specified instance resource.
Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the The name of the zone for this request.. (required)
instance: string, Name of the instance resource to return. (required)
Returns:
An object of the form:
- { # An instance resource.
- "status": "A String", # Instance status. One of the following values: "PROVISIONING", "STAGING", "RUNNING", "STOPPING", "STOPPED", "TERMINATED" (output only).
- "kind": "compute#instance", # Type of the resource.
- "canIpForward": True or False, # Allows this instance to send packets with source IP addresses other than its own and receive packets with destination IP addresses other than its own. If this instance will be used as an IP gateway or it will be set as the next-hop in a Route resource, say true. If unsure, leave this set to false.
+ { # An Instance resource.
+ "status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, STOPPED, TERMINATED.
+ "kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.
+ "canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "zone": "A String", # URL of the zone where the instance resides (output only).
- "tags": { # A set of instance tags. # A list of tags to be applied to this instance. Used to identify valid sources or targets for network firewalls. Provided by the client on instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
+ "zone": "A String", # [Output Only] URL of the zone where the instance resides.
+ "tags": { # A set of instance tags. # A list of tags to appy to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
"A String",
],
- "fingerprint": "A String", # Fingerprint of this resource. A hash of the tags stored in this object. This field is used optimistic locking. An up-to-date tags fingerprint must be provided in order to modify tags.
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+ #
+ # To see the latest fingerprint, make get() request to the instance.
},
"disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
{ # An instance-attached disk resource.
- "deviceName": "A String", # Persistent disk only; must be unique within the instance when specified. This represents a unique device name that is reflected into the /dev/ tree of a Linux operating system running within the instance. If not specified, a default will be chosen by the system.
- "kind": "compute#attachedDisk", # Type of the resource.
- "initializeParams": { # Initialization parameters for the new disk (input-only). Can only be specified on the boot disk or local SSDs. Mutually exclusive with 'source'. # Initialization parameters.
- "diskSizeGb": "A String", # Size of the disk in base-2 GB.
- "diskName": "A String", # Name of the disk (when not provided defaults to the name of the instance).
- "sourceImage": "A String", # The source image used to create this disk.
- "diskType": "A String", # URL of the disk type resource describing which disk type to use to create the disk; provided by the client when the disk is created.
+ "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/ tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
+ #
+ # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
+ "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
+ "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
+ "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
+ "sourceImage": "A String", # A source image used to create the disk. You can provide a private (custom) image, and Compute Engine will use the corresponding image from your project. For example:
+ #
+ # global/images/my-private-image
+ #
+ # Or you can provide an image from a publicly-available project. For example, to use a Debian image from the debian-cloud project, make sure to include the project in the URL:
+ #
+ # projects/debian-cloud/global/images/debian-7-wheezy-vYYYYMMDD
+ #
+ # where vYYYYMMDD is the image version. The fully-qualified URL will also work in both cases.
+ "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
+ #
+ # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+ #
+ # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+ # - projects/project/zones/zone/diskTypes/diskType
+ # - zones/zone/diskTypes/diskType
},
- "autoDelete": True or False, # Whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
- "index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, the server will choose an appropriate value (output only).
- "boot": True or False, # Indicates that this is a boot disk. VM will use the first partition of the disk for its root filesystem.
- "licenses": [ # Public visible licenses.
+ "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
+ "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
+ "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
+ "licenses": [ # [Output Only] Any valid publicly visible licenses.
"A String",
],
- "mode": "A String", # The mode in which to attach this disk, either "READ_WRITE" or "READ_ONLY".
+ "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
"interface": "A String",
- "type": "A String", # Type of the disk, either "SCRATCH" or "PERSISTENT". Note that persistent disks must be created before you can specify them here.
- "source": "A String", # Persistent disk only; the URL of the persistent disk resource.
+ "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
+ "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks.
},
],
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- "statusMessage": "A String", # An optional, human-readable explanation of the status (output only).
- "scheduling": { # Scheduling options for an Instance. # Scheduling options for this instance.
- "automaticRestart": True or False, # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user).
- "onHostMaintenance": "A String", # How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance.
+ "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
+ "scheduling": { # Sets the scheduling options for an Instance. # Scheduling options for this instance.
+ "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user).
+ "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. The default behavior is MIGRATE. For more information, see Setting maintenance behavior.
},
- "machineType": "A String", # URL of the machine type resource describing which machine type to use to host the instance; provided by the client when the instance is created.
- "serviceAccounts": [ # A list of service accounts each with specified scopes, for which access tokens are to be made available to the instance through metadata queries.
+ "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance. This is provided by the client when the instance is created. For example, the following is a valid partial url:
+ #
+ # zones/zone/machineTypes/machine-type
+ "serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Authenticating from Google Compute Engine for more information.
{ # A service account.
"scopes": [ # The list of scopes to be made available for this service account.
"A String",
@@ -645,33 +723,40 @@
"email": "A String", # Email address of the service account.
},
],
- "networkInterfaces": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
+ "networkInterfaces": [ # An array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet.
{ # A network interface resource attached to an instance.
- "accessConfigs": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
+ "accessConfigs": [ # An array of configurations for this interface. Currently, <codeONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
{ # An access configuration attached to an instance's network interface.
- "kind": "compute#accessConfig", # Type of the resource.
- "type": "ONE_TO_ONE_NAT", # Type of configuration. Must be set to "ONE_TO_ONE_NAT". This configures port-for-port NAT to the internet.
+ "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
+ "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
"name": "A String", # Name of this access configuration.
- "natIP": "A String", # An external IP address associated with this instance. Specify an unused static IP address available to the project. If not specified, the external IP will be drawn from a shared ephemeral pool.
+ "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
},
],
- "networkIP": "A String", # An optional IPV4 internal network address assigned to the instance for this network interface (output only).
- "name": "A String", # Name of the network interface, determined by the server; for network devices, these are e.g. eth0, eth1, etc. (output only).
- "network": "A String", # URL of the network resource attached to this interface.
+ "networkIP": "A String", # [Output Only] An optional IPV4 internal network address assigned to the instance for this network interface.
+ "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
+ "network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
+ #
+ # global/networks/default
+ #
+ # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
+ # - projects/project/global/networks/network
+ # - global/networks/default
},
],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- "metadata": { # A metadata key/value entry. # Metadata key/value pairs assigned to this instance. Consists of custom metadata or predefined keys; see Instance documentation for more information.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for this resource.
+ "metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.
"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
{
"value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes.
"key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
},
],
- "kind": "compute#metadata", # Type of the resource.
- "fingerprint": "A String", # Fingerprint of this resource. A hash of the metadata's contents. This field is used for optimistic locking. An up-to-date metadata fingerprint must be provided in order to modify metadata.
+ "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
},
}</pre>
</div>
@@ -681,17 +766,17 @@
<pre>Returns the specified instance's serial port output.
Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
instance: string, Name of the instance scoping this request. (required)
Returns:
An object of the form:
- { # An instance serial console output.
- "kind": "compute#serialPortOutput", # Type of the resource.
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "contents": "A String", # The contents of the console output.
+ { # An instance's serial console output.
+ "kind": "compute#serialPortOutput", # [Output Only] Type of the resource. Always compute#serialPortOutput for serial port output.
+ "selfLink": "A String", # [Output Only] Server defined URL for the resource.
+ "contents": "A String", # [Output Only] The contents of the console output.
}</pre>
</div>
@@ -700,53 +785,78 @@
<pre>Creates an instance resource in the specified project using the data included in the request.
Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
body: object, The request body. (required)
The object takes the form of:
-{ # An instance resource.
- "status": "A String", # Instance status. One of the following values: "PROVISIONING", "STAGING", "RUNNING", "STOPPING", "STOPPED", "TERMINATED" (output only).
- "kind": "compute#instance", # Type of the resource.
- "canIpForward": True or False, # Allows this instance to send packets with source IP addresses other than its own and receive packets with destination IP addresses other than its own. If this instance will be used as an IP gateway or it will be set as the next-hop in a Route resource, say true. If unsure, leave this set to false.
+{ # An Instance resource.
+ "status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, STOPPED, TERMINATED.
+ "kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.
+ "canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "zone": "A String", # URL of the zone where the instance resides (output only).
- "tags": { # A set of instance tags. # A list of tags to be applied to this instance. Used to identify valid sources or targets for network firewalls. Provided by the client on instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
+ "zone": "A String", # [Output Only] URL of the zone where the instance resides.
+ "tags": { # A set of instance tags. # A list of tags to appy to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
"A String",
],
- "fingerprint": "A String", # Fingerprint of this resource. A hash of the tags stored in this object. This field is used optimistic locking. An up-to-date tags fingerprint must be provided in order to modify tags.
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+ #
+ # To see the latest fingerprint, make get() request to the instance.
},
"disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
{ # An instance-attached disk resource.
- "deviceName": "A String", # Persistent disk only; must be unique within the instance when specified. This represents a unique device name that is reflected into the /dev/ tree of a Linux operating system running within the instance. If not specified, a default will be chosen by the system.
- "kind": "compute#attachedDisk", # Type of the resource.
- "initializeParams": { # Initialization parameters for the new disk (input-only). Can only be specified on the boot disk or local SSDs. Mutually exclusive with 'source'. # Initialization parameters.
- "diskSizeGb": "A String", # Size of the disk in base-2 GB.
- "diskName": "A String", # Name of the disk (when not provided defaults to the name of the instance).
- "sourceImage": "A String", # The source image used to create this disk.
- "diskType": "A String", # URL of the disk type resource describing which disk type to use to create the disk; provided by the client when the disk is created.
+ "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/ tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
+ #
+ # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
+ "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
+ "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
+ "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
+ "sourceImage": "A String", # A source image used to create the disk. You can provide a private (custom) image, and Compute Engine will use the corresponding image from your project. For example:
+ #
+ # global/images/my-private-image
+ #
+ # Or you can provide an image from a publicly-available project. For example, to use a Debian image from the debian-cloud project, make sure to include the project in the URL:
+ #
+ # projects/debian-cloud/global/images/debian-7-wheezy-vYYYYMMDD
+ #
+ # where vYYYYMMDD is the image version. The fully-qualified URL will also work in both cases.
+ "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
+ #
+ # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+ #
+ # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+ # - projects/project/zones/zone/diskTypes/diskType
+ # - zones/zone/diskTypes/diskType
},
- "autoDelete": True or False, # Whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
- "index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, the server will choose an appropriate value (output only).
- "boot": True or False, # Indicates that this is a boot disk. VM will use the first partition of the disk for its root filesystem.
- "licenses": [ # Public visible licenses.
+ "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
+ "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
+ "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
+ "licenses": [ # [Output Only] Any valid publicly visible licenses.
"A String",
],
- "mode": "A String", # The mode in which to attach this disk, either "READ_WRITE" or "READ_ONLY".
+ "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
"interface": "A String",
- "type": "A String", # Type of the disk, either "SCRATCH" or "PERSISTENT". Note that persistent disks must be created before you can specify them here.
- "source": "A String", # Persistent disk only; the URL of the persistent disk resource.
+ "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
+ "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks.
},
],
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- "statusMessage": "A String", # An optional, human-readable explanation of the status (output only).
- "scheduling": { # Scheduling options for an Instance. # Scheduling options for this instance.
- "automaticRestart": True or False, # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user).
- "onHostMaintenance": "A String", # How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance.
+ "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
+ "scheduling": { # Sets the scheduling options for an Instance. # Scheduling options for this instance.
+ "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user).
+ "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. The default behavior is MIGRATE. For more information, see Setting maintenance behavior.
},
- "machineType": "A String", # URL of the machine type resource describing which machine type to use to host the instance; provided by the client when the instance is created.
- "serviceAccounts": [ # A list of service accounts each with specified scopes, for which access tokens are to be made available to the instance through metadata queries.
+ "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance. This is provided by the client when the instance is created. For example, the following is a valid partial url:
+ #
+ # zones/zone/machineTypes/machine-type
+ "serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Authenticating from Google Compute Engine for more information.
{ # A service account.
"scopes": [ # The list of scopes to be made available for this service account.
"A String",
@@ -754,33 +864,40 @@
"email": "A String", # Email address of the service account.
},
],
- "networkInterfaces": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
+ "networkInterfaces": [ # An array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet.
{ # A network interface resource attached to an instance.
- "accessConfigs": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
+ "accessConfigs": [ # An array of configurations for this interface. Currently, <codeONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
{ # An access configuration attached to an instance's network interface.
- "kind": "compute#accessConfig", # Type of the resource.
- "type": "ONE_TO_ONE_NAT", # Type of configuration. Must be set to "ONE_TO_ONE_NAT". This configures port-for-port NAT to the internet.
+ "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
+ "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
"name": "A String", # Name of this access configuration.
- "natIP": "A String", # An external IP address associated with this instance. Specify an unused static IP address available to the project. If not specified, the external IP will be drawn from a shared ephemeral pool.
+ "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
},
],
- "networkIP": "A String", # An optional IPV4 internal network address assigned to the instance for this network interface (output only).
- "name": "A String", # Name of the network interface, determined by the server; for network devices, these are e.g. eth0, eth1, etc. (output only).
- "network": "A String", # URL of the network resource attached to this interface.
+ "networkIP": "A String", # [Output Only] An optional IPV4 internal network address assigned to the instance for this network interface.
+ "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
+ "network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
+ #
+ # global/networks/default
+ #
+ # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
+ # - projects/project/global/networks/network
+ # - global/networks/default
},
],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- "metadata": { # A metadata key/value entry. # Metadata key/value pairs assigned to this instance. Consists of custom metadata or predefined keys; see Instance documentation for more information.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for this resource.
+ "metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.
"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
{
"value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes.
"key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
},
],
- "kind": "compute#metadata", # Type of the resource.
- "fingerprint": "A String", # Fingerprint of this resource. A hash of the metadata's contents. This field is used for optimistic locking. An up-to-date metadata fingerprint must be provided in order to modify metadata.
+ "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
},
}
@@ -789,36 +906,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -827,9 +944,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -838,8 +955,8 @@
<pre>Retrieves the list of instance resources contained within the specified zone.
Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
filter: string, Optional. Filter expression for filtering listed resources.
@@ -848,50 +965,75 @@
An object of the form:
{ # Contains a list of instance resources.
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # A list of Instance resources.
- { # An instance resource.
- "status": "A String", # Instance status. One of the following values: "PROVISIONING", "STAGING", "RUNNING", "STOPPING", "STOPPED", "TERMINATED" (output only).
- "kind": "compute#instance", # Type of the resource.
- "canIpForward": True or False, # Allows this instance to send packets with source IP addresses other than its own and receive packets with destination IP addresses other than its own. If this instance will be used as an IP gateway or it will be set as the next-hop in a Route resource, say true. If unsure, leave this set to false.
+ "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+ "items": [ # [Output Only] A list of Instance resources.
+ { # An Instance resource.
+ "status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, STOPPED, TERMINATED.
+ "kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.
+ "canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "zone": "A String", # URL of the zone where the instance resides (output only).
- "tags": { # A set of instance tags. # A list of tags to be applied to this instance. Used to identify valid sources or targets for network firewalls. Provided by the client on instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
+ "zone": "A String", # [Output Only] URL of the zone where the instance resides.
+ "tags": { # A set of instance tags. # A list of tags to appy to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
"A String",
],
- "fingerprint": "A String", # Fingerprint of this resource. A hash of the tags stored in this object. This field is used optimistic locking. An up-to-date tags fingerprint must be provided in order to modify tags.
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+ #
+ # To see the latest fingerprint, make get() request to the instance.
},
"disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
{ # An instance-attached disk resource.
- "deviceName": "A String", # Persistent disk only; must be unique within the instance when specified. This represents a unique device name that is reflected into the /dev/ tree of a Linux operating system running within the instance. If not specified, a default will be chosen by the system.
- "kind": "compute#attachedDisk", # Type of the resource.
- "initializeParams": { # Initialization parameters for the new disk (input-only). Can only be specified on the boot disk or local SSDs. Mutually exclusive with 'source'. # Initialization parameters.
- "diskSizeGb": "A String", # Size of the disk in base-2 GB.
- "diskName": "A String", # Name of the disk (when not provided defaults to the name of the instance).
- "sourceImage": "A String", # The source image used to create this disk.
- "diskType": "A String", # URL of the disk type resource describing which disk type to use to create the disk; provided by the client when the disk is created.
+ "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/ tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
+ #
+ # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
+ "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
+ "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
+ "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
+ "sourceImage": "A String", # A source image used to create the disk. You can provide a private (custom) image, and Compute Engine will use the corresponding image from your project. For example:
+ #
+ # global/images/my-private-image
+ #
+ # Or you can provide an image from a publicly-available project. For example, to use a Debian image from the debian-cloud project, make sure to include the project in the URL:
+ #
+ # projects/debian-cloud/global/images/debian-7-wheezy-vYYYYMMDD
+ #
+ # where vYYYYMMDD is the image version. The fully-qualified URL will also work in both cases.
+ "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
+ #
+ # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+ #
+ # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+ # - projects/project/zones/zone/diskTypes/diskType
+ # - zones/zone/diskTypes/diskType
},
- "autoDelete": True or False, # Whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
- "index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, the server will choose an appropriate value (output only).
- "boot": True or False, # Indicates that this is a boot disk. VM will use the first partition of the disk for its root filesystem.
- "licenses": [ # Public visible licenses.
+ "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
+ "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
+ "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
+ "licenses": [ # [Output Only] Any valid publicly visible licenses.
"A String",
],
- "mode": "A String", # The mode in which to attach this disk, either "READ_WRITE" or "READ_ONLY".
+ "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
"interface": "A String",
- "type": "A String", # Type of the disk, either "SCRATCH" or "PERSISTENT". Note that persistent disks must be created before you can specify them here.
- "source": "A String", # Persistent disk only; the URL of the persistent disk resource.
+ "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
+ "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks.
},
],
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- "statusMessage": "A String", # An optional, human-readable explanation of the status (output only).
- "scheduling": { # Scheduling options for an Instance. # Scheduling options for this instance.
- "automaticRestart": True or False, # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user).
- "onHostMaintenance": "A String", # How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance.
+ "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
+ "scheduling": { # Sets the scheduling options for an Instance. # Scheduling options for this instance.
+ "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user).
+ "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. The default behavior is MIGRATE. For more information, see Setting maintenance behavior.
},
- "machineType": "A String", # URL of the machine type resource describing which machine type to use to host the instance; provided by the client when the instance is created.
- "serviceAccounts": [ # A list of service accounts each with specified scopes, for which access tokens are to be made available to the instance through metadata queries.
+ "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance. This is provided by the client when the instance is created. For example, the following is a valid partial url:
+ #
+ # zones/zone/machineTypes/machine-type
+ "serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Authenticating from Google Compute Engine for more information.
{ # A service account.
"scopes": [ # The list of scopes to be made available for this service account.
"A String",
@@ -899,39 +1041,46 @@
"email": "A String", # Email address of the service account.
},
],
- "networkInterfaces": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
+ "networkInterfaces": [ # An array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet.
{ # A network interface resource attached to an instance.
- "accessConfigs": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
+ "accessConfigs": [ # An array of configurations for this interface. Currently, <codeONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
{ # An access configuration attached to an instance's network interface.
- "kind": "compute#accessConfig", # Type of the resource.
- "type": "ONE_TO_ONE_NAT", # Type of configuration. Must be set to "ONE_TO_ONE_NAT". This configures port-for-port NAT to the internet.
+ "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
+ "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
"name": "A String", # Name of this access configuration.
- "natIP": "A String", # An external IP address associated with this instance. Specify an unused static IP address available to the project. If not specified, the external IP will be drawn from a shared ephemeral pool.
+ "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
},
],
- "networkIP": "A String", # An optional IPV4 internal network address assigned to the instance for this network interface (output only).
- "name": "A String", # Name of the network interface, determined by the server; for network devices, these are e.g. eth0, eth1, etc. (output only).
- "network": "A String", # URL of the network resource attached to this interface.
+ "networkIP": "A String", # [Output Only] An optional IPV4 internal network address assigned to the instance for this network interface.
+ "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
+ "network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
+ #
+ # global/networks/default
+ #
+ # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
+ # - projects/project/global/networks/network
+ # - global/networks/default
},
],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- "metadata": { # A metadata key/value entry. # Metadata key/value pairs assigned to this instance. Consists of custom metadata or predefined keys; see Instance documentation for more information.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for this resource.
+ "metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.
"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
{
"value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes.
"key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
},
],
- "kind": "compute#metadata", # Type of the resource.
- "fingerprint": "A String", # Fingerprint of this resource. A hash of the metadata's contents. This field is used for optimistic locking. An up-to-date metadata fingerprint must be provided in order to modify metadata.
+ "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
},
},
],
- "kind": "compute#instanceList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
+ "kind": "compute#instanceList", # [Output Only] Type of resource. Always compute#instanceList for lists of Instance resources.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for this resource.
}</pre>
</div>
@@ -954,44 +1103,44 @@
<pre>Performs a hard reset on the instance.
Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
instance: string, Name of the instance scoping this request. (required)
Returns:
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -1000,57 +1149,57 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
<div class="method">
<code class="details" id="setDiskAutoDelete">setDiskAutoDelete(project, zone, instance, autoDelete, deviceName)</code>
- <pre>Sets the auto-delete flag for a disk attached to an instance
+ <pre>Sets the auto-delete flag for a disk attached to an instance.
Args:
- project: string, Project name. (required)
- zone: string, Name of the zone scoping this request. (required)
- instance: string, Instance name. (required)
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ instance: string, The instance name. (required)
autoDelete: boolean, Whether to auto-delete the disk when the instance is deleted. (required)
- deviceName: string, Disk device name to modify. (required)
+ deviceName: string, The device name of the disk to modify. (required)
Returns:
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -1059,9 +1208,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -1070,8 +1219,8 @@
<pre>Sets metadata for the specified instance to the data included in the request.
Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
instance: string, Name of the instance scoping this request. (required)
body: object, The request body. (required)
The object takes the form of:
@@ -1083,8 +1232,8 @@
"key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
},
],
- "kind": "compute#metadata", # Type of the resource.
- "fingerprint": "A String", # Fingerprint of this resource. A hash of the metadata's contents. This field is used for optimistic locking. An up-to-date metadata fingerprint must be provided in order to modify metadata.
+ "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
}
@@ -1092,36 +1241,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -1130,9 +1279,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -1141,15 +1290,15 @@
<pre>Sets an instance's scheduling options.
Args:
- project: string, Project name. (required)
- zone: string, Name of the zone scoping this request. (required)
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
instance: string, Instance name. (required)
body: object, The request body. (required)
The object takes the form of:
-{ # Scheduling options for an Instance.
- "automaticRestart": True or False, # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user).
- "onHostMaintenance": "A String", # How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance.
+{ # Sets the scheduling options for an Instance.
+ "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user).
+ "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. The default behavior is MIGRATE. For more information, see Setting maintenance behavior.
}
@@ -1157,36 +1306,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -1195,9 +1344,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -1206,8 +1355,8 @@
<pre>Sets tags for the specified instance to the data included in the request.
Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
instance: string, Name of the instance scoping this request. (required)
body: object, The request body. (required)
The object takes the form of:
@@ -1216,7 +1365,9 @@
"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
"A String",
],
- "fingerprint": "A String", # Fingerprint of this resource. A hash of the tags stored in this object. This field is used optimistic locking. An up-to-date tags fingerprint must be provided in order to modify tags.
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+ #
+ # To see the latest fingerprint, make get() request to the instance.
}
@@ -1224,36 +1375,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -1262,55 +1413,55 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
<div class="method">
<code class="details" id="start">start(project, zone, instance)</code>
- <pre>Starts an instance
+ <pre>This method starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance.
Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
instance: string, Name of the instance resource to start. (required)
Returns:
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -1319,55 +1470,55 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
<div class="method">
<code class="details" id="stop">stop(project, zone, instance)</code>
- <pre>Stops an instance
+ <pre>This method stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur per-minute, virtual machine usage charges while they are stopped, but any resources that the virtual machine is using, such as persistent disks and static IP addresses,will continue to be charged until they are deleted. For more information, see Stopping an instance.
Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
instance: string, Name of the instance resource to start. (required)
Returns:
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -1376,9 +1527,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
diff --git a/docs/dyn/compute_v1.licenses.html b/docs/dyn/compute_v1.licenses.html
index cb62619..fbba2a3 100644
--- a/docs/dyn/compute_v1.licenses.html
+++ b/docs/dyn/compute_v1.licenses.html
@@ -83,7 +83,7 @@
<pre>Returns the specified license resource.
Args:
- project: string, Name of the project scoping this request. (required)
+ project: string, Project ID for this request. (required)
license: string, Name of the license resource to return. (required)
Returns:
@@ -91,9 +91,9 @@
{ # A license resource.
"chargesUseFee": True or False, # If true, the customer will be charged license fee for running software that contains this license on an instance.
- "kind": "compute#license", # Type of resource.
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- "selfLink": "A String", # Server defined URL for the resource (output only).
+ "kind": "compute#license", # [Output Only] Type of resource. Always compute#license for licenses.
+ "name": "A String", # Name of the resource. The name must be 1-63 characters long, and comply with RCF1035.
+ "selfLink": "A String", # [Output Only] Server defined URL for the resource.
}</pre>
</div>
diff --git a/docs/dyn/compute_v1.machineTypes.html b/docs/dyn/compute_v1.machineTypes.html
index 1998123..235d5c5 100644
--- a/docs/dyn/compute_v1.machineTypes.html
+++ b/docs/dyn/compute_v1.machineTypes.html
@@ -105,26 +105,26 @@
{
"nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
- "items": { # A map of scoped machine type lists.
- "a_key": { # Name of the scope containing this set of machine types.
- "machineTypes": [ # List of machine types contained in this scope.
- { # A machine type resource.
- "guestCpus": 42, # Count of CPUs exposed to the instance.
- "imageSpaceGb": 42, # Space allotted for the image, defined in GB.
+ "items": { # [Output Only] A map of scoped machine type lists.
+ "a_key": { # [Output Only] Name of the scope containing this set of machine types.
+ "machineTypes": [ # [Output Only] List of machine types contained in this scope.
+ { # A Machine Type resource.
+ "guestCpus": 42, # [Output Only] The tumber of CPUs exposed to the instance.
+ "imageSpaceGb": 42, # [Deprecated] This property is deprecated and will never be populated with any relevant values.
"kind": "compute#machineType", # Type of the resource.
- "maximumPersistentDisksSizeGb": "A String", # Maximum total persistent disks size (GB) allowed.
- "description": "A String", # An optional textual description of the resource.
+ "maximumPersistentDisksSizeGb": "A String", # [Output Only] Maximum total persistent disks size (GB) allowed.
+ "description": "A String", # [Output Only] An optional textual description of the resource.
"zone": "A String", # [Output Only] The name of the zone where the machine type resides, such as us-central1-a.
- "maximumPersistentDisks": 42, # Maximum persistent disks allowed.
- "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this machine type.
+ "maximumPersistentDisks": 42, # [Output Only] Maximum persistent disks allowed.
+ "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this machine type.
"deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
"deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
- "state": "A String", # The deprecation state. Can be "DEPRECATED", "OBSOLETE", or "DELETED". Operations which create a new resource using a "DEPRECATED" resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. New uses of "OBSOLETE" or "DELETED" resources will result in an error.
+ "state": "A String", # The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.
"obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
- "replacement": "A String", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
+ "replacement": "A String", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
},
- "memoryMb": 42, # Physical memory assigned to the instance, defined in MB.
- "scratchDisks": [ # List of extended scratch disks assigned to the instance.
+ "memoryMb": 42, # [Output Only] The amount of physical memory available to the instance, defined in MB.
+ "scratchDisks": [ # [Output Only] List of extended scratch disks assigned to the instance.
{
"diskGb": 42, # Size of the scratch disk, defined in GB.
},
@@ -132,24 +132,24 @@
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "name": "A String", # Name of the resource.
+ "name": "A String", # [Output Only] Name of the resource.
},
],
- "warning": { # An informational warning that appears when the machine types list is empty.
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "warning": { # [Output Only] An informational warning that appears when the machine types list is empty.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
},
},
- "kind": "compute#machineTypeAggregatedList", # Type of resource.
+ "kind": "compute#machineTypeAggregatedList", # [Output Only] Type of resource. Always compute#machineTypeAggregatedList for aggregated lists of machine types.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # Server defined URL for this resource (output only).
+ "selfLink": "A String", # [Output Only] Server defined URL for this resource.
}</pre>
</div>
@@ -173,29 +173,29 @@
Args:
project: string, Project ID for this request. (required)
- zone: string, Name of the zone scoping this request. (required)
+ zone: string, The name of the zone for this request. (required)
machineType: string, Name of the machine type resource to return. (required)
Returns:
An object of the form:
- { # A machine type resource.
- "guestCpus": 42, # Count of CPUs exposed to the instance.
- "imageSpaceGb": 42, # Space allotted for the image, defined in GB.
+ { # A Machine Type resource.
+ "guestCpus": 42, # [Output Only] The tumber of CPUs exposed to the instance.
+ "imageSpaceGb": 42, # [Deprecated] This property is deprecated and will never be populated with any relevant values.
"kind": "compute#machineType", # Type of the resource.
- "maximumPersistentDisksSizeGb": "A String", # Maximum total persistent disks size (GB) allowed.
- "description": "A String", # An optional textual description of the resource.
+ "maximumPersistentDisksSizeGb": "A String", # [Output Only] Maximum total persistent disks size (GB) allowed.
+ "description": "A String", # [Output Only] An optional textual description of the resource.
"zone": "A String", # [Output Only] The name of the zone where the machine type resides, such as us-central1-a.
- "maximumPersistentDisks": 42, # Maximum persistent disks allowed.
- "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this machine type.
+ "maximumPersistentDisks": 42, # [Output Only] Maximum persistent disks allowed.
+ "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this machine type.
"deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
"deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
- "state": "A String", # The deprecation state. Can be "DEPRECATED", "OBSOLETE", or "DELETED". Operations which create a new resource using a "DEPRECATED" resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. New uses of "OBSOLETE" or "DELETED" resources will result in an error.
+ "state": "A String", # The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.
"obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
- "replacement": "A String", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
+ "replacement": "A String", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
},
- "memoryMb": 42, # Physical memory assigned to the instance, defined in MB.
- "scratchDisks": [ # List of extended scratch disks assigned to the instance.
+ "memoryMb": 42, # [Output Only] The amount of physical memory available to the instance, defined in MB.
+ "scratchDisks": [ # [Output Only] List of extended scratch disks assigned to the instance.
{
"diskGb": 42, # Size of the scratch disk, defined in GB.
},
@@ -203,7 +203,7 @@
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "name": "A String", # Name of the resource.
+ "name": "A String", # [Output Only] Name of the resource.
}</pre>
</div>
@@ -213,7 +213,7 @@
Args:
project: string, Project ID for this request. (required)
- zone: string, Name of the zone scoping this request. (required)
+ zone: string, The name of the zone for this request. (required)
maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
filter: string, Optional. Filter expression for filtering listed resources.
@@ -221,26 +221,26 @@
Returns:
An object of the form:
- { # Contains a list of machine type resources.
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # A list of MachineType resources.
- { # A machine type resource.
- "guestCpus": 42, # Count of CPUs exposed to the instance.
- "imageSpaceGb": 42, # Space allotted for the image, defined in GB.
+ { # Contains a list of Machine Type resources.
+ "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+ "items": [ # [Output Only] A list of Machine Type resources.
+ { # A Machine Type resource.
+ "guestCpus": 42, # [Output Only] The tumber of CPUs exposed to the instance.
+ "imageSpaceGb": 42, # [Deprecated] This property is deprecated and will never be populated with any relevant values.
"kind": "compute#machineType", # Type of the resource.
- "maximumPersistentDisksSizeGb": "A String", # Maximum total persistent disks size (GB) allowed.
- "description": "A String", # An optional textual description of the resource.
+ "maximumPersistentDisksSizeGb": "A String", # [Output Only] Maximum total persistent disks size (GB) allowed.
+ "description": "A String", # [Output Only] An optional textual description of the resource.
"zone": "A String", # [Output Only] The name of the zone where the machine type resides, such as us-central1-a.
- "maximumPersistentDisks": 42, # Maximum persistent disks allowed.
- "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this machine type.
+ "maximumPersistentDisks": 42, # [Output Only] Maximum persistent disks allowed.
+ "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this machine type.
"deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
"deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
- "state": "A String", # The deprecation state. Can be "DEPRECATED", "OBSOLETE", or "DELETED". Operations which create a new resource using a "DEPRECATED" resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. New uses of "OBSOLETE" or "DELETED" resources will result in an error.
+ "state": "A String", # The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.
"obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
- "replacement": "A String", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
+ "replacement": "A String", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
},
- "memoryMb": 42, # Physical memory assigned to the instance, defined in MB.
- "scratchDisks": [ # List of extended scratch disks assigned to the instance.
+ "memoryMb": 42, # [Output Only] The amount of physical memory available to the instance, defined in MB.
+ "scratchDisks": [ # [Output Only] List of extended scratch disks assigned to the instance.
{
"diskGb": 42, # Size of the scratch disk, defined in GB.
},
@@ -248,12 +248,12 @@
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "name": "A String", # Name of the resource.
+ "name": "A String", # [Output Only] Name of the resource.
},
],
- "kind": "compute#machineTypeList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
+ "kind": "compute#machineTypeList", # [Output Only] Type of resource. Always compute#machineTypeList for lists of machine types.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for this resource.
}</pre>
</div>
diff --git a/docs/dyn/compute_v1.networks.html b/docs/dyn/compute_v1.networks.html
index e272d91..226e882 100644
--- a/docs/dyn/compute_v1.networks.html
+++ b/docs/dyn/compute_v1.networks.html
@@ -95,43 +95,43 @@
<pre>Deletes the specified network resource.
Args:
- project: string, Name of the project scoping this request. (required)
+ project: string, Project ID for this request. (required)
network: string, Name of the network resource to delete. (required)
Returns:
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -140,9 +140,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -151,21 +151,21 @@
<pre>Returns the specified network resource.
Args:
- project: string, Name of the project scoping this request. (required)
+ project: string, Project ID for this request. (required)
network: string, Name of the network resource to return. (required)
Returns:
An object of the form:
{ # A network resource.
- "kind": "compute#network", # Type of the resource.
+ "kind": "compute#network", # [Output Only] Type of the resource. Always compute#network for networks.
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "IPv4Range": "A String", # Required; The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created.
- "gatewayIPv4": "A String", # An optional address that is used for default routing to other networks. This must be within the range specified by IPv4Range, and is typically the first usable address in that range. If not specified, the default value is the first usable address in IPv4Range.
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
+ "IPv4Range": "A String", # The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created.
+ "gatewayIPv4": "A String", # A gateway address for default routing to other networks. This value is read only and is selected by the Google Compute Engine, typically as the first usable address in the IPv4Range.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for the resource.
+ "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
}</pre>
</div>
@@ -174,19 +174,19 @@
<pre>Creates a network resource in the specified project using the data included in the request.
Args:
- project: string, Name of the project scoping this request. (required)
+ project: string, Project ID for this request. (required)
body: object, The request body. (required)
The object takes the form of:
{ # A network resource.
- "kind": "compute#network", # Type of the resource.
+ "kind": "compute#network", # [Output Only] Type of the resource. Always compute#network for networks.
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "IPv4Range": "A String", # Required; The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created.
- "gatewayIPv4": "A String", # An optional address that is used for default routing to other networks. This must be within the range specified by IPv4Range, and is typically the first usable address in that range. If not specified, the default value is the first usable address in IPv4Range.
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
+ "IPv4Range": "A String", # The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created.
+ "gatewayIPv4": "A String", # A gateway address for default routing to other networks. This value is read only and is selected by the Google Compute Engine, typically as the first usable address in the IPv4Range.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for the resource.
+ "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
}
@@ -194,36 +194,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -232,9 +232,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -243,7 +243,7 @@
<pre>Retrieves the list of network resources available to the specified project.
Args:
- project: string, Name of the project scoping this request. (required)
+ project: string, Project ID for this request. (required)
maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
filter: string, Optional. Filter expression for filtering listed resources.
@@ -251,23 +251,23 @@
Returns:
An object of the form:
- { # Contains a list of network resources.
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # A list of Network resources.
+ { # Contains a list of Network resources.
+ "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+ "items": [ # [Output Only] A list of Network resources.
{ # A network resource.
- "kind": "compute#network", # Type of the resource.
+ "kind": "compute#network", # [Output Only] Type of the resource. Always compute#network for networks.
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "IPv4Range": "A String", # Required; The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created.
- "gatewayIPv4": "A String", # An optional address that is used for default routing to other networks. This must be within the range specified by IPv4Range, and is typically the first usable address in that range. If not specified, the default value is the first usable address in IPv4Range.
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
+ "IPv4Range": "A String", # The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created.
+ "gatewayIPv4": "A String", # A gateway address for default routing to other networks. This value is read only and is selected by the Google Compute Engine, typically as the first usable address in the IPv4Range.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for the resource.
+ "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
},
],
- "kind": "compute#networkList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
+ "kind": "compute#networkList", # [Output Only] Type of resource. Always compute#networkList for lists of networks.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for this resource .
}</pre>
</div>
diff --git a/docs/dyn/compute_v1.projects.html b/docs/dyn/compute_v1.projects.html
index deb7c09..e59c0f1 100644
--- a/docs/dyn/compute_v1.projects.html
+++ b/docs/dyn/compute_v1.projects.html
@@ -78,59 +78,191 @@
<code><a href="#get">get(project)</a></code></p>
<p class="firstline">Returns the specified project resource.</p>
<p class="toc_element">
+ <code><a href="#moveDisk">moveDisk(project, body)</a></code></p>
+<p class="firstline">Moves a persistent disk from one zone to another.</p>
+<p class="toc_element">
+ <code><a href="#moveInstance">moveInstance(project, body)</a></code></p>
+<p class="firstline">Moves an instance and its attached persistent disks from one zone to another.</p>
+<p class="toc_element">
<code><a href="#setCommonInstanceMetadata">setCommonInstanceMetadata(project, body)</a></code></p>
<p class="firstline">Sets metadata common to all instances within the specified project using the data included in the request.</p>
<p class="toc_element">
<code><a href="#setUsageExportBucket">setUsageExportBucket(project, body)</a></code></p>
-<p class="firstline">Sets usage export location</p>
+<p class="firstline">Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(project)</code>
<pre>Returns the specified project resource.
Args:
- project: string, Name of the project resource to retrieve. (required)
+ project: string, Project ID for this request. (required)
Returns:
An object of the form:
- { # A project resource. Projects can be created only in the APIs Console. Unless marked otherwise, values can only be modified in the console.
- "kind": "compute#project", # Type of the resource.
+ { # A Project resource. Projects can only be created in the Google Developers Console. Unless marked otherwise, values can only be modified in the console.
+ "kind": "compute#project", # [Output Only] Type of the resource. Always compute#project for projects.
"description": "A String", # An optional textual description of the resource.
- "commonInstanceMetadata": { # A metadata key/value entry. # Metadata key/value pairs available to all instances contained in this project.
+ "commonInstanceMetadata": { # A metadata key/value entry. # Metadata key/value pairs available to all instances contained in this project. See Custom metadata for more information.
"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
{
"value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes.
"key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
},
],
- "kind": "compute#metadata", # Type of the resource.
- "fingerprint": "A String", # Fingerprint of this resource. A hash of the metadata's contents. This field is used for optimistic locking. An up-to-date metadata fingerprint must be provided in order to modify metadata.
+ "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
},
- "quotas": [ # Quotas assigned to this project.
+ "quotas": [ # [Output Only] Quotas assigned to this project.
{ # A quotas entry.
- "usage": 3.14, # Current usage of this metric.
- "metric": "A String", # Name of the quota metric.
- "limit": 3.14, # Quota limit for this metric.
+ "usage": 3.14, # [Output Only] Current usage of this metric.
+ "metric": "A String", # [Output Only] Name of the quota metric.
+ "limit": 3.14, # [Output Only] Quota limit for this metric.
},
],
"usageExportLocation": { # The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix. # The location in Cloud Storage and naming method of the daily usage report.
- "bucketName": "A String", # The name of an existing bucket in Cloud Storage where the usage report object is stored. The Google Service Account is granted write access to this bucket. This is simply the bucket name, with no "gs://" or "https://storage.googleapis.com/" in front of it.
- "reportNamePrefix": "A String", # An optional prefix for the name of the usage report object stored in bucket_name. If not supplied, defaults to "usage_". The report is stored as a CSV file named _gce_.csv. where is the day of the usage according to Pacific Time. The prefix should conform to Cloud Storage object naming conventions.
+ "bucketName": "A String", # The name of an existing bucket in Cloud Storage where the usage report object is stored. The Google Service Account is granted write access to this bucket. This is just the bucket name, with no gs:// or https://storage.googleapis.com/ in front of it.
+ "reportNamePrefix": "A String", # An optional prefix for the name of the usage report object stored in bucketName. If not supplied, defaults to usage. The report is stored as a CSV file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of the usage according to Pacific Time. If you supply a prefix, it should conform to Cloud Storage object naming conventions.
},
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for the resource.
"name": "A String", # Name of the resource.
}</pre>
</div>
<div class="method">
+ <code class="details" id="moveDisk">moveDisk(project, body)</code>
+ <pre>Moves a persistent disk from one zone to another.
+
+Args:
+ project: string, Project ID for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "targetDisk": "A String", # The URL of the target disk to be moved.
+ "destinationZone": "A String", # The URL of the zone to which the disk will be moved.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server defined URL for the resource.
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="moveInstance">moveInstance(project, body)</code>
+ <pre>Moves an instance and its attached persistent disks from one zone to another.
+
+Args:
+ project: string, Project ID for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "targetInstance": "A String", # The URL of the target instance to move.
+ "destinationZone": "A String", # The URL of the zone to move the instance to.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server defined URL for the resource.
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
+ }</pre>
+</div>
+
+<div class="method">
<code class="details" id="setCommonInstanceMetadata">setCommonInstanceMetadata(project, body)</code>
<pre>Sets metadata common to all instances within the specified project using the data included in the request.
Args:
- project: string, Name of the project scoping this request. (required)
+ project: string, Project ID for this request. (required)
body: object, The request body. (required)
The object takes the form of:
@@ -141,8 +273,8 @@
"key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
},
],
- "kind": "compute#metadata", # Type of the resource.
- "fingerprint": "A String", # Fingerprint of this resource. A hash of the metadata's contents. This field is used for optimistic locking. An up-to-date metadata fingerprint must be provided in order to modify metadata.
+ "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
}
@@ -150,36 +282,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -188,24 +320,24 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
<div class="method">
<code class="details" id="setUsageExportBucket">setUsageExportBucket(project, body)</code>
- <pre>Sets usage export location
+ <pre>Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled.
Args:
- project: string, Name of the project scoping this request. (required)
+ project: string, Project ID for this request. (required)
body: object, The request body. (required)
The object takes the form of:
{ # The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix.
- "bucketName": "A String", # The name of an existing bucket in Cloud Storage where the usage report object is stored. The Google Service Account is granted write access to this bucket. This is simply the bucket name, with no "gs://" or "https://storage.googleapis.com/" in front of it.
- "reportNamePrefix": "A String", # An optional prefix for the name of the usage report object stored in bucket_name. If not supplied, defaults to "usage_". The report is stored as a CSV file named _gce_.csv. where is the day of the usage according to Pacific Time. The prefix should conform to Cloud Storage object naming conventions.
+ "bucketName": "A String", # The name of an existing bucket in Cloud Storage where the usage report object is stored. The Google Service Account is granted write access to this bucket. This is just the bucket name, with no gs:// or https://storage.googleapis.com/ in front of it.
+ "reportNamePrefix": "A String", # An optional prefix for the name of the usage report object stored in bucketName. If not supplied, defaults to usage. The report is stored as a CSV file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of the usage according to Pacific Time. If you supply a prefix, it should conform to Cloud Storage object naming conventions.
}
@@ -213,36 +345,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -251,9 +383,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
diff --git a/docs/dyn/compute_v1.regionOperations.html b/docs/dyn/compute_v1.regionOperations.html
index 8021e7c..9b8c844 100644
--- a/docs/dyn/compute_v1.regionOperations.html
+++ b/docs/dyn/compute_v1.regionOperations.html
@@ -92,7 +92,7 @@
<pre>Deletes the specified region-specific operation resource.
Args:
- project: string, Name of the project scoping this request. (required)
+ project: string, Project ID for this request. (required)
region: string, Name of the region scoping this request. (required)
operation: string, Name of the operation resource to delete. (required)
</pre>
@@ -103,7 +103,7 @@
<pre>Retrieves the specified region-specific operation resource.
Args:
- project: string, Name of the project scoping this request. (required)
+ project: string, Project ID for this request. (required)
region: string, Name of the zone scoping this request. (required)
operation: string, Name of the operation resource to return. (required)
@@ -111,36 +111,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -149,9 +149,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -160,7 +160,7 @@
<pre>Retrieves the list of operation resources contained within the specified region.
Args:
- project: string, Name of the project scoping this request. (required)
+ project: string, Project ID for this request. (required)
region: string, Name of the region scoping this request. (required)
maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
@@ -173,36 +173,36 @@
"nextPageToken": "A String", # [Output Only] A token used to continue a truncate.
"items": [ # [Output Only] The operation resources.
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -211,12 +211,12 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
},
],
- "kind": "compute#operationList", # Type of resource. Always compute#operations for Operations resource.
+ "kind": "compute#operationList", # [Output Only] Type of resource. Always compute#operations for Operations resource.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
"selfLink": "A String", # [Output Only] Server defined URL for this resource.
}</pre>
diff --git a/docs/dyn/compute_v1.regions.html b/docs/dyn/compute_v1.regions.html
index 4ea9798..01d3585 100644
--- a/docs/dyn/compute_v1.regions.html
+++ b/docs/dyn/compute_v1.regions.html
@@ -89,37 +89,37 @@
<pre>Returns the specified region resource.
Args:
- project: string, Name of the project scoping this request. (required)
+ project: string, Project ID for this request. (required)
region: string, Name of the region resource to return. (required)
Returns:
An object of the form:
{ # Region resource.
- "status": "A String", # Status of the region, "UP" or "DOWN".
- "kind": "compute#region", # Type of the resource.
- "description": "A String", # Textual description of the resource.
- "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this region.
+ "status": "A String", # [Output Only] Status of the region, either UP or DOWN.
+ "kind": "compute#region", # [Output Only] Type of the resource. Always compute#region for regions.
+ "description": "A String", # [Output Only] Textual description of the resource.
+ "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this region.
"deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
"deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
- "state": "A String", # The deprecation state. Can be "DEPRECATED", "OBSOLETE", or "DELETED". Operations which create a new resource using a "DEPRECATED" resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. New uses of "OBSOLETE" or "DELETED" resources will result in an error.
+ "state": "A String", # The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.
"obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
- "replacement": "A String", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
+ "replacement": "A String", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
},
- "quotas": [ # Quotas assigned to this region.
+ "quotas": [ # [Output Only] Quotas assigned to this region.
{ # A quotas entry.
- "usage": 3.14, # Current usage of this metric.
- "metric": "A String", # Name of the quota metric.
- "limit": 3.14, # Quota limit for this metric.
+ "usage": 3.14, # [Output Only] Current usage of this metric.
+ "metric": "A String", # [Output Only] Name of the quota metric.
+ "limit": 3.14, # [Output Only] Quota limit for this metric.
},
],
- "zones": [ # A list of zones homed in this region, in the form of resource URLs.
+ "zones": [ # [Output Only] A list of zones available in this region, in the form of resource URLs.
"A String",
],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server .
+ "selfLink": "A String", # [Output Only] Server defined URL for the resource.
+ "name": "A String", # [Output Only] Name of the resource.
}</pre>
</div>
@@ -128,7 +128,7 @@
<pre>Retrieves the list of region resources available to the specified project.
Args:
- project: string, Name of the project scoping this request. (required)
+ project: string, Project ID for this request. (required)
maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
filter: string, Optional. Filter expression for filtering listed resources.
@@ -137,38 +137,38 @@
An object of the form:
{ # Contains a list of region resources.
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # A list of Region resources.
+ "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+ "items": [ # [Output Only] A list of Region resources.
{ # Region resource.
- "status": "A String", # Status of the region, "UP" or "DOWN".
- "kind": "compute#region", # Type of the resource.
- "description": "A String", # Textual description of the resource.
- "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this region.
+ "status": "A String", # [Output Only] Status of the region, either UP or DOWN.
+ "kind": "compute#region", # [Output Only] Type of the resource. Always compute#region for regions.
+ "description": "A String", # [Output Only] Textual description of the resource.
+ "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this region.
"deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
"deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
- "state": "A String", # The deprecation state. Can be "DEPRECATED", "OBSOLETE", or "DELETED". Operations which create a new resource using a "DEPRECATED" resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. New uses of "OBSOLETE" or "DELETED" resources will result in an error.
+ "state": "A String", # The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.
"obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
- "replacement": "A String", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
+ "replacement": "A String", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
},
- "quotas": [ # Quotas assigned to this region.
+ "quotas": [ # [Output Only] Quotas assigned to this region.
{ # A quotas entry.
- "usage": 3.14, # Current usage of this metric.
- "metric": "A String", # Name of the quota metric.
- "limit": 3.14, # Quota limit for this metric.
+ "usage": 3.14, # [Output Only] Current usage of this metric.
+ "metric": "A String", # [Output Only] Name of the quota metric.
+ "limit": 3.14, # [Output Only] Quota limit for this metric.
},
],
- "zones": [ # A list of zones homed in this region, in the form of resource URLs.
+ "zones": [ # [Output Only] A list of zones available in this region, in the form of resource URLs.
"A String",
],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server .
+ "selfLink": "A String", # [Output Only] Server defined URL for the resource.
+ "name": "A String", # [Output Only] Name of the resource.
},
],
- "kind": "compute#regionList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
+ "kind": "compute#regionList", # [Output Only] Type of resource. Always compute#regionList for lists of regions.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for this resource.
}</pre>
</div>
diff --git a/docs/dyn/compute_v1.routes.html b/docs/dyn/compute_v1.routes.html
index 8ef48a7..6722c91 100644
--- a/docs/dyn/compute_v1.routes.html
+++ b/docs/dyn/compute_v1.routes.html
@@ -102,36 +102,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -140,9 +140,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -168,12 +168,12 @@
"nextHopInstance": "A String", # The URL to an instance that should handle matching packets.
"warnings": [ # If potential misconfigurations are detected for this route, this field will be populated with warning messages.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
@@ -209,12 +209,12 @@
"nextHopInstance": "A String", # The URL to an instance that should handle matching packets.
"warnings": [ # If potential misconfigurations are detected for this route, this field will be populated with warning messages.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
@@ -234,36 +234,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -272,9 +272,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -305,12 +305,12 @@
"nextHopInstance": "A String", # The URL to an instance that should handle matching packets.
"warnings": [ # If potential misconfigurations are detected for this route, this field will be populated with warning messages.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
diff --git a/docs/dyn/compute_v1.snapshots.html b/docs/dyn/compute_v1.snapshots.html
index 2b94c56..a4560f1 100644
--- a/docs/dyn/compute_v1.snapshots.html
+++ b/docs/dyn/compute_v1.snapshots.html
@@ -99,36 +99,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -137,9 +137,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
diff --git a/docs/dyn/compute_v1.targetHttpProxies.html b/docs/dyn/compute_v1.targetHttpProxies.html
index e6995a6..88981fe 100644
--- a/docs/dyn/compute_v1.targetHttpProxies.html
+++ b/docs/dyn/compute_v1.targetHttpProxies.html
@@ -105,36 +105,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -143,9 +143,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -195,36 +195,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -233,9 +233,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -304,36 +304,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -342,9 +342,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
diff --git a/docs/dyn/compute_v1.targetInstances.html b/docs/dyn/compute_v1.targetInstances.html
index 9358837..0b02444 100644
--- a/docs/dyn/compute_v1.targetInstances.html
+++ b/docs/dyn/compute_v1.targetInstances.html
@@ -127,12 +127,12 @@
},
],
"warning": { # Informational warning which replaces the list of addresses when the list is empty.
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
@@ -171,36 +171,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -209,9 +209,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -267,36 +267,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -305,9 +305,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
diff --git a/docs/dyn/compute_v1.targetPools.html b/docs/dyn/compute_v1.targetPools.html
index 2d56161..78deba5 100644
--- a/docs/dyn/compute_v1.targetPools.html
+++ b/docs/dyn/compute_v1.targetPools.html
@@ -138,36 +138,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -176,9 +176,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -206,36 +206,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -244,9 +244,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -268,12 +268,12 @@
"items": { # A map of scoped target pool lists.
"a_key": { # Name of the scope containing this set of target pools.
"warning": { # Informational warning which replaces the list of addresses when the list is empty.
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
@@ -340,36 +340,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -378,9 +378,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -498,36 +498,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -536,9 +536,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -630,36 +630,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -668,9 +668,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -698,36 +698,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -736,9 +736,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -763,36 +763,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -801,9 +801,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
diff --git a/docs/dyn/compute_v1.urlMaps.html b/docs/dyn/compute_v1.urlMaps.html
index 543af35..0b63d44 100644
--- a/docs/dyn/compute_v1.urlMaps.html
+++ b/docs/dyn/compute_v1.urlMaps.html
@@ -111,36 +111,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -149,9 +149,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -267,36 +267,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -305,9 +305,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -448,36 +448,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -486,9 +486,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -550,36 +550,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -588,9 +588,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
diff --git a/docs/dyn/compute_v1.zoneOperations.html b/docs/dyn/compute_v1.zoneOperations.html
index d829177..5114bc3 100644
--- a/docs/dyn/compute_v1.zoneOperations.html
+++ b/docs/dyn/compute_v1.zoneOperations.html
@@ -92,7 +92,7 @@
<pre>Deletes the specified zone-specific operation resource.
Args:
- project: string, Name of the project scoping this request. (required)
+ project: string, Project ID for this request. (required)
zone: string, Name of the zone scoping this request. (required)
operation: string, Name of the operation resource to delete. (required)
</pre>
@@ -103,7 +103,7 @@
<pre>Retrieves the specified zone-specific operation resource.
Args:
- project: string, Name of the project scoping this request. (required)
+ project: string, Project ID for this request. (required)
zone: string, Name of the zone scoping this request. (required)
operation: string, Name of the operation resource to return. (required)
@@ -111,36 +111,36 @@
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -149,9 +149,9 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
@@ -160,7 +160,7 @@
<pre>Retrieves the list of operation resources contained within the specified zone.
Args:
- project: string, Name of the project scoping this request. (required)
+ project: string, Project ID for this request. (required)
zone: string, Name of the zone scoping this request. (required)
maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
@@ -173,36 +173,36 @@
"nextPageToken": "A String", # [Output Only] A token used to continue a truncate.
"items": [ # [Output Only] The operation resources.
{ # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "clientOperationId": "A String",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
+ "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "zone": "A String", # [Output Only] URL of the zone where the operation resides.
+ "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "warnings": [
+ "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "message": "A String", # [Output Only] Optional human-readable details for this warning.
+ "code": "A String", # [Output Only] The warning type identifier for this warning.
+ "data": [ # [Output Only] Metadata for this warning in key: value format.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
@@ -211,12 +211,12 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
},
],
- "kind": "compute#operationList", # Type of resource. Always compute#operations for Operations resource.
+ "kind": "compute#operationList", # [Output Only] Type of resource. Always compute#operations for Operations resource.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
"selfLink": "A String", # [Output Only] Server defined URL for this resource.
}</pre>
diff --git a/docs/dyn/compute_v1.zones.html b/docs/dyn/compute_v1.zones.html
index 9803641..5a3a6b3 100644
--- a/docs/dyn/compute_v1.zones.html
+++ b/docs/dyn/compute_v1.zones.html
@@ -89,36 +89,36 @@
<pre>Returns the specified zone resource.
Args:
- project: string, Name of the project scoping this request. (required)
+ project: string, Project ID for this request. (required)
zone: string, Name of the zone resource to return. (required)
Returns:
An object of the form:
- { # A zone resource.
- "status": "A String", # Status of the zone. "UP" or "DOWN".
- "kind": "compute#zone", # Type of the resource.
- "description": "A String", # Textual description of the resource.
- "maintenanceWindows": [ # Scheduled maintenance windows for the zone. When the zone is in a maintenance window, all resources which reside in the zone will be unavailable.
+ { # A Zone resource.
+ "status": "A String", # [Output Only] Status of the zone, either UP or DOWN.
+ "kind": "compute#zone", # [Output Only] Type of the resource. Always kind#zone for zones.
+ "description": "A String", # [Output Only] Textual description of the resource.
+ "maintenanceWindows": [ # [Output Only] Any scheduled maintenance windows for this zone. When the zone is in a maintenance window, all resources which reside in the zone will be unavailable. For more information, see Maintenance Windows
{
- "endTime": "A String", # End time of the maintenance window, in RFC 3339 format.
- "beginTime": "A String", # Begin time of the maintenance window, in RFC 3339 format.
- "name": "A String", # Name of the maintenance window.
- "description": "A String", # Textual description of the maintenance window.
+ "endTime": "A String", # [Output Only] Ending time of the maintenance window, in RFC3339 format.
+ "beginTime": "A String", # [Output Only] Starting time of the maintenance window, in RFC3339 format.
+ "name": "A String", # [Output Only] Name of the maintenance window.
+ "description": "A String", # [Output Only] Textual description of the maintenance window.
},
],
- "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this zone.
+ "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this zone.
"deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
"deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
- "state": "A String", # The deprecation state. Can be "DEPRECATED", "OBSOLETE", or "DELETED". Operations which create a new resource using a "DEPRECATED" resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. New uses of "OBSOLETE" or "DELETED" resources will result in an error.
+ "state": "A String", # The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.
"obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
- "replacement": "A String", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
+ "replacement": "A String", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
},
- "region": "A String", # Full URL reference to the region which hosts the zone (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource.
+ "region": "A String", # [Output Only] Full URL reference to the region which hosts the zone.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for the resource.
+ "name": "A String", # [Output Only] Name of the resource.
}</pre>
</div>
@@ -127,7 +127,7 @@
<pre>Retrieves the list of zone resources available to the specified project.
Args:
- project: string, Name of the project scoping this request. (required)
+ project: string, Project ID for this request. (required)
maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
filter: string, Optional. Filter expression for filtering listed resources.
@@ -136,36 +136,36 @@
An object of the form:
{ # Contains a list of zone resources.
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # A list of Zone resources.
- { # A zone resource.
- "status": "A String", # Status of the zone. "UP" or "DOWN".
- "kind": "compute#zone", # Type of the resource.
- "description": "A String", # Textual description of the resource.
- "maintenanceWindows": [ # Scheduled maintenance windows for the zone. When the zone is in a maintenance window, all resources which reside in the zone will be unavailable.
+ "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+ "items": [ # [Output Only] A list of Zone resources.
+ { # A Zone resource.
+ "status": "A String", # [Output Only] Status of the zone, either UP or DOWN.
+ "kind": "compute#zone", # [Output Only] Type of the resource. Always kind#zone for zones.
+ "description": "A String", # [Output Only] Textual description of the resource.
+ "maintenanceWindows": [ # [Output Only] Any scheduled maintenance windows for this zone. When the zone is in a maintenance window, all resources which reside in the zone will be unavailable. For more information, see Maintenance Windows
{
- "endTime": "A String", # End time of the maintenance window, in RFC 3339 format.
- "beginTime": "A String", # Begin time of the maintenance window, in RFC 3339 format.
- "name": "A String", # Name of the maintenance window.
- "description": "A String", # Textual description of the maintenance window.
+ "endTime": "A String", # [Output Only] Ending time of the maintenance window, in RFC3339 format.
+ "beginTime": "A String", # [Output Only] Starting time of the maintenance window, in RFC3339 format.
+ "name": "A String", # [Output Only] Name of the maintenance window.
+ "description": "A String", # [Output Only] Textual description of the maintenance window.
},
],
- "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this zone.
+ "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this zone.
"deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
"deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
- "state": "A String", # The deprecation state. Can be "DEPRECATED", "OBSOLETE", or "DELETED". Operations which create a new resource using a "DEPRECATED" resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. New uses of "OBSOLETE" or "DELETED" resources will result in an error.
+ "state": "A String", # The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.
"obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
- "replacement": "A String", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
+ "replacement": "A String", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
},
- "region": "A String", # Full URL reference to the region which hosts the zone (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource.
+ "region": "A String", # [Output Only] Full URL reference to the region which hosts the zone.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for the resource.
+ "name": "A String", # [Output Only] Name of the resource.
},
],
"kind": "compute#zoneList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
"selfLink": "A String", # Server defined URL for this resource (output only).
}</pre>
</div>
diff --git a/docs/dyn/content_v2.accounts.html b/docs/dyn/content_v2.accounts.html
index ca72866..5bd13b9 100644
--- a/docs/dyn/content_v2.accounts.html
+++ b/docs/dyn/content_v2.accounts.html
@@ -75,6 +75,9 @@
<h1><a href="content_v2.html">Content API for Shopping</a> . <a href="content_v2.accounts.html">accounts</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
+ <code><a href="#authinfo">authinfo()</a></code></p>
+<p class="firstline">Returns information about the authenticated user.</p>
+<p class="toc_element">
<code><a href="#custombatch">custombatch(body)</a></code></p>
<p class="firstline">Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request.</p>
<p class="toc_element">
@@ -100,6 +103,29 @@
<p class="firstline">Updates a Merchant Center account.</p>
<h3>Method Details</h3>
<div class="method">
+ <code class="details" id="authinfo">authinfo()</code>
+ <pre>Returns information about the authenticated user.
+
+Args:
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "content#accountsAuthInfoResponse", # Identifies what kind of resource this is. Value: the fixed string "content#accountsAuthInfoResponse".
+ "accountIdentifiers": [ # The account identifiers corresponding to the authenticated user.
+ { # Account identifier corresponding to the authenticated user.
+ # - For an individual account: only the merchant ID is defined
+ # - For an aggregator: only the aggregator ID is defined
+ # - For a subaccount of an MCA: both the merchant ID and the aggregator ID are defined.
+ "aggregatorId": "A String", # The aggregator ID, set for aggregators and subaccounts (in that case, it represents the aggregator of the subaccount).
+ "merchantId": "A String", # The merchant account ID, set for individual accounts and subaccounts.
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
<code class="details" id="custombatch">custombatch(body)</code>
<pre>Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request.
diff --git a/docs/dyn/dfareporting_v2_0.contentCategories.html b/docs/dyn/dfareporting_v2_0.contentCategories.html
index 38c655b..6c0a764 100644
--- a/docs/dyn/dfareporting_v2_0.contentCategories.html
+++ b/docs/dyn/dfareporting_v2_0.contentCategories.html
@@ -122,7 +122,7 @@
"kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
"description": "A String", # Description of this content category.
"name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
- "accountId": "A String", # Account ID of this content category.This is a read-only field that can be left blank.
+ "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
}</pre>
</div>
@@ -140,7 +140,7 @@
"kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
"description": "A String", # Description of this content category.
"name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
- "accountId": "A String", # Account ID of this content category.This is a read-only field that can be left blank.
+ "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
}
@@ -152,7 +152,7 @@
"kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
"description": "A String", # Description of this content category.
"name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
- "accountId": "A String", # Account ID of this content category.This is a read-only field that can be left blank.
+ "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
}</pre>
</div>
@@ -187,7 +187,7 @@
"kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
"description": "A String", # Description of this content category.
"name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
- "accountId": "A String", # Account ID of this content category.This is a read-only field that can be left blank.
+ "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
},
],
}</pre>
@@ -222,7 +222,7 @@
"kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
"description": "A String", # Description of this content category.
"name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
- "accountId": "A String", # Account ID of this content category.This is a read-only field that can be left blank.
+ "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
}
@@ -234,7 +234,7 @@
"kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
"description": "A String", # Description of this content category.
"name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
- "accountId": "A String", # Account ID of this content category.This is a read-only field that can be left blank.
+ "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
}</pre>
</div>
@@ -252,7 +252,7 @@
"kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
"description": "A String", # Description of this content category.
"name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
- "accountId": "A String", # Account ID of this content category.This is a read-only field that can be left blank.
+ "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
}
@@ -264,7 +264,7 @@
"kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
"description": "A String", # Description of this content category.
"name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
- "accountId": "A String", # Account ID of this content category.This is a read-only field that can be left blank.
+ "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
}</pre>
</div>
diff --git a/docs/dyn/dfareporting_v2_0.creatives.html b/docs/dyn/dfareporting_v2_0.creatives.html
index 2564732..dd21ce8 100644
--- a/docs/dyn/dfareporting_v2_0.creatives.html
+++ b/docs/dyn/dfareporting_v2_0.creatives.html
@@ -116,7 +116,7 @@
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
"videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media pop-up windows. This field is used only for exit events.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
"showAddressBar": True or False, # Whether to display the browser address bar.
@@ -176,7 +176,7 @@
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
"videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media pop-up windows. This field is used only for exit events.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
"showAddressBar": True or False, # Whether to display the browser address bar.
@@ -210,7 +210,7 @@
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
"videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media pop-up windows. This field is used only for exit events.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
"showAddressBar": True or False, # Whether to display the browser address bar.
@@ -299,7 +299,7 @@
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"height": 42, # Height of this size.
},
- "horizontallyLocked": True or False, # Wheter the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+ "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
"startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
"displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
"expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
@@ -341,7 +341,7 @@
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
"videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media pop-up windows. This field is used only for exit events.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
"showAddressBar": True or False, # Whether to display the browser address bar.
@@ -383,7 +383,7 @@
"customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
},
],
- "htmlCodeLocked": True or False, # Whether HTML code is DCM generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
+ "htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
"redirectUrl": "A String", # URL of hosted image or another ad tag. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
"clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER.
{ # Creative Click Tag.
@@ -456,7 +456,7 @@
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
"videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media pop-up windows. This field is used only for exit events.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
"showAddressBar": True or False, # Whether to display the browser address bar.
@@ -516,7 +516,7 @@
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
"videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media pop-up windows. This field is used only for exit events.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
"showAddressBar": True or False, # Whether to display the browser address bar.
@@ -550,7 +550,7 @@
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
"videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media pop-up windows. This field is used only for exit events.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
"showAddressBar": True or False, # Whether to display the browser address bar.
@@ -639,7 +639,7 @@
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"height": 42, # Height of this size.
},
- "horizontallyLocked": True or False, # Wheter the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+ "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
"startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
"displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
"expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
@@ -681,7 +681,7 @@
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
"videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media pop-up windows. This field is used only for exit events.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
"showAddressBar": True or False, # Whether to display the browser address bar.
@@ -723,7 +723,7 @@
"customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
},
],
- "htmlCodeLocked": True or False, # Whether HTML code is DCM generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
+ "htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
"redirectUrl": "A String", # URL of hosted image or another ad tag. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
"clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER.
{ # Creative Click Tag.
@@ -790,7 +790,7 @@
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
"videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media pop-up windows. This field is used only for exit events.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
"showAddressBar": True or False, # Whether to display the browser address bar.
@@ -850,7 +850,7 @@
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
"videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media pop-up windows. This field is used only for exit events.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
"showAddressBar": True or False, # Whether to display the browser address bar.
@@ -884,7 +884,7 @@
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
"videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media pop-up windows. This field is used only for exit events.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
"showAddressBar": True or False, # Whether to display the browser address bar.
@@ -973,7 +973,7 @@
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"height": 42, # Height of this size.
},
- "horizontallyLocked": True or False, # Wheter the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+ "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
"startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
"displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
"expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
@@ -1015,7 +1015,7 @@
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
"videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media pop-up windows. This field is used only for exit events.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
"showAddressBar": True or False, # Whether to display the browser address bar.
@@ -1057,7 +1057,7 @@
"customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
},
],
- "htmlCodeLocked": True or False, # Whether HTML code is DCM generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
+ "htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
"redirectUrl": "A String", # URL of hosted image or another ad tag. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
"clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER.
{ # Creative Click Tag.
@@ -1181,7 +1181,7 @@
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
"videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media pop-up windows. This field is used only for exit events.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
"showAddressBar": True or False, # Whether to display the browser address bar.
@@ -1241,7 +1241,7 @@
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
"videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media pop-up windows. This field is used only for exit events.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
"showAddressBar": True or False, # Whether to display the browser address bar.
@@ -1275,7 +1275,7 @@
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
"videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media pop-up windows. This field is used only for exit events.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
"showAddressBar": True or False, # Whether to display the browser address bar.
@@ -1364,7 +1364,7 @@
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"height": 42, # Height of this size.
},
- "horizontallyLocked": True or False, # Wheter the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+ "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
"startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
"displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
"expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
@@ -1406,7 +1406,7 @@
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
"videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media pop-up windows. This field is used only for exit events.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
"showAddressBar": True or False, # Whether to display the browser address bar.
@@ -1448,7 +1448,7 @@
"customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
},
],
- "htmlCodeLocked": True or False, # Whether HTML code is DCM generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
+ "htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
"redirectUrl": "A String", # URL of hosted image or another ad tag. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
"clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER.
{ # Creative Click Tag.
@@ -1538,7 +1538,7 @@
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
"videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media pop-up windows. This field is used only for exit events.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
"showAddressBar": True or False, # Whether to display the browser address bar.
@@ -1598,7 +1598,7 @@
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
"videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media pop-up windows. This field is used only for exit events.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
"showAddressBar": True or False, # Whether to display the browser address bar.
@@ -1632,7 +1632,7 @@
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
"videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media pop-up windows. This field is used only for exit events.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
"showAddressBar": True or False, # Whether to display the browser address bar.
@@ -1721,7 +1721,7 @@
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"height": 42, # Height of this size.
},
- "horizontallyLocked": True or False, # Wheter the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+ "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
"startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
"displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
"expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
@@ -1763,7 +1763,7 @@
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
"videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media pop-up windows. This field is used only for exit events.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
"showAddressBar": True or False, # Whether to display the browser address bar.
@@ -1805,7 +1805,7 @@
"customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
},
],
- "htmlCodeLocked": True or False, # Whether HTML code is DCM generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
+ "htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
"redirectUrl": "A String", # URL of hosted image or another ad tag. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
"clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER.
{ # Creative Click Tag.
@@ -1872,7 +1872,7 @@
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
"videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media pop-up windows. This field is used only for exit events.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
"showAddressBar": True or False, # Whether to display the browser address bar.
@@ -1932,7 +1932,7 @@
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
"videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media pop-up windows. This field is used only for exit events.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
"showAddressBar": True or False, # Whether to display the browser address bar.
@@ -1966,7 +1966,7 @@
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
"videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media pop-up windows. This field is used only for exit events.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
"showAddressBar": True or False, # Whether to display the browser address bar.
@@ -2055,7 +2055,7 @@
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"height": 42, # Height of this size.
},
- "horizontallyLocked": True or False, # Wheter the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+ "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
"startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
"displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
"expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
@@ -2097,7 +2097,7 @@
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
"videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media pop-up windows. This field is used only for exit events.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
"showAddressBar": True or False, # Whether to display the browser address bar.
@@ -2139,7 +2139,7 @@
"customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
},
],
- "htmlCodeLocked": True or False, # Whether HTML code is DCM generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
+ "htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
"redirectUrl": "A String", # URL of hosted image or another ad tag. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
"clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER.
{ # Creative Click Tag.
@@ -2212,7 +2212,7 @@
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
"videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media pop-up windows. This field is used only for exit events.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
"showAddressBar": True or False, # Whether to display the browser address bar.
@@ -2272,7 +2272,7 @@
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
"videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media pop-up windows. This field is used only for exit events.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
"showAddressBar": True or False, # Whether to display the browser address bar.
@@ -2306,7 +2306,7 @@
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
"videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media pop-up windows. This field is used only for exit events.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
"showAddressBar": True or False, # Whether to display the browser address bar.
@@ -2395,7 +2395,7 @@
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"height": 42, # Height of this size.
},
- "horizontallyLocked": True or False, # Wheter the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+ "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
"startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
"displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
"expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
@@ -2437,7 +2437,7 @@
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
"videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media pop-up windows. This field is used only for exit events.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
"showAddressBar": True or False, # Whether to display the browser address bar.
@@ -2479,7 +2479,7 @@
"customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
},
],
- "htmlCodeLocked": True or False, # Whether HTML code is DCM generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
+ "htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
"redirectUrl": "A String", # URL of hosted image or another ad tag. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
"clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER.
{ # Creative Click Tag.
@@ -2546,7 +2546,7 @@
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
"videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media pop-up windows. This field is used only for exit events.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
"showAddressBar": True or False, # Whether to display the browser address bar.
@@ -2606,7 +2606,7 @@
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
"videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media pop-up windows. This field is used only for exit events.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
"showAddressBar": True or False, # Whether to display the browser address bar.
@@ -2640,7 +2640,7 @@
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
"videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media pop-up windows. This field is used only for exit events.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
"showAddressBar": True or False, # Whether to display the browser address bar.
@@ -2729,7 +2729,7 @@
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"height": 42, # Height of this size.
},
- "horizontallyLocked": True or False, # Wheter the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+ "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
"startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
"displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
"expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
@@ -2771,7 +2771,7 @@
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
"videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media pop-up windows. This field is used only for exit events.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
"showAddressBar": True or False, # Whether to display the browser address bar.
@@ -2813,7 +2813,7 @@
"customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
},
],
- "htmlCodeLocked": True or False, # Whether HTML code is DCM generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
+ "htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
"redirectUrl": "A String", # URL of hosted image or another ad tag. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
"clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER.
{ # Creative Click Tag.
diff --git a/docs/dyn/dfareporting_v2_0.floodlightActivities.html b/docs/dyn/dfareporting_v2_0.floodlightActivities.html
index fdc0b29..180726e 100644
--- a/docs/dyn/dfareporting_v2_0.floodlightActivities.html
+++ b/docs/dyn/dfareporting_v2_0.floodlightActivities.html
@@ -185,7 +185,7 @@
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"id": "A String", # The ID associated with the value if available.
},
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity.This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
@@ -194,12 +194,12 @@
"id": "A String", # The ID associated with the value if available.
},
"hidden": True or False, # Whether this activity is archived.
- "accountId": "A String", # Account ID of this floodlight activity.This is a read-only field that can be left blank.
+ "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
"sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
"expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
"cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
"kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
- "subaccountId": "A String", # Subaccount ID of this floodlight activity.This is a read-only field that can be left blank.
+ "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
"name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
"notes": "A String", # General notes or implementation instructions for the tag.
"floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
@@ -296,7 +296,7 @@
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"id": "A String", # The ID associated with the value if available.
},
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity.This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
@@ -305,12 +305,12 @@
"id": "A String", # The ID associated with the value if available.
},
"hidden": True or False, # Whether this activity is archived.
- "accountId": "A String", # Account ID of this floodlight activity.This is a read-only field that can be left blank.
+ "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
"sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
"expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
"cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
"kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
- "subaccountId": "A String", # Subaccount ID of this floodlight activity.This is a read-only field that can be left blank.
+ "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
"name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
"notes": "A String", # General notes or implementation instructions for the tag.
"floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
@@ -401,7 +401,7 @@
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"id": "A String", # The ID associated with the value if available.
},
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity.This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
@@ -410,12 +410,12 @@
"id": "A String", # The ID associated with the value if available.
},
"hidden": True or False, # Whether this activity is archived.
- "accountId": "A String", # Account ID of this floodlight activity.This is a read-only field that can be left blank.
+ "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
"sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
"expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
"cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
"kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
- "subaccountId": "A String", # Subaccount ID of this floodlight activity.This is a read-only field that can be left blank.
+ "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
"name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
"notes": "A String", # General notes or implementation instructions for the tag.
"floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
@@ -539,7 +539,7 @@
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"id": "A String", # The ID associated with the value if available.
},
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity.This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
@@ -548,12 +548,12 @@
"id": "A String", # The ID associated with the value if available.
},
"hidden": True or False, # Whether this activity is archived.
- "accountId": "A String", # Account ID of this floodlight activity.This is a read-only field that can be left blank.
+ "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
"sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
"expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
"cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
"kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
- "subaccountId": "A String", # Subaccount ID of this floodlight activity.This is a read-only field that can be left blank.
+ "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
"name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
"notes": "A String", # General notes or implementation instructions for the tag.
"floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
@@ -667,7 +667,7 @@
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"id": "A String", # The ID associated with the value if available.
},
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity.This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
@@ -676,12 +676,12 @@
"id": "A String", # The ID associated with the value if available.
},
"hidden": True or False, # Whether this activity is archived.
- "accountId": "A String", # Account ID of this floodlight activity.This is a read-only field that can be left blank.
+ "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
"sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
"expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
"cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
"kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
- "subaccountId": "A String", # Subaccount ID of this floodlight activity.This is a read-only field that can be left blank.
+ "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
"name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
"notes": "A String", # General notes or implementation instructions for the tag.
"floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
@@ -772,7 +772,7 @@
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"id": "A String", # The ID associated with the value if available.
},
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity.This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
@@ -781,12 +781,12 @@
"id": "A String", # The ID associated with the value if available.
},
"hidden": True or False, # Whether this activity is archived.
- "accountId": "A String", # Account ID of this floodlight activity.This is a read-only field that can be left blank.
+ "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
"sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
"expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
"cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
"kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
- "subaccountId": "A String", # Subaccount ID of this floodlight activity.This is a read-only field that can be left blank.
+ "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
"name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
"notes": "A String", # General notes or implementation instructions for the tag.
"floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
@@ -883,7 +883,7 @@
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"id": "A String", # The ID associated with the value if available.
},
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity.This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
@@ -892,12 +892,12 @@
"id": "A String", # The ID associated with the value if available.
},
"hidden": True or False, # Whether this activity is archived.
- "accountId": "A String", # Account ID of this floodlight activity.This is a read-only field that can be left blank.
+ "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
"sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
"expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
"cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
"kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
- "subaccountId": "A String", # Subaccount ID of this floodlight activity.This is a read-only field that can be left blank.
+ "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
"name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
"notes": "A String", # General notes or implementation instructions for the tag.
"floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
@@ -988,7 +988,7 @@
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"id": "A String", # The ID associated with the value if available.
},
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity.This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
@@ -997,12 +997,12 @@
"id": "A String", # The ID associated with the value if available.
},
"hidden": True or False, # Whether this activity is archived.
- "accountId": "A String", # Account ID of this floodlight activity.This is a read-only field that can be left blank.
+ "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
"sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
"expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
"cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
"kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
- "subaccountId": "A String", # Subaccount ID of this floodlight activity.This is a read-only field that can be left blank.
+ "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
"name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
"notes": "A String", # General notes or implementation instructions for the tag.
"floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
diff --git a/docs/dyn/dfareporting_v2_0.floodlightActivityGroups.html b/docs/dyn/dfareporting_v2_0.floodlightActivityGroups.html
index a8b6734..1a2a0c6 100644
--- a/docs/dyn/dfareporting_v2_0.floodlightActivityGroups.html
+++ b/docs/dyn/dfareporting_v2_0.floodlightActivityGroups.html
@@ -148,9 +148,9 @@
"id": "A String", # The ID associated with the value if available.
},
"tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
- "type": "A String", # The type of floodlight activity group. This is a required field that is read-only after insertion.
+ "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
"id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this floodlight activity group.This is a read-only field that can be left blank.
+ "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
}</pre>
</div>
@@ -194,9 +194,9 @@
"id": "A String", # The ID associated with the value if available.
},
"tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
- "type": "A String", # The type of floodlight activity group. This is a required field that is read-only after insertion.
+ "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
"id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this floodlight activity group.This is a read-only field that can be left blank.
+ "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
}
@@ -234,9 +234,9 @@
"id": "A String", # The ID associated with the value if available.
},
"tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
- "type": "A String", # The type of floodlight activity group. This is a required field that is read-only after insertion.
+ "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
"id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this floodlight activity group.This is a read-only field that can be left blank.
+ "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
}</pre>
</div>
@@ -303,9 +303,9 @@
"id": "A String", # The ID associated with the value if available.
},
"tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
- "type": "A String", # The type of floodlight activity group. This is a required field that is read-only after insertion.
+ "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
"id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this floodlight activity group.This is a read-only field that can be left blank.
+ "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
},
],
}</pre>
@@ -366,9 +366,9 @@
"id": "A String", # The ID associated with the value if available.
},
"tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
- "type": "A String", # The type of floodlight activity group. This is a required field that is read-only after insertion.
+ "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
"id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this floodlight activity group.This is a read-only field that can be left blank.
+ "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
}
@@ -406,9 +406,9 @@
"id": "A String", # The ID associated with the value if available.
},
"tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
- "type": "A String", # The type of floodlight activity group. This is a required field that is read-only after insertion.
+ "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
"id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this floodlight activity group.This is a read-only field that can be left blank.
+ "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
}</pre>
</div>
@@ -452,9 +452,9 @@
"id": "A String", # The ID associated with the value if available.
},
"tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
- "type": "A String", # The type of floodlight activity group. This is a required field that is read-only after insertion.
+ "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
"id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this floodlight activity group.This is a read-only field that can be left blank.
+ "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
}
@@ -492,9 +492,9 @@
"id": "A String", # The ID associated with the value if available.
},
"tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
- "type": "A String", # The type of floodlight activity group. This is a required field that is read-only after insertion.
+ "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
"id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this floodlight activity group.This is a read-only field that can be left blank.
+ "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
}</pre>
</div>
diff --git a/docs/dyn/dfareporting_v2_0.floodlightConfigurations.html b/docs/dyn/dfareporting_v2_0.floodlightConfigurations.html
index 55d0da4..cb0f19a 100644
--- a/docs/dyn/dfareporting_v2_0.floodlightConfigurations.html
+++ b/docs/dyn/dfareporting_v2_0.floodlightConfigurations.html
@@ -101,7 +101,7 @@
{ # Contains properties of a Floodlight configuration.
"naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
"kind": "dfareporting#floodlightConfiguration", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
- "exposureToConversionEnabled": True or False, # Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
+ "exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
"lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
"clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
"postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
@@ -128,7 +128,7 @@
"userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
{ # User Defined Variable configuration.
"dataType": "A String", # Data type for the variable. This is a required field.
- "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 65 characters long, and cannot contain the following characters: """.
+ "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
"variableType": "A String", # Variable name in the tag. This is a required field.
},
],
@@ -170,7 +170,7 @@
{ # Contains properties of a Floodlight configuration.
"naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
"kind": "dfareporting#floodlightConfiguration", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
- "exposureToConversionEnabled": True or False, # Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
+ "exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
"lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
"clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
"postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
@@ -197,7 +197,7 @@
"userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
{ # User Defined Variable configuration.
"dataType": "A String", # Data type for the variable. This is a required field.
- "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 65 characters long, and cannot contain the following characters: """.
+ "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
"variableType": "A String", # Variable name in the tag. This is a required field.
},
],
@@ -239,7 +239,7 @@
{ # Contains properties of a Floodlight configuration.
"naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
"kind": "dfareporting#floodlightConfiguration", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
- "exposureToConversionEnabled": True or False, # Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
+ "exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
"lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
"clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
"postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
@@ -266,7 +266,7 @@
"userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
{ # User Defined Variable configuration.
"dataType": "A String", # Data type for the variable. This is a required field.
- "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 65 characters long, and cannot contain the following characters: """.
+ "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
"variableType": "A String", # Variable name in the tag. This is a required field.
},
],
@@ -298,7 +298,7 @@
{ # Contains properties of a Floodlight configuration.
"naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
"kind": "dfareporting#floodlightConfiguration", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
- "exposureToConversionEnabled": True or False, # Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
+ "exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
"lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
"clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
"postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
@@ -325,7 +325,7 @@
"userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
{ # User Defined Variable configuration.
"dataType": "A String", # Data type for the variable. This is a required field.
- "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 65 characters long, and cannot contain the following characters: """.
+ "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
"variableType": "A String", # Variable name in the tag. This is a required field.
},
],
@@ -363,7 +363,7 @@
{ # Contains properties of a Floodlight configuration.
"naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
"kind": "dfareporting#floodlightConfiguration", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
- "exposureToConversionEnabled": True or False, # Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
+ "exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
"lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
"clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
"postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
@@ -390,7 +390,7 @@
"userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
{ # User Defined Variable configuration.
"dataType": "A String", # Data type for the variable. This is a required field.
- "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 65 characters long, and cannot contain the following characters: """.
+ "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
"variableType": "A String", # Variable name in the tag. This is a required field.
},
],
@@ -422,7 +422,7 @@
{ # Contains properties of a Floodlight configuration.
"naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
"kind": "dfareporting#floodlightConfiguration", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
- "exposureToConversionEnabled": True or False, # Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
+ "exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
"lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
"clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
"postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
@@ -449,7 +449,7 @@
"userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
{ # User Defined Variable configuration.
"dataType": "A String", # Data type for the variable. This is a required field.
- "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 65 characters long, and cannot contain the following characters: """.
+ "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
"variableType": "A String", # Variable name in the tag. This is a required field.
},
],
diff --git a/docs/dyn/dns_v1beta1.managedZones.html b/docs/dyn/dns_v1beta1.managedZones.html
index 33d6b28..e82fec8 100644
--- a/docs/dyn/dns_v1beta1.managedZones.html
+++ b/docs/dyn/dns_v1beta1.managedZones.html
@@ -101,7 +101,7 @@
{ # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service.
"kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
- "description": "A String", # A string to associate with this resource for the user's convenience. Has no effect on the managed zone's function.
+ "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
"nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
"A String",
],
@@ -118,7 +118,7 @@
{ # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service.
"kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
- "description": "A String", # A string to associate with this resource for the user's convenience. Has no effect on the managed zone's function.
+ "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
"nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
"A String",
],
@@ -153,7 +153,7 @@
{ # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service.
"kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
- "description": "A String", # A string to associate with this resource for the user's convenience. Has no effect on the managed zone's function.
+ "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
"nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
"A String",
],
@@ -185,7 +185,7 @@
"managedZones": [ # The managed zone resources.
{ # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service.
"kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
- "description": "A String", # A string to associate with this resource for the user's convenience. Has no effect on the managed zone's function.
+ "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
"nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
"A String",
],
diff --git a/docs/dyn/genomics_v1beta2.referencesets.html b/docs/dyn/genomics_v1beta2.referencesets.html
index 73db80e..035b36b 100644
--- a/docs/dyn/genomics_v1beta2.referencesets.html
+++ b/docs/dyn/genomics_v1beta2.referencesets.html
@@ -94,7 +94,7 @@
An object of the form:
{ # A reference set is a set of references which typically comprise a reference assembly for a species, such as GRCh38 which is representative of the human genome. A reference set defines a common coordinate space for comparing reference-aligned experimental data. A reference set contains 1 or more references.
- "description": "A String", # Optional free text description of this reference set.
+ "description": "A String", # free text description of this reference set.
"sourceURI": "A String", # The URI from which the references were obtained.
"referenceIds": [ # The IDs of the reference objects that are part of this set. Reference.md5checksum must be unique within this set.
"A String",
@@ -139,7 +139,7 @@
"nextPageToken": "A String", # The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results. This field will be empty if there aren't any additional results.
"referenceSets": [ # The matching references sets.
{ # A reference set is a set of references which typically comprise a reference assembly for a species, such as GRCh38 which is representative of the human genome. A reference set defines a common coordinate space for comparing reference-aligned experimental data. A reference set contains 1 or more references.
- "description": "A String", # Optional free text description of this reference set.
+ "description": "A String", # free text description of this reference set.
"sourceURI": "A String", # The URI from which the references were obtained.
"referenceIds": [ # The IDs of the reference objects that are part of this set. Reference.md5checksum must be unique within this set.
"A String",
diff --git a/docs/dyn/oauth2_v2.userinfo.html b/docs/dyn/oauth2_v2.userinfo.html
index 8bc97cc..c3d5838 100644
--- a/docs/dyn/oauth2_v2.userinfo.html
+++ b/docs/dyn/oauth2_v2.userinfo.html
@@ -101,7 +101,7 @@
"email": "A String", # The user's email address.
"link": "A String", # URL of the profile page.
"given_name": "A String", # The user's first name.
- "id": "A String", # The focus obfuscated gaia id of the user.
+ "id": "A String", # The obfuscated ID of the user.
"hd": "A String", # The hosted domain e.g. example.com if the user is Google apps user.
"verified_email": true, # Boolean flag which is true if the email address is verified. Always verified because we only return the user's primary email address.
}</pre>
diff --git a/docs/dyn/oauth2_v2.userinfo.v2.me.html b/docs/dyn/oauth2_v2.userinfo.v2.me.html
index 2a1418f..5faa679 100644
--- a/docs/dyn/oauth2_v2.userinfo.v2.me.html
+++ b/docs/dyn/oauth2_v2.userinfo.v2.me.html
@@ -96,7 +96,7 @@
"email": "A String", # The user's email address.
"link": "A String", # URL of the profile page.
"given_name": "A String", # The user's first name.
- "id": "A String", # The focus obfuscated gaia id of the user.
+ "id": "A String", # The obfuscated ID of the user.
"hd": "A String", # The hosted domain e.g. example.com if the user is Google apps user.
"verified_email": true, # Boolean flag which is true if the email address is verified. Always verified because we only return the user's primary email address.
}</pre>
diff --git a/docs/dyn/prediction_v1_6.hostedmodels.html b/docs/dyn/prediction_v1_6.hostedmodels.html
index 69e85d1..b4d79fb 100644
--- a/docs/dyn/prediction_v1_6.hostedmodels.html
+++ b/docs/dyn/prediction_v1_6.hostedmodels.html
@@ -110,7 +110,7 @@
"label": "A String", # The class label.
},
],
- "outputValue": 3.14, # The estimated regression value (Regression models only).
+ "outputValue": "A String", # The estimated regression value (Regression models only).
"selfLink": "A String", # A URL to re-request this resource.
}</pre>
</div>
diff --git a/docs/dyn/prediction_v1_6.trainedmodels.html b/docs/dyn/prediction_v1_6.trainedmodels.html
index c591ff3..a0de137 100644
--- a/docs/dyn/prediction_v1_6.trainedmodels.html
+++ b/docs/dyn/prediction_v1_6.trainedmodels.html
@@ -376,7 +376,7 @@
"label": "A String", # The class label.
},
],
- "outputValue": 3.14, # The estimated regression value (Regression models only).
+ "outputValue": "A String", # The estimated regression value (Regression models only).
"selfLink": "A String", # A URL to re-request this resource.
}</pre>
</div>
diff --git a/docs/dyn/replicapoolupdater_v1beta1.rollingUpdates.html b/docs/dyn/replicapoolupdater_v1beta1.rollingUpdates.html
index 542148c..6df9e24 100644
--- a/docs/dyn/replicapoolupdater_v1beta1.rollingUpdates.html
+++ b/docs/dyn/replicapoolupdater_v1beta1.rollingUpdates.html
@@ -185,9 +185,12 @@
"kind": "replicapoolupdater#rollingUpdate", # [Output Only] Type of the resource.
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
"user": "A String", # [Output Only] User who requested the update, for example: user@example.com.
- "instanceGroup": "A String", # Fully-qualified URL of an instance group being updated. Exactly one of instanceGroupManager and instanceGroup must be set.
+ "instanceGroup": "A String", # Fully-qualified URL of an instance group being updated. Exactly one of instanceGroupManager, instanceGroup and instance list must be set.
+ "instances": [ # List of fully-qualified URLs of instances to be updated. Exactly one of instanceGroupManager, instanceGroup and instance list must be set.
+ "A String",
+ ],
"instanceTemplate": "A String", # Fully-qualified URL of an instance template to apply.
- "actionType": "A String", # Specifies the action to take for each instance within the instance group. This can be RECREATE which will recreate each instance and is only available for managed instance groups. It can also be REBOOT which performs a soft reboot for each instance and is only available for regular (non-managed) instance groups.
+ "actionType": "A String", # Specifies the action to take for each instance within the instance group. This can be RECREATE which will recreate each instance and is only available for managed instance groups. It can also be REBOOT which performs a soft reboot for each instance and is only available for regular (non-managed) instance groups and explicit lists of instances.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the update.
"error": { # [Output Only] Errors that occurred during rolling update.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
@@ -202,9 +205,6 @@
"instanceStartupTimeoutSec": 42, # Maximum amount of time we will wait after finishing all steps until we receive HEALTHY state for instance. If this deadline is exceeded instance update is considered as failed.
"maxNumConcurrentInstances": 42, # Maximum number of instances that can be updated simultaneously (concurrently). An update of an instance starts when the instance is about to be restarted and finishes after the instance has been restarted and the sleep period (defined by sleepAfterInstanceRestartSec) has passed.
"minInstanceUpdateTimeSec": 42, # Specifies minimum amount of time we will spend on updating single instance, measuring at the start of the first update action (e.g. Recreate call on Instance Group Manager or Stop call on Instance resource). If actual instance update takes less time we will simply sleep before proceeding with next instance.
- "canary": { # Parameters of a canary phase. If absent, canary will NOT be performed.
- "numInstances": 42, # Number of instances updated as a part of canary phase. If absent, the default number of instances will be used.
- },
"sleepAfterInstanceRestartSec": 42, # Time period after the instance has been restarted but before marking the update of this instance as done. This field is deprecated and ignored by Rolling Updater.
"maxNumFailedInstances": 42, # Maximum number of instance updates that can fail without failing the group update. Instance update is considered failed if any of it's update actions (e.g. Stop call on Instance resource in Rolling Reboot) failed with permanent failure, or if after finishing all update actions this instance is in UNHEALTHY state.
"autoPauseAfterInstances": 42, # Number of instances updated before the update gets automatically paused.
@@ -213,7 +213,7 @@
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
"selfLink": "A String", # [Output Only] The fully qualified URL for the resource.
- "instanceGroupManager": "A String", # Fully-qualified URL of an instance group manager being updated. Exactly one of instanceGroupManager and instanceGroup must be set.
+ "instanceGroupManager": "A String", # Fully-qualified URL of an instance group manager being updated. Exactly one of instanceGroupManager, instanceGroup and instance list must be set.
}</pre>
</div>
@@ -238,9 +238,12 @@
"kind": "replicapoolupdater#rollingUpdate", # [Output Only] Type of the resource.
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
"user": "A String", # [Output Only] User who requested the update, for example: user@example.com.
- "instanceGroup": "A String", # Fully-qualified URL of an instance group being updated. Exactly one of instanceGroupManager and instanceGroup must be set.
+ "instanceGroup": "A String", # Fully-qualified URL of an instance group being updated. Exactly one of instanceGroupManager, instanceGroup and instance list must be set.
+ "instances": [ # List of fully-qualified URLs of instances to be updated. Exactly one of instanceGroupManager, instanceGroup and instance list must be set.
+ "A String",
+ ],
"instanceTemplate": "A String", # Fully-qualified URL of an instance template to apply.
- "actionType": "A String", # Specifies the action to take for each instance within the instance group. This can be RECREATE which will recreate each instance and is only available for managed instance groups. It can also be REBOOT which performs a soft reboot for each instance and is only available for regular (non-managed) instance groups.
+ "actionType": "A String", # Specifies the action to take for each instance within the instance group. This can be RECREATE which will recreate each instance and is only available for managed instance groups. It can also be REBOOT which performs a soft reboot for each instance and is only available for regular (non-managed) instance groups and explicit lists of instances.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the update.
"error": { # [Output Only] Errors that occurred during rolling update.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
@@ -255,9 +258,6 @@
"instanceStartupTimeoutSec": 42, # Maximum amount of time we will wait after finishing all steps until we receive HEALTHY state for instance. If this deadline is exceeded instance update is considered as failed.
"maxNumConcurrentInstances": 42, # Maximum number of instances that can be updated simultaneously (concurrently). An update of an instance starts when the instance is about to be restarted and finishes after the instance has been restarted and the sleep period (defined by sleepAfterInstanceRestartSec) has passed.
"minInstanceUpdateTimeSec": 42, # Specifies minimum amount of time we will spend on updating single instance, measuring at the start of the first update action (e.g. Recreate call on Instance Group Manager or Stop call on Instance resource). If actual instance update takes less time we will simply sleep before proceeding with next instance.
- "canary": { # Parameters of a canary phase. If absent, canary will NOT be performed.
- "numInstances": 42, # Number of instances updated as a part of canary phase. If absent, the default number of instances will be used.
- },
"sleepAfterInstanceRestartSec": 42, # Time period after the instance has been restarted but before marking the update of this instance as done. This field is deprecated and ignored by Rolling Updater.
"maxNumFailedInstances": 42, # Maximum number of instance updates that can fail without failing the group update. Instance update is considered failed if any of it's update actions (e.g. Stop call on Instance resource in Rolling Reboot) failed with permanent failure, or if after finishing all update actions this instance is in UNHEALTHY state.
"autoPauseAfterInstances": 42, # Number of instances updated before the update gets automatically paused.
@@ -266,7 +266,7 @@
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
"selfLink": "A String", # [Output Only] The fully qualified URL for the resource.
- "instanceGroupManager": "A String", # Fully-qualified URL of an instance group manager being updated. Exactly one of instanceGroupManager and instanceGroup must be set.
+ "instanceGroupManager": "A String", # Fully-qualified URL of an instance group manager being updated. Exactly one of instanceGroupManager, instanceGroup and instance list must be set.
}
@@ -347,9 +347,12 @@
"kind": "replicapoolupdater#rollingUpdate", # [Output Only] Type of the resource.
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
"user": "A String", # [Output Only] User who requested the update, for example: user@example.com.
- "instanceGroup": "A String", # Fully-qualified URL of an instance group being updated. Exactly one of instanceGroupManager and instanceGroup must be set.
+ "instanceGroup": "A String", # Fully-qualified URL of an instance group being updated. Exactly one of instanceGroupManager, instanceGroup and instance list must be set.
+ "instances": [ # List of fully-qualified URLs of instances to be updated. Exactly one of instanceGroupManager, instanceGroup and instance list must be set.
+ "A String",
+ ],
"instanceTemplate": "A String", # Fully-qualified URL of an instance template to apply.
- "actionType": "A String", # Specifies the action to take for each instance within the instance group. This can be RECREATE which will recreate each instance and is only available for managed instance groups. It can also be REBOOT which performs a soft reboot for each instance and is only available for regular (non-managed) instance groups.
+ "actionType": "A String", # Specifies the action to take for each instance within the instance group. This can be RECREATE which will recreate each instance and is only available for managed instance groups. It can also be REBOOT which performs a soft reboot for each instance and is only available for regular (non-managed) instance groups and explicit lists of instances.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the update.
"error": { # [Output Only] Errors that occurred during rolling update.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
@@ -364,9 +367,6 @@
"instanceStartupTimeoutSec": 42, # Maximum amount of time we will wait after finishing all steps until we receive HEALTHY state for instance. If this deadline is exceeded instance update is considered as failed.
"maxNumConcurrentInstances": 42, # Maximum number of instances that can be updated simultaneously (concurrently). An update of an instance starts when the instance is about to be restarted and finishes after the instance has been restarted and the sleep period (defined by sleepAfterInstanceRestartSec) has passed.
"minInstanceUpdateTimeSec": 42, # Specifies minimum amount of time we will spend on updating single instance, measuring at the start of the first update action (e.g. Recreate call on Instance Group Manager or Stop call on Instance resource). If actual instance update takes less time we will simply sleep before proceeding with next instance.
- "canary": { # Parameters of a canary phase. If absent, canary will NOT be performed.
- "numInstances": 42, # Number of instances updated as a part of canary phase. If absent, the default number of instances will be used.
- },
"sleepAfterInstanceRestartSec": 42, # Time period after the instance has been restarted but before marking the update of this instance as done. This field is deprecated and ignored by Rolling Updater.
"maxNumFailedInstances": 42, # Maximum number of instance updates that can fail without failing the group update. Instance update is considered failed if any of it's update actions (e.g. Stop call on Instance resource in Rolling Reboot) failed with permanent failure, or if after finishing all update actions this instance is in UNHEALTHY state.
"autoPauseAfterInstances": 42, # Number of instances updated before the update gets automatically paused.
@@ -375,7 +375,7 @@
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
"selfLink": "A String", # [Output Only] The fully qualified URL for the resource.
- "instanceGroupManager": "A String", # Fully-qualified URL of an instance group manager being updated. Exactly one of instanceGroupManager and instanceGroup must be set.
+ "instanceGroupManager": "A String", # Fully-qualified URL of an instance group manager being updated. Exactly one of instanceGroupManager, instanceGroup and instance list must be set.
},
],
"kind": "replicapoolupdater#rollingUpdateList", # [Output Only] Type of the resource.