Update docs (#291)
diff --git a/docs/dyn/acceleratedmobilepageurl_v1.ampUrls.html b/docs/dyn/acceleratedmobilepageurl_v1.ampUrls.html
index 0732621..02a5f45 100644
--- a/docs/dyn/acceleratedmobilepageurl_v1.ampUrls.html
+++ b/docs/dyn/acceleratedmobilepageurl_v1.ampUrls.html
@@ -111,7 +111,8 @@
# only once.
{ # AMP URL response for a requested URL.
"ampUrl": "A String", # The AMP URL pointing to the publisher's web server.
- "cdnAmpUrl": "A String", # The [AMP Cache URL](/amp/cache/overview#amp-cache-url-format) pointing to the cached document in the Google AMP Cache.
+ "cdnAmpUrl": "A String", # The [AMP Cache URL](/amp/cache/overview#amp-cache-url-format) pointing to
+ # the cached document in the Google AMP Cache.
"originalUrl": "A String", # The original non-AMP URL.
},
],
diff --git a/docs/dyn/adexchangebuyer2_v2beta1.accounts.clients.html b/docs/dyn/adexchangebuyer2_v2beta1.accounts.clients.html
index 791a96b..82b8290 100644
--- a/docs/dyn/adexchangebuyer2_v2beta1.accounts.clients.html
+++ b/docs/dyn/adexchangebuyer2_v2beta1.accounts.clients.html
@@ -126,7 +126,7 @@
"entityType": "A String", # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
"role": "A String", # The role which is assigned to the client buyer. Each role implies a set of
# permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,
- # `CLIENT_DEAL_NEGOTIATOR`, or `CLIENT_DEAL_APPROVER`.
+ # `CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.
"visibleToSeller": True or False, # Whether the client buyer will be visible to sellers.
"entityId": "A String", # Numerical identifier of the client entity.
# The entity can be an advertiser, a brand, or an agency.
@@ -174,7 +174,7 @@
"entityType": "A String", # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
"role": "A String", # The role which is assigned to the client buyer. Each role implies a set of
# permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,
- # `CLIENT_DEAL_NEGOTIATOR`, or `CLIENT_DEAL_APPROVER`.
+ # `CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.
"visibleToSeller": True or False, # Whether the client buyer will be visible to sellers.
"entityId": "A String", # Numerical identifier of the client entity.
# The entity can be an advertiser, a brand, or an agency.
@@ -230,7 +230,7 @@
"entityType": "A String", # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
"role": "A String", # The role which is assigned to the client buyer. Each role implies a set of
# permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,
- # `CLIENT_DEAL_NEGOTIATOR`, or `CLIENT_DEAL_APPROVER`.
+ # `CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.
"visibleToSeller": True or False, # Whether the client buyer will be visible to sellers.
"entityId": "A String", # Numerical identifier of the client entity.
# The entity can be an advertiser, a brand, or an agency.
@@ -300,7 +300,7 @@
"entityType": "A String", # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
"role": "A String", # The role which is assigned to the client buyer. Each role implies a set of
# permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,
- # `CLIENT_DEAL_NEGOTIATOR`, or `CLIENT_DEAL_APPROVER`.
+ # `CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.
"visibleToSeller": True or False, # Whether the client buyer will be visible to sellers.
"entityId": "A String", # Numerical identifier of the client entity.
# The entity can be an advertiser, a brand, or an agency.
@@ -368,7 +368,7 @@
"entityType": "A String", # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
"role": "A String", # The role which is assigned to the client buyer. Each role implies a set of
# permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,
- # `CLIENT_DEAL_NEGOTIATOR`, or `CLIENT_DEAL_APPROVER`.
+ # `CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.
"visibleToSeller": True or False, # Whether the client buyer will be visible to sellers.
"entityId": "A String", # Numerical identifier of the client entity.
# The entity can be an advertiser, a brand, or an agency.
@@ -416,7 +416,7 @@
"entityType": "A String", # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
"role": "A String", # The role which is assigned to the client buyer. Each role implies a set of
# permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,
- # `CLIENT_DEAL_NEGOTIATOR`, or `CLIENT_DEAL_APPROVER`.
+ # `CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.
"visibleToSeller": True or False, # Whether the client buyer will be visible to sellers.
"entityId": "A String", # Numerical identifier of the client entity.
# The entity can be an advertiser, a brand, or an agency.
diff --git a/docs/dyn/adexchangebuyer2_v2beta1.accounts.clients.invitations.html b/docs/dyn/adexchangebuyer2_v2beta1.accounts.clients.invitations.html
index a8c07ad..1dbaef9 100644
--- a/docs/dyn/adexchangebuyer2_v2beta1.accounts.clients.invitations.html
+++ b/docs/dyn/adexchangebuyer2_v2beta1.accounts.clients.invitations.html
@@ -99,8 +99,8 @@
body: object, The request body. (required)
The object takes the form of:
-{ # An invitation for a new client user to get access to the AdExchange Buyer UI.
- #
+{ # An invitation for a new client user to get access to the Ad Exchange
+ # Buyer UI.
# All fields are required unless otherwise specified.
"clientAccountId": "A String", # Numerical account ID of the client buyer
# that the invited user is associated with.
@@ -120,8 +120,8 @@
Returns:
An object of the form:
- { # An invitation for a new client user to get access to the AdExchange Buyer UI.
- #
+ { # An invitation for a new client user to get access to the Ad Exchange
+ # Buyer UI.
# All fields are required unless otherwise specified.
"clientAccountId": "A String", # Numerical account ID of the client buyer
# that the invited user is associated with.
@@ -151,8 +151,8 @@
Returns:
An object of the form:
- { # An invitation for a new client user to get access to the AdExchange Buyer UI.
- #
+ { # An invitation for a new client user to get access to the Ad Exchange
+ # Buyer UI.
# All fields are required unless otherwise specified.
"clientAccountId": "A String", # Numerical account ID of the client buyer
# that the invited user is associated with.
@@ -203,8 +203,8 @@
# method to retrieve the next
# page of results.
"invitations": [ # The returned list of client users.
- { # An invitation for a new client user to get access to the AdExchange Buyer UI.
- #
+ { # An invitation for a new client user to get access to the Ad Exchange
+ # Buyer UI.
# All fields are required unless otherwise specified.
"clientAccountId": "A String", # Numerical account ID of the client buyer
# that the invited user is associated with.
diff --git a/docs/dyn/adexchangebuyer_v1_4.accounts.html b/docs/dyn/adexchangebuyer_v1_4.accounts.html
index 6be850a..bab5f56 100644
--- a/docs/dyn/adexchangebuyer_v1_4.accounts.html
+++ b/docs/dyn/adexchangebuyer_v1_4.accounts.html
@@ -81,10 +81,10 @@
<code><a href="#list">list()</a></code></p>
<p class="firstline">Retrieves the authenticated user's list of accounts.</p>
<p class="toc_element">
- <code><a href="#patch">patch(id, body)</a></code></p>
+ <code><a href="#patch">patch(id, body, confirmUnsafeAccountChange=None)</a></code></p>
<p class="firstline">Updates an existing account. This method supports patch semantics.</p>
<p class="toc_element">
- <code><a href="#update">update(id, body)</a></code></p>
+ <code><a href="#update">update(id, body, confirmUnsafeAccountChange=None)</a></code></p>
<p class="firstline">Updates an existing account.</p>
<h3>Method Details</h3>
<div class="method">
@@ -166,7 +166,7 @@
</div>
<div class="method">
- <code class="details" id="patch">patch(id, body)</code>
+ <code class="details" id="patch">patch(id, body, confirmUnsafeAccountChange=None)</code>
<pre>Updates an existing account. This method supports patch semantics.
Args:
@@ -200,6 +200,7 @@
"cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
}
+ confirmUnsafeAccountChange: boolean, Confirmation for erasing bidder and cookie matching urls.
Returns:
An object of the form:
@@ -232,7 +233,7 @@
</div>
<div class="method">
- <code class="details" id="update">update(id, body)</code>
+ <code class="details" id="update">update(id, body, confirmUnsafeAccountChange=None)</code>
<pre>Updates an existing account.
Args:
@@ -266,6 +267,7 @@
"cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
}
+ confirmUnsafeAccountChange: boolean, Confirmation for erasing bidder and cookie matching urls.
Returns:
An object of the form:
diff --git a/docs/dyn/adexchangebuyer_v1_4.creatives.html b/docs/dyn/adexchangebuyer_v1_4.creatives.html
index cbdf65a..babdfbc 100644
--- a/docs/dyn/adexchangebuyer_v1_4.creatives.html
+++ b/docs/dyn/adexchangebuyer_v1_4.creatives.html
@@ -87,6 +87,9 @@
<code><a href="#list">list(dealsStatusFilter=None, openAuctionStatusFilter=None, pageToken=None, maxResults=None, buyerCreativeId=None, accountId=None)</a></code></p>
<p class="firstline">Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission.</p>
<p class="toc_element">
+ <code><a href="#listDeals">listDeals(accountId, buyerCreativeId)</a></code></p>
+<p class="firstline">Lists the external deal ids associated with the creative.</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>
<p class="toc_element">
@@ -129,7 +132,7 @@
"A String",
],
"accountId": 42, # Account id.
- "videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
+ "videoURL": "A String", # The URL to fetch a video ad. If set, HTMLSnippet and the nativeAd should not be set. Note, this is diffrent from resource.native_ad.video_url above.
"clickThroughUrl": [ # The set of destination urls for the snippet.
"A String",
],
@@ -137,10 +140,11 @@
"A String",
],
"width": 42, # Ad width.
- "nativeAd": { # If nativeAd is set, HTMLSnippet and videoURL should not be set.
+ "nativeAd": { # If nativeAd is set, HTMLSnippet and the videoURL outside of nativeAd should not be set. (The videoURL inside nativeAd can be set.)
"body": "A String", # A long description of the ad.
"advertiser": "A String",
"store": "A String", # The URL to the app store to purchase/download the promoted app.
+ "videoURL": "A String",
"headline": "A String", # A short title for the ad.
"image": { # A large image.
"url": "A String",
@@ -271,7 +275,7 @@
"A String",
],
"accountId": 42, # Account id.
- "videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
+ "videoURL": "A String", # The URL to fetch a video ad. If set, HTMLSnippet and the nativeAd should not be set. Note, this is diffrent from resource.native_ad.video_url above.
"clickThroughUrl": [ # The set of destination urls for the snippet.
"A String",
],
@@ -279,10 +283,11 @@
"A String",
],
"width": 42, # Ad width.
- "nativeAd": { # If nativeAd is set, HTMLSnippet and videoURL should not be set.
+ "nativeAd": { # If nativeAd is set, HTMLSnippet and the videoURL outside of nativeAd should not be set. (The videoURL inside nativeAd can be set.)
"body": "A String", # A long description of the ad.
"advertiser": "A String",
"store": "A String", # The URL to the app store to purchase/download the promoted app.
+ "videoURL": "A String",
"headline": "A String", # A short title for the ad.
"image": { # A large image.
"url": "A String",
@@ -408,7 +413,7 @@
"A String",
],
"accountId": 42, # Account id.
- "videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
+ "videoURL": "A String", # The URL to fetch a video ad. If set, HTMLSnippet and the nativeAd should not be set. Note, this is diffrent from resource.native_ad.video_url above.
"clickThroughUrl": [ # The set of destination urls for the snippet.
"A String",
],
@@ -416,10 +421,11 @@
"A String",
],
"width": 42, # Ad width.
- "nativeAd": { # If nativeAd is set, HTMLSnippet and videoURL should not be set.
+ "nativeAd": { # If nativeAd is set, HTMLSnippet and the videoURL outside of nativeAd should not be set. (The videoURL inside nativeAd can be set.)
"body": "A String", # A long description of the ad.
"advertiser": "A String",
"store": "A String", # The URL to the app store to purchase/download the promoted app.
+ "videoURL": "A String",
"headline": "A String", # A short title for the ad.
"image": { # A large image.
"url": "A String",
@@ -570,7 +576,7 @@
"A String",
],
"accountId": 42, # Account id.
- "videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
+ "videoURL": "A String", # The URL to fetch a video ad. If set, HTMLSnippet and the nativeAd should not be set. Note, this is diffrent from resource.native_ad.video_url above.
"clickThroughUrl": [ # The set of destination urls for the snippet.
"A String",
],
@@ -578,10 +584,11 @@
"A String",
],
"width": 42, # Ad width.
- "nativeAd": { # If nativeAd is set, HTMLSnippet and videoURL should not be set.
+ "nativeAd": { # If nativeAd is set, HTMLSnippet and the videoURL outside of nativeAd should not be set. (The videoURL inside nativeAd can be set.)
"body": "A String", # A long description of the ad.
"advertiser": "A String",
"store": "A String", # The URL to the app store to purchase/download the promoted app.
+ "videoURL": "A String",
"headline": "A String", # A short title for the ad.
"image": { # A large image.
"url": "A String",
@@ -694,6 +701,29 @@
</div>
<div class="method">
+ <code class="details" id="listDeals">listDeals(accountId, buyerCreativeId)</code>
+ <pre>Lists the external deal ids associated with the creative.
+
+Args:
+ accountId: integer, The id for the account that will serve this creative. (required)
+ buyerCreativeId: string, The buyer-specific id for this creative. (required)
+
+Returns:
+ An object of the form:
+
+ { # The external deal ids associated with a creative.
+ "dealStatuses": [ # A list of external deal ids and ARC approval status.
+ {
+ "webPropertyId": 42, # Publisher ID.
+ "dealId": "A String", # External deal ID.
+ "arcStatus": "A String", # ARC approval status.
+ },
+ ],
+ "kind": "adexchangebuyer#creativeDealIds", # Resource type.
+ }</pre>
+</div>
+
+<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
diff --git a/docs/dyn/adexchangebuyer_v1_4.marketplacedeals.html b/docs/dyn/adexchangebuyer_v1_4.marketplacedeals.html
index 22df326..5c4a11c 100644
--- a/docs/dyn/adexchangebuyer_v1_4.marketplacedeals.html
+++ b/docs/dyn/adexchangebuyer_v1_4.marketplacedeals.html
@@ -118,6 +118,7 @@
"name": "A String", # The name of the contact.
},
],
+ "isRfpTemplate": True or False, # Indicates whether the current deal is a RFP template. RFP template is created by buyer and not based on seller created products.
"webPropertyCode": "A String",
"proposalId": "A String",
"inventoryDescription": "A String", # Description for the deal terms. (updatable)
@@ -135,30 +136,7 @@
},
"terms": { # The negotiable terms of the deal. (updatable)
"brandingType": "A String", # Visibilty of the URL in bid requests.
- "estimatedGrossSpend": { # Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller.
- "pricingType": "A String", # The pricing type for the deal/product.
- "currencyCode": "A String", # The currency code for the price.
- "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
- "amountMicros": 3.14, # The price value in micros.
- },
- "sellerTimeZone": "A String", # For deals with Cost Per Day billing, defines the timezone used to mark the boundaries of a day (buyer-readonly)
- "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day Can be set by buyer or seller.
- "nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals.
- "fixedPrices": [ # Fixed price for the specified buyer.
- { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
- "auctionTier": "A String", # Optional access type for this buyer.
- "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
- "accountId": "A String", # Adx account id of the buyer.
- },
- "price": { # The specified price
- "pricingType": "A String", # The pricing type for the deal/product.
- "currencyCode": "A String", # The currency code for the price.
- "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
- "amountMicros": 3.14, # The price value in micros.
- },
- },
- ],
- },
+ "crossListedExternalDealIdType": "A String", # Indicates that this ExternalDealId exists under at least two different AdxInventoryDeals. Currently, the only case that the same ExternalDealId will exist is programmatic cross sell case.
"guaranteedFixedPriceTerms": { # The terms for guaranteed fixed price deals.
"guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy.
"fixedPrices": [ # Fixed price for the specified buyer.
@@ -189,6 +167,30 @@
"currencyConversionTimeMs": "A String", # The timestamp (in ms since epoch) when the original reservation price for the deal was first converted to DFP currency. This is used to convert the contracted price into advertiser's currency without discrepancy.
},
},
+ "sellerTimeZone": "A String", # For deals with Cost Per Day billing, defines the timezone used to mark the boundaries of a day (buyer-readonly)
+ "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day Can be set by buyer or seller.
+ "nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals.
+ "fixedPrices": [ # Fixed price for the specified buyer.
+ { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+ "auctionTier": "A String", # Optional access type for this buyer.
+ "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "price": { # The specified price
+ "pricingType": "A String", # The pricing type for the deal/product.
+ "currencyCode": "A String", # The currency code for the price.
+ "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
+ "amountMicros": 3.14, # The price value in micros.
+ },
+ },
+ ],
+ },
+ "estimatedGrossSpend": { # Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller.
+ "pricingType": "A String", # The pricing type for the deal/product.
+ "currencyCode": "A String", # The currency code for the price.
+ "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
+ "amountMicros": 3.14, # The price value in micros.
+ },
"rubiconNonGuaranteedTerms": { # The terms for rubicon non-guaranteed deals.
"priorityPrice": { # Optional price for Rubicon priority access in the auction.
"pricingType": "A String", # The pricing type for the deal/product.
@@ -341,6 +343,7 @@
"name": "A String", # The name of the contact.
},
],
+ "isRfpTemplate": True or False, # Indicates whether the current deal is a RFP template. RFP template is created by buyer and not based on seller created products.
"webPropertyCode": "A String",
"proposalId": "A String",
"inventoryDescription": "A String", # Description for the deal terms. (updatable)
@@ -358,30 +361,7 @@
},
"terms": { # The negotiable terms of the deal. (updatable)
"brandingType": "A String", # Visibilty of the URL in bid requests.
- "estimatedGrossSpend": { # Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller.
- "pricingType": "A String", # The pricing type for the deal/product.
- "currencyCode": "A String", # The currency code for the price.
- "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
- "amountMicros": 3.14, # The price value in micros.
- },
- "sellerTimeZone": "A String", # For deals with Cost Per Day billing, defines the timezone used to mark the boundaries of a day (buyer-readonly)
- "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day Can be set by buyer or seller.
- "nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals.
- "fixedPrices": [ # Fixed price for the specified buyer.
- { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
- "auctionTier": "A String", # Optional access type for this buyer.
- "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
- "accountId": "A String", # Adx account id of the buyer.
- },
- "price": { # The specified price
- "pricingType": "A String", # The pricing type for the deal/product.
- "currencyCode": "A String", # The currency code for the price.
- "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
- "amountMicros": 3.14, # The price value in micros.
- },
- },
- ],
- },
+ "crossListedExternalDealIdType": "A String", # Indicates that this ExternalDealId exists under at least two different AdxInventoryDeals. Currently, the only case that the same ExternalDealId will exist is programmatic cross sell case.
"guaranteedFixedPriceTerms": { # The terms for guaranteed fixed price deals.
"guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy.
"fixedPrices": [ # Fixed price for the specified buyer.
@@ -412,6 +392,30 @@
"currencyConversionTimeMs": "A String", # The timestamp (in ms since epoch) when the original reservation price for the deal was first converted to DFP currency. This is used to convert the contracted price into advertiser's currency without discrepancy.
},
},
+ "sellerTimeZone": "A String", # For deals with Cost Per Day billing, defines the timezone used to mark the boundaries of a day (buyer-readonly)
+ "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day Can be set by buyer or seller.
+ "nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals.
+ "fixedPrices": [ # Fixed price for the specified buyer.
+ { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+ "auctionTier": "A String", # Optional access type for this buyer.
+ "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "price": { # The specified price
+ "pricingType": "A String", # The pricing type for the deal/product.
+ "currencyCode": "A String", # The currency code for the price.
+ "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
+ "amountMicros": 3.14, # The price value in micros.
+ },
+ },
+ ],
+ },
+ "estimatedGrossSpend": { # Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller.
+ "pricingType": "A String", # The pricing type for the deal/product.
+ "currencyCode": "A String", # The currency code for the price.
+ "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
+ "amountMicros": 3.14, # The price value in micros.
+ },
"rubiconNonGuaranteedTerms": { # The terms for rubicon non-guaranteed deals.
"priorityPrice": { # Optional price for Rubicon priority access in the auction.
"pricingType": "A String", # The pricing type for the deal/product.
@@ -559,6 +563,7 @@
"name": "A String", # The name of the contact.
},
],
+ "isRfpTemplate": True or False, # Indicates whether the current deal is a RFP template. RFP template is created by buyer and not based on seller created products.
"webPropertyCode": "A String",
"proposalId": "A String",
"inventoryDescription": "A String", # Description for the deal terms. (updatable)
@@ -576,30 +581,7 @@
},
"terms": { # The negotiable terms of the deal. (updatable)
"brandingType": "A String", # Visibilty of the URL in bid requests.
- "estimatedGrossSpend": { # Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller.
- "pricingType": "A String", # The pricing type for the deal/product.
- "currencyCode": "A String", # The currency code for the price.
- "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
- "amountMicros": 3.14, # The price value in micros.
- },
- "sellerTimeZone": "A String", # For deals with Cost Per Day billing, defines the timezone used to mark the boundaries of a day (buyer-readonly)
- "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day Can be set by buyer or seller.
- "nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals.
- "fixedPrices": [ # Fixed price for the specified buyer.
- { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
- "auctionTier": "A String", # Optional access type for this buyer.
- "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
- "accountId": "A String", # Adx account id of the buyer.
- },
- "price": { # The specified price
- "pricingType": "A String", # The pricing type for the deal/product.
- "currencyCode": "A String", # The currency code for the price.
- "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
- "amountMicros": 3.14, # The price value in micros.
- },
- },
- ],
- },
+ "crossListedExternalDealIdType": "A String", # Indicates that this ExternalDealId exists under at least two different AdxInventoryDeals. Currently, the only case that the same ExternalDealId will exist is programmatic cross sell case.
"guaranteedFixedPriceTerms": { # The terms for guaranteed fixed price deals.
"guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy.
"fixedPrices": [ # Fixed price for the specified buyer.
@@ -630,6 +612,30 @@
"currencyConversionTimeMs": "A String", # The timestamp (in ms since epoch) when the original reservation price for the deal was first converted to DFP currency. This is used to convert the contracted price into advertiser's currency without discrepancy.
},
},
+ "sellerTimeZone": "A String", # For deals with Cost Per Day billing, defines the timezone used to mark the boundaries of a day (buyer-readonly)
+ "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day Can be set by buyer or seller.
+ "nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals.
+ "fixedPrices": [ # Fixed price for the specified buyer.
+ { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+ "auctionTier": "A String", # Optional access type for this buyer.
+ "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "price": { # The specified price
+ "pricingType": "A String", # The pricing type for the deal/product.
+ "currencyCode": "A String", # The currency code for the price.
+ "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
+ "amountMicros": 3.14, # The price value in micros.
+ },
+ },
+ ],
+ },
+ "estimatedGrossSpend": { # Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller.
+ "pricingType": "A String", # The pricing type for the deal/product.
+ "currencyCode": "A String", # The currency code for the price.
+ "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
+ "amountMicros": 3.14, # The price value in micros.
+ },
"rubiconNonGuaranteedTerms": { # The terms for rubicon non-guaranteed deals.
"priorityPrice": { # Optional price for Rubicon priority access in the auction.
"pricingType": "A String", # The pricing type for the deal/product.
@@ -784,6 +790,7 @@
"name": "A String", # The name of the contact.
},
],
+ "isRfpTemplate": True or False, # Indicates whether the current deal is a RFP template. RFP template is created by buyer and not based on seller created products.
"webPropertyCode": "A String",
"proposalId": "A String",
"inventoryDescription": "A String", # Description for the deal terms. (updatable)
@@ -801,30 +808,7 @@
},
"terms": { # The negotiable terms of the deal. (updatable)
"brandingType": "A String", # Visibilty of the URL in bid requests.
- "estimatedGrossSpend": { # Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller.
- "pricingType": "A String", # The pricing type for the deal/product.
- "currencyCode": "A String", # The currency code for the price.
- "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
- "amountMicros": 3.14, # The price value in micros.
- },
- "sellerTimeZone": "A String", # For deals with Cost Per Day billing, defines the timezone used to mark the boundaries of a day (buyer-readonly)
- "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day Can be set by buyer or seller.
- "nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals.
- "fixedPrices": [ # Fixed price for the specified buyer.
- { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
- "auctionTier": "A String", # Optional access type for this buyer.
- "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
- "accountId": "A String", # Adx account id of the buyer.
- },
- "price": { # The specified price
- "pricingType": "A String", # The pricing type for the deal/product.
- "currencyCode": "A String", # The currency code for the price.
- "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
- "amountMicros": 3.14, # The price value in micros.
- },
- },
- ],
- },
+ "crossListedExternalDealIdType": "A String", # Indicates that this ExternalDealId exists under at least two different AdxInventoryDeals. Currently, the only case that the same ExternalDealId will exist is programmatic cross sell case.
"guaranteedFixedPriceTerms": { # The terms for guaranteed fixed price deals.
"guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy.
"fixedPrices": [ # Fixed price for the specified buyer.
@@ -855,6 +839,30 @@
"currencyConversionTimeMs": "A String", # The timestamp (in ms since epoch) when the original reservation price for the deal was first converted to DFP currency. This is used to convert the contracted price into advertiser's currency without discrepancy.
},
},
+ "sellerTimeZone": "A String", # For deals with Cost Per Day billing, defines the timezone used to mark the boundaries of a day (buyer-readonly)
+ "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day Can be set by buyer or seller.
+ "nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals.
+ "fixedPrices": [ # Fixed price for the specified buyer.
+ { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+ "auctionTier": "A String", # Optional access type for this buyer.
+ "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "price": { # The specified price
+ "pricingType": "A String", # The pricing type for the deal/product.
+ "currencyCode": "A String", # The currency code for the price.
+ "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
+ "amountMicros": 3.14, # The price value in micros.
+ },
+ },
+ ],
+ },
+ "estimatedGrossSpend": { # Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller.
+ "pricingType": "A String", # The pricing type for the deal/product.
+ "currencyCode": "A String", # The currency code for the price.
+ "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
+ "amountMicros": 3.14, # The price value in micros.
+ },
"rubiconNonGuaranteedTerms": { # The terms for rubicon non-guaranteed deals.
"priorityPrice": { # Optional price for Rubicon priority access in the auction.
"pricingType": "A String", # The pricing type for the deal/product.
@@ -1006,6 +1014,7 @@
"name": "A String", # The name of the contact.
},
],
+ "isRfpTemplate": True or False, # Indicates whether the current deal is a RFP template. RFP template is created by buyer and not based on seller created products.
"webPropertyCode": "A String",
"proposalId": "A String",
"inventoryDescription": "A String", # Description for the deal terms. (updatable)
@@ -1023,30 +1032,7 @@
},
"terms": { # The negotiable terms of the deal. (updatable)
"brandingType": "A String", # Visibilty of the URL in bid requests.
- "estimatedGrossSpend": { # Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller.
- "pricingType": "A String", # The pricing type for the deal/product.
- "currencyCode": "A String", # The currency code for the price.
- "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
- "amountMicros": 3.14, # The price value in micros.
- },
- "sellerTimeZone": "A String", # For deals with Cost Per Day billing, defines the timezone used to mark the boundaries of a day (buyer-readonly)
- "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day Can be set by buyer or seller.
- "nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals.
- "fixedPrices": [ # Fixed price for the specified buyer.
- { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
- "auctionTier": "A String", # Optional access type for this buyer.
- "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
- "accountId": "A String", # Adx account id of the buyer.
- },
- "price": { # The specified price
- "pricingType": "A String", # The pricing type for the deal/product.
- "currencyCode": "A String", # The currency code for the price.
- "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
- "amountMicros": 3.14, # The price value in micros.
- },
- },
- ],
- },
+ "crossListedExternalDealIdType": "A String", # Indicates that this ExternalDealId exists under at least two different AdxInventoryDeals. Currently, the only case that the same ExternalDealId will exist is programmatic cross sell case.
"guaranteedFixedPriceTerms": { # The terms for guaranteed fixed price deals.
"guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy.
"fixedPrices": [ # Fixed price for the specified buyer.
@@ -1077,6 +1063,30 @@
"currencyConversionTimeMs": "A String", # The timestamp (in ms since epoch) when the original reservation price for the deal was first converted to DFP currency. This is used to convert the contracted price into advertiser's currency without discrepancy.
},
},
+ "sellerTimeZone": "A String", # For deals with Cost Per Day billing, defines the timezone used to mark the boundaries of a day (buyer-readonly)
+ "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day Can be set by buyer or seller.
+ "nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals.
+ "fixedPrices": [ # Fixed price for the specified buyer.
+ { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+ "auctionTier": "A String", # Optional access type for this buyer.
+ "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "price": { # The specified price
+ "pricingType": "A String", # The pricing type for the deal/product.
+ "currencyCode": "A String", # The currency code for the price.
+ "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
+ "amountMicros": 3.14, # The price value in micros.
+ },
+ },
+ ],
+ },
+ "estimatedGrossSpend": { # Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller.
+ "pricingType": "A String", # The pricing type for the deal/product.
+ "currencyCode": "A String", # The currency code for the price.
+ "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
+ "amountMicros": 3.14, # The price value in micros.
+ },
"rubiconNonGuaranteedTerms": { # The terms for rubicon non-guaranteed deals.
"priorityPrice": { # Optional price for Rubicon priority access in the auction.
"pricingType": "A String", # The pricing type for the deal/product.
@@ -1241,6 +1251,9 @@
},
"proposalId": "A String", # The unique id of the proposal. (readonly).
"isRenegotiating": True or False, # True if the proposal is being renegotiated (readonly).
+ "dbmAdvertiserIds": [ # IDs of DBM advertisers permission to this proposal.
+ "A String",
+ ],
"lastUpdaterOrCommentorRole": "A String", # The role of the last user that either updated the proposal or left a comment. (readonly)
"privateAuctionId": "A String", # Optional private auction id if this proposal is a private auction proposal.
"originatorRole": "A String", # Indicates whether the buyer/seller created the proposal.(readonly)
@@ -1285,6 +1298,7 @@
"name": "A String", # The name of the contact.
},
],
+ "isRfpTemplate": True or False, # Indicates whether the current deal is a RFP template. RFP template is created by buyer and not based on seller created products.
"webPropertyCode": "A String",
"proposalId": "A String",
"inventoryDescription": "A String", # Description for the deal terms. (updatable)
@@ -1302,30 +1316,7 @@
},
"terms": { # The negotiable terms of the deal. (updatable)
"brandingType": "A String", # Visibilty of the URL in bid requests.
- "estimatedGrossSpend": { # Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller.
- "pricingType": "A String", # The pricing type for the deal/product.
- "currencyCode": "A String", # The currency code for the price.
- "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
- "amountMicros": 3.14, # The price value in micros.
- },
- "sellerTimeZone": "A String", # For deals with Cost Per Day billing, defines the timezone used to mark the boundaries of a day (buyer-readonly)
- "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day Can be set by buyer or seller.
- "nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals.
- "fixedPrices": [ # Fixed price for the specified buyer.
- { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
- "auctionTier": "A String", # Optional access type for this buyer.
- "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
- "accountId": "A String", # Adx account id of the buyer.
- },
- "price": { # The specified price
- "pricingType": "A String", # The pricing type for the deal/product.
- "currencyCode": "A String", # The currency code for the price.
- "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
- "amountMicros": 3.14, # The price value in micros.
- },
- },
- ],
- },
+ "crossListedExternalDealIdType": "A String", # Indicates that this ExternalDealId exists under at least two different AdxInventoryDeals. Currently, the only case that the same ExternalDealId will exist is programmatic cross sell case.
"guaranteedFixedPriceTerms": { # The terms for guaranteed fixed price deals.
"guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy.
"fixedPrices": [ # Fixed price for the specified buyer.
@@ -1356,6 +1347,30 @@
"currencyConversionTimeMs": "A String", # The timestamp (in ms since epoch) when the original reservation price for the deal was first converted to DFP currency. This is used to convert the contracted price into advertiser's currency without discrepancy.
},
},
+ "sellerTimeZone": "A String", # For deals with Cost Per Day billing, defines the timezone used to mark the boundaries of a day (buyer-readonly)
+ "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day Can be set by buyer or seller.
+ "nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals.
+ "fixedPrices": [ # Fixed price for the specified buyer.
+ { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+ "auctionTier": "A String", # Optional access type for this buyer.
+ "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "price": { # The specified price
+ "pricingType": "A String", # The pricing type for the deal/product.
+ "currencyCode": "A String", # The currency code for the price.
+ "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
+ "amountMicros": 3.14, # The price value in micros.
+ },
+ },
+ ],
+ },
+ "estimatedGrossSpend": { # Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller.
+ "pricingType": "A String", # The pricing type for the deal/product.
+ "currencyCode": "A String", # The currency code for the price.
+ "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
+ "amountMicros": 3.14, # The price value in micros.
+ },
"rubiconNonGuaranteedTerms": { # The terms for rubicon non-guaranteed deals.
"priorityPrice": { # Optional price for Rubicon priority access in the auction.
"pricingType": "A String", # The pricing type for the deal/product.
diff --git a/docs/dyn/adexchangebuyer_v1_4.products.html b/docs/dyn/adexchangebuyer_v1_4.products.html
index e44b51b..177e228 100644
--- a/docs/dyn/adexchangebuyer_v1_4.products.html
+++ b/docs/dyn/adexchangebuyer_v1_4.products.html
@@ -157,30 +157,7 @@
},
"terms": { # The negotiable terms of the deal (buyer-readonly)
"brandingType": "A String", # Visibilty of the URL in bid requests.
- "estimatedGrossSpend": { # Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller.
- "pricingType": "A String", # The pricing type for the deal/product.
- "currencyCode": "A String", # The currency code for the price.
- "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
- "amountMicros": 3.14, # The price value in micros.
- },
- "sellerTimeZone": "A String", # For deals with Cost Per Day billing, defines the timezone used to mark the boundaries of a day (buyer-readonly)
- "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day Can be set by buyer or seller.
- "nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals.
- "fixedPrices": [ # Fixed price for the specified buyer.
- { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
- "auctionTier": "A String", # Optional access type for this buyer.
- "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
- "accountId": "A String", # Adx account id of the buyer.
- },
- "price": { # The specified price
- "pricingType": "A String", # The pricing type for the deal/product.
- "currencyCode": "A String", # The currency code for the price.
- "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
- "amountMicros": 3.14, # The price value in micros.
- },
- },
- ],
- },
+ "crossListedExternalDealIdType": "A String", # Indicates that this ExternalDealId exists under at least two different AdxInventoryDeals. Currently, the only case that the same ExternalDealId will exist is programmatic cross sell case.
"guaranteedFixedPriceTerms": { # The terms for guaranteed fixed price deals.
"guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy.
"fixedPrices": [ # Fixed price for the specified buyer.
@@ -211,6 +188,30 @@
"currencyConversionTimeMs": "A String", # The timestamp (in ms since epoch) when the original reservation price for the deal was first converted to DFP currency. This is used to convert the contracted price into advertiser's currency without discrepancy.
},
},
+ "sellerTimeZone": "A String", # For deals with Cost Per Day billing, defines the timezone used to mark the boundaries of a day (buyer-readonly)
+ "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day Can be set by buyer or seller.
+ "nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals.
+ "fixedPrices": [ # Fixed price for the specified buyer.
+ { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+ "auctionTier": "A String", # Optional access type for this buyer.
+ "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "price": { # The specified price
+ "pricingType": "A String", # The pricing type for the deal/product.
+ "currencyCode": "A String", # The currency code for the price.
+ "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
+ "amountMicros": 3.14, # The price value in micros.
+ },
+ },
+ ],
+ },
+ "estimatedGrossSpend": { # Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller.
+ "pricingType": "A String", # The pricing type for the deal/product.
+ "currencyCode": "A String", # The currency code for the price.
+ "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
+ "amountMicros": 3.14, # The price value in micros.
+ },
"rubiconNonGuaranteedTerms": { # The terms for rubicon non-guaranteed deals.
"priorityPrice": { # Optional price for Rubicon priority access in the auction.
"pricingType": "A String", # The pricing type for the deal/product.
@@ -402,30 +403,7 @@
},
"terms": { # The negotiable terms of the deal (buyer-readonly)
"brandingType": "A String", # Visibilty of the URL in bid requests.
- "estimatedGrossSpend": { # Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller.
- "pricingType": "A String", # The pricing type for the deal/product.
- "currencyCode": "A String", # The currency code for the price.
- "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
- "amountMicros": 3.14, # The price value in micros.
- },
- "sellerTimeZone": "A String", # For deals with Cost Per Day billing, defines the timezone used to mark the boundaries of a day (buyer-readonly)
- "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day Can be set by buyer or seller.
- "nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals.
- "fixedPrices": [ # Fixed price for the specified buyer.
- { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
- "auctionTier": "A String", # Optional access type for this buyer.
- "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
- "accountId": "A String", # Adx account id of the buyer.
- },
- "price": { # The specified price
- "pricingType": "A String", # The pricing type for the deal/product.
- "currencyCode": "A String", # The currency code for the price.
- "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
- "amountMicros": 3.14, # The price value in micros.
- },
- },
- ],
- },
+ "crossListedExternalDealIdType": "A String", # Indicates that this ExternalDealId exists under at least two different AdxInventoryDeals. Currently, the only case that the same ExternalDealId will exist is programmatic cross sell case.
"guaranteedFixedPriceTerms": { # The terms for guaranteed fixed price deals.
"guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy.
"fixedPrices": [ # Fixed price for the specified buyer.
@@ -456,6 +434,30 @@
"currencyConversionTimeMs": "A String", # The timestamp (in ms since epoch) when the original reservation price for the deal was first converted to DFP currency. This is used to convert the contracted price into advertiser's currency without discrepancy.
},
},
+ "sellerTimeZone": "A String", # For deals with Cost Per Day billing, defines the timezone used to mark the boundaries of a day (buyer-readonly)
+ "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day Can be set by buyer or seller.
+ "nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals.
+ "fixedPrices": [ # Fixed price for the specified buyer.
+ { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+ "auctionTier": "A String", # Optional access type for this buyer.
+ "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "price": { # The specified price
+ "pricingType": "A String", # The pricing type for the deal/product.
+ "currencyCode": "A String", # The currency code for the price.
+ "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
+ "amountMicros": 3.14, # The price value in micros.
+ },
+ },
+ ],
+ },
+ "estimatedGrossSpend": { # Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller.
+ "pricingType": "A String", # The pricing type for the deal/product.
+ "currencyCode": "A String", # The currency code for the price.
+ "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
+ "amountMicros": 3.14, # The price value in micros.
+ },
"rubiconNonGuaranteedTerms": { # The terms for rubicon non-guaranteed deals.
"priorityPrice": { # Optional price for Rubicon priority access in the auction.
"pricingType": "A String", # The pricing type for the deal/product.
diff --git a/docs/dyn/adexchangebuyer_v1_4.proposals.html b/docs/dyn/adexchangebuyer_v1_4.proposals.html
index bc99406..5dc6e4e 100644
--- a/docs/dyn/adexchangebuyer_v1_4.proposals.html
+++ b/docs/dyn/adexchangebuyer_v1_4.proposals.html
@@ -138,6 +138,9 @@
},
"proposalId": "A String", # The unique id of the proposal. (readonly).
"isRenegotiating": True or False, # True if the proposal is being renegotiated (readonly).
+ "dbmAdvertiserIds": [ # IDs of DBM advertisers permission to this proposal.
+ "A String",
+ ],
"lastUpdaterOrCommentorRole": "A String", # The role of the last user that either updated the proposal or left a comment. (readonly)
"privateAuctionId": "A String", # Optional private auction id if this proposal is a private auction proposal.
"originatorRole": "A String", # Indicates whether the buyer/seller created the proposal.(readonly)
@@ -212,6 +215,9 @@
},
"proposalId": "A String", # The unique id of the proposal. (readonly).
"isRenegotiating": True or False, # True if the proposal is being renegotiated (readonly).
+ "dbmAdvertiserIds": [ # IDs of DBM advertisers permission to this proposal.
+ "A String",
+ ],
"lastUpdaterOrCommentorRole": "A String", # The role of the last user that either updated the proposal or left a comment. (readonly)
"privateAuctionId": "A String", # Optional private auction id if this proposal is a private auction proposal.
"originatorRole": "A String", # Indicates whether the buyer/seller created the proposal.(readonly)
@@ -282,6 +288,9 @@
},
"proposalId": "A String", # The unique id of the proposal. (readonly).
"isRenegotiating": True or False, # True if the proposal is being renegotiated (readonly).
+ "dbmAdvertiserIds": [ # IDs of DBM advertisers permission to this proposal.
+ "A String",
+ ],
"lastUpdaterOrCommentorRole": "A String", # The role of the last user that either updated the proposal or left a comment. (readonly)
"privateAuctionId": "A String", # Optional private auction id if this proposal is a private auction proposal.
"originatorRole": "A String", # Indicates whether the buyer/seller created the proposal.(readonly)
@@ -319,11 +328,12 @@
Args:
proposalId: string, The proposal id to update. (required)
revisionNumber: string, The last known revision number to update. If the head revision in the marketplace database has since changed, an error will be thrown. The caller should then fetch the latest proposal at head revision and retry the update at that revision. (required)
- updateAction: string, The proposed action to take on the proposal. (required)
+ updateAction: string, The proposed action to take on the proposal. This field is required and it must be set when updating a proposal. (required)
Allowed values
accept -
cancel -
propose -
+ proposeAndAccept -
unknownAction -
updateFinalized -
body: object, The request body. (required)
@@ -364,6 +374,9 @@
},
"proposalId": "A String", # The unique id of the proposal. (readonly).
"isRenegotiating": True or False, # True if the proposal is being renegotiated (readonly).
+ "dbmAdvertiserIds": [ # IDs of DBM advertisers permission to this proposal.
+ "A String",
+ ],
"lastUpdaterOrCommentorRole": "A String", # The role of the last user that either updated the proposal or left a comment. (readonly)
"privateAuctionId": "A String", # Optional private auction id if this proposal is a private auction proposal.
"originatorRole": "A String", # Indicates whether the buyer/seller created the proposal.(readonly)
@@ -430,6 +443,9 @@
},
"proposalId": "A String", # The unique id of the proposal. (readonly).
"isRenegotiating": True or False, # True if the proposal is being renegotiated (readonly).
+ "dbmAdvertiserIds": [ # IDs of DBM advertisers permission to this proposal.
+ "A String",
+ ],
"lastUpdaterOrCommentorRole": "A String", # The role of the last user that either updated the proposal or left a comment. (readonly)
"privateAuctionId": "A String", # Optional private auction id if this proposal is a private auction proposal.
"originatorRole": "A String", # Indicates whether the buyer/seller created the proposal.(readonly)
@@ -505,6 +521,9 @@
},
"proposalId": "A String", # The unique id of the proposal. (readonly).
"isRenegotiating": True or False, # True if the proposal is being renegotiated (readonly).
+ "dbmAdvertiserIds": [ # IDs of DBM advertisers permission to this proposal.
+ "A String",
+ ],
"lastUpdaterOrCommentorRole": "A String", # The role of the last user that either updated the proposal or left a comment. (readonly)
"privateAuctionId": "A String", # Optional private auction id if this proposal is a private auction proposal.
"originatorRole": "A String", # Indicates whether the buyer/seller created the proposal.(readonly)
@@ -551,11 +570,12 @@
Args:
proposalId: string, The proposal id to update. (required)
revisionNumber: string, The last known revision number to update. If the head revision in the marketplace database has since changed, an error will be thrown. The caller should then fetch the latest proposal at head revision and retry the update at that revision. (required)
- updateAction: string, The proposed action to take on the proposal. (required)
+ updateAction: string, The proposed action to take on the proposal. This field is required and it must be set when updating a proposal. (required)
Allowed values
accept -
cancel -
propose -
+ proposeAndAccept -
unknownAction -
updateFinalized -
body: object, The request body. (required)
@@ -596,6 +616,9 @@
},
"proposalId": "A String", # The unique id of the proposal. (readonly).
"isRenegotiating": True or False, # True if the proposal is being renegotiated (readonly).
+ "dbmAdvertiserIds": [ # IDs of DBM advertisers permission to this proposal.
+ "A String",
+ ],
"lastUpdaterOrCommentorRole": "A String", # The role of the last user that either updated the proposal or left a comment. (readonly)
"privateAuctionId": "A String", # Optional private auction id if this proposal is a private auction proposal.
"originatorRole": "A String", # Indicates whether the buyer/seller created the proposal.(readonly)
@@ -662,6 +685,9 @@
},
"proposalId": "A String", # The unique id of the proposal. (readonly).
"isRenegotiating": True or False, # True if the proposal is being renegotiated (readonly).
+ "dbmAdvertiserIds": [ # IDs of DBM advertisers permission to this proposal.
+ "A String",
+ ],
"lastUpdaterOrCommentorRole": "A String", # The role of the last user that either updated the proposal or left a comment. (readonly)
"privateAuctionId": "A String", # Optional private auction id if this proposal is a private auction proposal.
"originatorRole": "A String", # Indicates whether the buyer/seller created the proposal.(readonly)
diff --git a/docs/dyn/androidenterprise_v1.devices.html b/docs/dyn/androidenterprise_v1.devices.html
index 6646827..9bae021 100644
--- a/docs/dyn/androidenterprise_v1.devices.html
+++ b/docs/dyn/androidenterprise_v1.devices.html
@@ -104,11 +104,12 @@
# 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".
"managementType": "A String", # Identifies the extent to which the device is controlled by an Android for Work EMM in various deployment configurations.
+ #
# Possible values include:
- # - "managedDevice"—A device that has the EMM's device policy controller (DPC) as the device owner.
- # - "managedProfile"—A device that has a work profile managed by the DPC (DPC is profile owner) in addition to a separate, personal profile that is unavailable to the DPC.
- # - "containerApp"—A device running the Android for Work App. The Android for Work App is managed by the DPC.
- # - "unmanagedProfile"—A device that has been allowed (by the domain's admin, using the Admin Console to enable the privilege) to use Android for Work apps or Google Apps for Work, but the profile is itself not owned by a DPC.
+ # - "managedDevice", a device that has the EMM's device policy controller (DPC) as the device owner,
+ # - "managedProfile", a device that has a work profile managed by the DPC (DPC is profile owner) in addition to a separate, personal profile that is unavailable to the DPC,
+ # - "containerApp", a device running the Android for Work App. The Android for Work App is managed by the DPC,
+ # - "unmanagedProfile", a device that has been allowed (by the domain's admin, using the Admin Console to enable the privilege) to use Android for Work apps or Google Apps for Work, but the profile is itself not owned by a DPC.
"androidId": "A String", # The Google Play Services Android ID for the device encoded as a lowercase hex string, e.g. "123456789abcdef0".
}</pre>
</div>
@@ -149,11 +150,12 @@
# 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".
"managementType": "A String", # Identifies the extent to which the device is controlled by an Android for Work EMM in various deployment configurations.
+ #
# Possible values include:
- # - "managedDevice"—A device that has the EMM's device policy controller (DPC) as the device owner.
- # - "managedProfile"—A device that has a work profile managed by the DPC (DPC is profile owner) in addition to a separate, personal profile that is unavailable to the DPC.
- # - "containerApp"—A device running the Android for Work App. The Android for Work App is managed by the DPC.
- # - "unmanagedProfile"—A device that has been allowed (by the domain's admin, using the Admin Console to enable the privilege) to use Android for Work apps or Google Apps for Work, but the profile is itself not owned by a DPC.
+ # - "managedDevice", a device that has the EMM's device policy controller (DPC) as the device owner,
+ # - "managedProfile", a device that has a work profile managed by the DPC (DPC is profile owner) in addition to a separate, personal profile that is unavailable to the DPC,
+ # - "containerApp", a device running the Android for Work App. The Android for Work App is managed by the DPC,
+ # - "unmanagedProfile", a device that has been allowed (by the domain's admin, using the Admin Console to enable the privilege) to use Android for Work apps or Google Apps for Work, but the profile is itself not owned by a DPC.
"androidId": "A String", # The Google Play Services Android ID for the device encoded as a lowercase hex string, e.g. "123456789abcdef0".
},
],
diff --git a/docs/dyn/androidenterprise_v1.enterprises.html b/docs/dyn/androidenterprise_v1.enterprises.html
index 6961ee8..53b5c61 100644
--- a/docs/dyn/androidenterprise_v1.enterprises.html
+++ b/docs/dyn/androidenterprise_v1.enterprises.html
@@ -81,6 +81,9 @@
<code><a href="#completeSignup">completeSignup(completionToken=None, enterpriseToken=None)</a></code></p>
<p class="firstline">Completes the signup flow, by specifying the Completion token and Enterprise token. This request must not be called multiple times for a given Enterprise Token.</p>
<p class="toc_element">
+ <code><a href="#createWebToken">createWebToken(enterpriseId, body)</a></code></p>
+<p class="firstline">Returns a unique token to access an embeddable UI. To generate a web UI, pass the generated token into the Play for Work javascript API. Each token may only be used to start one UI session. See the javascript API documentation for further information.</p>
+<p class="toc_element">
<code><a href="#delete">delete(enterpriseId)</a></code></p>
<p class="firstline">Deletes the binding between the EMM 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">
@@ -156,6 +159,33 @@
</div>
<div class="method">
+ <code class="details" id="createWebToken">createWebToken(enterpriseId, body)</code>
+ <pre>Returns a unique token to access an embeddable UI. To generate a web UI, pass the generated token into the Play for Work javascript API. Each token may only be used to start one UI session. See the javascript API documentation for further information.
+
+Args:
+ enterpriseId: string, The ID of the enterprise. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Specification for a token used to generate iframes. The token specifies what data the admin is allowed to modify and the URI the iframe is allowed to communiate with.
+ "kind": "androidenterprise#administratorWebTokenSpec", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#administratorWebTokenSpec".
+ "parent": "A String", # The URI of the parent frame hosting the iframe. To prevent XSS, the iframe may not be hosted at other URIs. This URI must be https.
+ "permission": [ # The list of permissions the admin is granted within the iframe. The admin will only be allowed to view an iframe if they have all of the permissions associated with it.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # A token authorizing an administrator to access an iframe.
+ "kind": "androidenterprise#administratorWebToken", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#administratorWebToken".
+ "token": "A String", # An opaque token to be passed to the Play front-end to generate an iframe.
+ }</pre>
+</div>
+
+<div class="method">
<code class="details" id="delete">delete(enterpriseId)</code>
<pre>Deletes the binding between the EMM 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.
@@ -298,6 +328,7 @@
#
# If there exists at least one page, this field must be set to the ID of a valid page.
"kind": "androidenterprise#storeLayout", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeLayout".
+ "storeLayoutType": "A String", # Sets a store layout type. If set to "custom", "homepageId" must be specified. If set to "basic", the layout will consist of all approved apps accessible by the user, split in pages of 100 each; in this case, "homepageId" must not be specified. The "basic" setting takes precedence over any existing collections setup for this enterprise (if any). Should the enterprise use collectionViewers for controlling access rights, these will still be respected.
}</pre>
</div>
@@ -376,13 +407,16 @@
<div class="method">
<code class="details" id="pullNotificationSet">pullNotificationSet(requestMode=None)</code>
<pre>Pulls and returns a notification set for the enterprises associated with the service account authenticated for the request. The notification set may be empty if no notification are pending.
-A notification set returned needs to be acknowledged within 20 seconds by calling Enterprises.AcknowledgeNotificationSet, unless the notification set is empty.
+A notification set returned needs to be acknowledged within 20 seconds by calling Enterprises​.AcknowledgeNotificationSet, unless the notification set is empty.
Notifications that are not acknowledged within the 20 seconds will eventually be included again in the response to another PullNotificationSet request, and those that are never acknowledged will ultimately be deleted according to the Google Cloud Platform Pub/Sub system policy.
Multiple requests might be performed concurrently to retrieve notifications, in which case the pending notifications (if any) will be split among each caller, if any are pending.
+If no notifications are present, an empty notification list is returned. Subsequent requests may return more notifications once they become available.
Args:
- requestMode: string, The request mode for pulling notifications. If omitted, defaults to WAIT_FOR_NOTIFCATIONS.
-If this is set to WAIT_FOR_NOTIFCATIONS, the request will eventually timeout, in which case it should be retried.
+ requestMode: string, The request mode for pulling notifications.
+Specifying waitForNotifications will cause the request to block and wait until one or more notifications are present, or return an empty notification list if no notifications are present after some time.
+Speciying returnImmediately will cause the request to immediately return the pending notifications, or an empty list if no notifications are present.
+If omitted, defaults to waitForNotifications.
Allowed values
returnImmediately -
waitForNotifications -
@@ -488,6 +522,7 @@
#
# If there exists at least one page, this field must be set to the ID of a valid page.
"kind": "androidenterprise#storeLayout", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeLayout".
+ "storeLayoutType": "A String", # Sets a store layout type. If set to "custom", "homepageId" must be specified. If set to "basic", the layout will consist of all approved apps accessible by the user, split in pages of 100 each; in this case, "homepageId" must not be specified. The "basic" setting takes precedence over any existing collections setup for this enterprise (if any). Should the enterprise use collectionViewers for controlling access rights, these will still be respected.
}
@@ -501,6 +536,7 @@
#
# If there exists at least one page, this field must be set to the ID of a valid page.
"kind": "androidenterprise#storeLayout", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeLayout".
+ "storeLayoutType": "A String", # Sets a store layout type. If set to "custom", "homepageId" must be specified. If set to "basic", the layout will consist of all approved apps accessible by the user, split in pages of 100 each; in this case, "homepageId" must not be specified. The "basic" setting takes precedence over any existing collections setup for this enterprise (if any). Should the enterprise use collectionViewers for controlling access rights, these will still be respected.
}</pre>
</div>
diff --git a/docs/dyn/androidenterprise_v1.products.html b/docs/dyn/androidenterprise_v1.products.html
index f1a3d17..510095e 100644
--- a/docs/dyn/androidenterprise_v1.products.html
+++ b/docs/dyn/androidenterprise_v1.products.html
@@ -192,7 +192,7 @@
{ # A restriction in the App Restriction Schema represents a piece of configuration that may be pre-applied.
"description": "A String", # A longer description of the restriction, giving more detail of what it affects.
"title": "A String", # The name of the restriction.
- "defaultValue": { # A typed value for the restriction. # The default value of the restriction.
+ "defaultValue": { # A typed value for the restriction. # The default value of the restriction. bundle and bundleArray restrictions never have a default value.
"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.
@@ -201,10 +201,10 @@
],
"valueInteger": 42, # The integer value - this will only be present if type is integer.
},
- "nestedRestriction": [ # For bundle or bundleArray restrictions, the list of nested restrictions.
+ "nestedRestriction": [ # For bundle or bundleArray restrictions, the list of nested restrictions. A bundle restriction is always nested within a bundleArray restriction, and a bundleArray restriction is at most two levels deep.
# Object with schema name: AppRestrictionsSchemaRestriction
],
- "entryValue": [ # For choice or multiselect restrictions, the list of possible entries' machine-readable values.
+ "entryValue": [ # For choice or multiselect restrictions, the list of possible entries' machine-readable values. These values should be used in the configuration, either as a single string value for a choice restriction or in a stringArray for a multiselect restriction.
"A String",
],
"key": "A String", # The unique key that the product uses to identify the restriction, e.g. "com.google.android.gm.fieldname".
diff --git a/docs/dyn/androidenterprise_v1.users.html b/docs/dyn/androidenterprise_v1.users.html
index 493ee4d..169559c 100644
--- a/docs/dyn/androidenterprise_v1.users.html
+++ b/docs/dyn/androidenterprise_v1.users.html
@@ -205,6 +205,7 @@
<pre>Creates a new EMM-managed user.
The Users resource passed in the body of the request should include an accountIdentifier and an accountType.
+If a corresponding user already exists with the same account identifier, the user will be updated with the resource. In this case only the displayName field can be changed.
Args:
enterpriseId: string, The ID of the enterprise. (required)
diff --git a/docs/dyn/bigquery_v2.datasets.html b/docs/dyn/bigquery_v2.datasets.html
index 31fa0d9..a1bbe9b 100644
--- a/docs/dyn/bigquery_v2.datasets.html
+++ b/docs/dyn/bigquery_v2.datasets.html
@@ -125,7 +125,7 @@
"projectId": "A String", # [Optional] The ID of the project containing this dataset.
"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
},
- "labels": { # [Experimental] The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. Label keys and values can be no longer than 63 characters, can only contain letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and must be unique within a dataset. Both keys and values are additionally constrained to be <= 128 bytes in size.
+ "labels": { # [Experimental] The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See Labeling Datasets for more information.
"a_key": "A String",
},
"creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
@@ -169,7 +169,7 @@
"projectId": "A String", # [Optional] The ID of the project containing this dataset.
"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
},
- "labels": { # [Experimental] The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. Label keys and values can be no longer than 63 characters, can only contain letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and must be unique within a dataset. Both keys and values are additionally constrained to be <= 128 bytes in size.
+ "labels": { # [Experimental] The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See Labeling Datasets for more information.
"a_key": "A String",
},
"creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
@@ -207,7 +207,7 @@
"projectId": "A String", # [Optional] The ID of the project containing this dataset.
"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
},
- "labels": { # [Experimental] The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. Label keys and values can be no longer than 63 characters, can only contain letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and must be unique within a dataset. Both keys and values are additionally constrained to be <= 128 bytes in size.
+ "labels": { # [Experimental] The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See Labeling Datasets for more information.
"a_key": "A String",
},
"creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
@@ -241,7 +241,7 @@
Args:
projectId: string, Project ID of the datasets to be listed (required)
- filter: string, An expression for filtering the results of the request by label. The syntax is "labels.[:]". Multiple filters can be ANDed together by connecting with a space. Example: "labels.department:receiving labels.active". See https://cloud.google.com/bigquery/docs/labeling-datasets#filtering_datasets_using_labels for details.
+ filter: string, An expression for filtering the results of the request by label. The syntax is "labels.<name>[:<value>]". Multiple filters can be ANDed together by connecting with a space. Example: "labels.department:receiving labels.active". See Filtering datasets using labels for details.
all: boolean, Whether to list all datasets, including hidden ones
pageToken: string, Page token, returned by a previous call, to request the next page of results
maxResults: integer, The maximum number of results to return
@@ -301,7 +301,7 @@
"projectId": "A String", # [Optional] The ID of the project containing this dataset.
"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
},
- "labels": { # [Experimental] The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. Label keys and values can be no longer than 63 characters, can only contain letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and must be unique within a dataset. Both keys and values are additionally constrained to be <= 128 bytes in size.
+ "labels": { # [Experimental] The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See Labeling Datasets for more information.
"a_key": "A String",
},
"creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
@@ -339,7 +339,7 @@
"projectId": "A String", # [Optional] The ID of the project containing this dataset.
"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
},
- "labels": { # [Experimental] The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. Label keys and values can be no longer than 63 characters, can only contain letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and must be unique within a dataset. Both keys and values are additionally constrained to be <= 128 bytes in size.
+ "labels": { # [Experimental] The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See Labeling Datasets for more information.
"a_key": "A String",
},
"creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
@@ -384,7 +384,7 @@
"projectId": "A String", # [Optional] The ID of the project containing this dataset.
"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
},
- "labels": { # [Experimental] The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. Label keys and values can be no longer than 63 characters, can only contain letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and must be unique within a dataset. Both keys and values are additionally constrained to be <= 128 bytes in size.
+ "labels": { # [Experimental] The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See Labeling Datasets for more information.
"a_key": "A String",
},
"creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
@@ -422,7 +422,7 @@
"projectId": "A String", # [Optional] The ID of the project containing this dataset.
"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
},
- "labels": { # [Experimental] The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. Label keys and values can be no longer than 63 characters, can only contain letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and must be unique within a dataset. Both keys and values are additionally constrained to be <= 128 bytes in size.
+ "labels": { # [Experimental] The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See Labeling Datasets for more information.
"a_key": "A String",
},
"creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
diff --git a/docs/dyn/bigquery_v2.jobs.html b/docs/dyn/bigquery_v2.jobs.html
index 23ae6e6..c0bfb55 100644
--- a/docs/dyn/bigquery_v2.jobs.html
+++ b/docs/dyn/bigquery_v2.jobs.html
@@ -179,9 +179,9 @@
"arrayType": # Object with schema name: QueryParameterType # [Optional] The type of the array's elements, if this is an array.
},
"parameterValue": { # [Required] The value of this parameter.
- "structValues": [ # [Optional] The struct field values, in order of the struct type's declaration.
- # Object with schema name: QueryParameterValue
- ],
+ "structValues": { # [Optional] The struct field values, in order of the struct type's declaration.
+ "a_key": # Object with schema name: QueryParameterValue
+ },
"arrayValues": [ # [Optional] The array values, if this is an array type.
# Object with schema name: QueryParameterValue
],
@@ -205,7 +205,7 @@
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
# Object with schema name: TableFieldSchema
],
- "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
+ "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
"description": "A String", # [Optional] The field description. The maximum length is 16K characters.
"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
@@ -262,7 +262,7 @@
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
# Object with schema name: TableFieldSchema
],
- "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
+ "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
"description": "A String", # [Optional] The field description. The maximum length is 16K characters.
"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
@@ -347,9 +347,9 @@
"arrayType": # Object with schema name: QueryParameterType # [Optional] The type of the array's elements, if this is an array.
},
"parameterValue": { # [Required] The value of this parameter.
- "structValues": [ # [Optional] The struct field values, in order of the struct type's declaration.
- # Object with schema name: QueryParameterValue
- ],
+ "structValues": { # [Optional] The struct field values, in order of the struct type's declaration.
+ "a_key": # Object with schema name: QueryParameterValue
+ },
"arrayValues": [ # [Optional] The array values, if this is an array type.
# Object with schema name: QueryParameterValue
],
@@ -411,7 +411,7 @@
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
# Object with schema name: TableFieldSchema
],
- "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
+ "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
"description": "A String", # [Optional] The field description. The maximum length is 16K characters.
"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
@@ -512,9 +512,9 @@
"arrayType": # Object with schema name: QueryParameterType # [Optional] The type of the array's elements, if this is an array.
},
"parameterValue": { # [Required] The value of this parameter.
- "structValues": [ # [Optional] The struct field values, in order of the struct type's declaration.
- # Object with schema name: QueryParameterValue
- ],
+ "structValues": { # [Optional] The struct field values, in order of the struct type's declaration.
+ "a_key": # Object with schema name: QueryParameterValue
+ },
"arrayValues": [ # [Optional] The array values, if this is an array type.
# Object with schema name: QueryParameterValue
],
@@ -538,7 +538,7 @@
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
# Object with schema name: TableFieldSchema
],
- "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
+ "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
"description": "A String", # [Optional] The field description. The maximum length is 16K characters.
"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
@@ -595,7 +595,7 @@
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
# Object with schema name: TableFieldSchema
],
- "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
+ "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
"description": "A String", # [Optional] The field description. The maximum length is 16K characters.
"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
@@ -680,9 +680,9 @@
"arrayType": # Object with schema name: QueryParameterType # [Optional] The type of the array's elements, if this is an array.
},
"parameterValue": { # [Required] The value of this parameter.
- "structValues": [ # [Optional] The struct field values, in order of the struct type's declaration.
- # Object with schema name: QueryParameterValue
- ],
+ "structValues": { # [Optional] The struct field values, in order of the struct type's declaration.
+ "a_key": # Object with schema name: QueryParameterValue
+ },
"arrayValues": [ # [Optional] The array values, if this is an array type.
# Object with schema name: QueryParameterValue
],
@@ -744,7 +744,7 @@
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
# Object with schema name: TableFieldSchema
],
- "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
+ "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
"description": "A String", # [Optional] The field description. The maximum length is 16K characters.
"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
@@ -812,7 +812,7 @@
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
# Object with schema name: TableFieldSchema
],
- "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
+ "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
"description": "A String", # [Optional] The field description. The maximum length is 16K characters.
"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
@@ -902,9 +902,9 @@
"arrayType": # Object with schema name: QueryParameterType # [Optional] The type of the array's elements, if this is an array.
},
"parameterValue": { # [Required] The value of this parameter.
- "structValues": [ # [Optional] The struct field values, in order of the struct type's declaration.
- # Object with schema name: QueryParameterValue
- ],
+ "structValues": { # [Optional] The struct field values, in order of the struct type's declaration.
+ "a_key": # Object with schema name: QueryParameterValue
+ },
"arrayValues": [ # [Optional] The array values, if this is an array type.
# Object with schema name: QueryParameterValue
],
@@ -928,7 +928,7 @@
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
# Object with schema name: TableFieldSchema
],
- "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
+ "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
"description": "A String", # [Optional] The field description. The maximum length is 16K characters.
"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
@@ -985,7 +985,7 @@
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
# Object with schema name: TableFieldSchema
],
- "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
+ "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
"description": "A String", # [Optional] The field description. The maximum length is 16K characters.
"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
@@ -1070,9 +1070,9 @@
"arrayType": # Object with schema name: QueryParameterType # [Optional] The type of the array's elements, if this is an array.
},
"parameterValue": { # [Required] The value of this parameter.
- "structValues": [ # [Optional] The struct field values, in order of the struct type's declaration.
- # Object with schema name: QueryParameterValue
- ],
+ "structValues": { # [Optional] The struct field values, in order of the struct type's declaration.
+ "a_key": # Object with schema name: QueryParameterValue
+ },
"arrayValues": [ # [Optional] The array values, if this is an array type.
# Object with schema name: QueryParameterValue
],
@@ -1134,7 +1134,7 @@
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
# Object with schema name: TableFieldSchema
],
- "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
+ "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
"description": "A String", # [Optional] The field description. The maximum length is 16K characters.
"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
@@ -1226,9 +1226,9 @@
"arrayType": # Object with schema name: QueryParameterType # [Optional] The type of the array's elements, if this is an array.
},
"parameterValue": { # [Required] The value of this parameter.
- "structValues": [ # [Optional] The struct field values, in order of the struct type's declaration.
- # Object with schema name: QueryParameterValue
- ],
+ "structValues": { # [Optional] The struct field values, in order of the struct type's declaration.
+ "a_key": # Object with schema name: QueryParameterValue
+ },
"arrayValues": [ # [Optional] The array values, if this is an array type.
# Object with schema name: QueryParameterValue
],
@@ -1252,7 +1252,7 @@
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
# Object with schema name: TableFieldSchema
],
- "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
+ "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
"description": "A String", # [Optional] The field description. The maximum length is 16K characters.
"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
@@ -1309,7 +1309,7 @@
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
# Object with schema name: TableFieldSchema
],
- "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
+ "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
"description": "A String", # [Optional] The field description. The maximum length is 16K characters.
"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
@@ -1394,9 +1394,9 @@
"arrayType": # Object with schema name: QueryParameterType # [Optional] The type of the array's elements, if this is an array.
},
"parameterValue": { # [Required] The value of this parameter.
- "structValues": [ # [Optional] The struct field values, in order of the struct type's declaration.
- # Object with schema name: QueryParameterValue
- ],
+ "structValues": { # [Optional] The struct field values, in order of the struct type's declaration.
+ "a_key": # Object with schema name: QueryParameterValue
+ },
"arrayValues": [ # [Optional] The array values, if this is an array type.
# Object with schema name: QueryParameterValue
],
@@ -1458,7 +1458,7 @@
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
# Object with schema name: TableFieldSchema
],
- "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
+ "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
"description": "A String", # [Optional] The field description. The maximum length is 16K characters.
"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
@@ -1573,9 +1573,9 @@
"arrayType": # Object with schema name: QueryParameterType # [Optional] The type of the array's elements, if this is an array.
},
"parameterValue": { # [Required] The value of this parameter.
- "structValues": [ # [Optional] The struct field values, in order of the struct type's declaration.
- # Object with schema name: QueryParameterValue
- ],
+ "structValues": { # [Optional] The struct field values, in order of the struct type's declaration.
+ "a_key": # Object with schema name: QueryParameterValue
+ },
"arrayValues": [ # [Optional] The array values, if this is an array type.
# Object with schema name: QueryParameterValue
],
@@ -1599,7 +1599,7 @@
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
# Object with schema name: TableFieldSchema
],
- "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
+ "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
"description": "A String", # [Optional] The field description. The maximum length is 16K characters.
"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
@@ -1656,7 +1656,7 @@
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
# Object with schema name: TableFieldSchema
],
- "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
+ "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
"description": "A String", # [Optional] The field description. The maximum length is 16K characters.
"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
@@ -1741,9 +1741,9 @@
"arrayType": # Object with schema name: QueryParameterType # [Optional] The type of the array's elements, if this is an array.
},
"parameterValue": { # [Required] The value of this parameter.
- "structValues": [ # [Optional] The struct field values, in order of the struct type's declaration.
- # Object with schema name: QueryParameterValue
- ],
+ "structValues": { # [Optional] The struct field values, in order of the struct type's declaration.
+ "a_key": # Object with schema name: QueryParameterValue
+ },
"arrayValues": [ # [Optional] The array values, if this is an array type.
# Object with schema name: QueryParameterValue
],
@@ -1805,7 +1805,7 @@
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
# Object with schema name: TableFieldSchema
],
- "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
+ "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
"description": "A String", # [Optional] The field description. The maximum length is 16K characters.
"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
@@ -1878,9 +1878,9 @@
"arrayType": # Object with schema name: QueryParameterType # [Optional] The type of the array's elements, if this is an array.
},
"parameterValue": { # [Required] The value of this parameter.
- "structValues": [ # [Optional] The struct field values, in order of the struct type's declaration.
- # Object with schema name: QueryParameterValue
- ],
+ "structValues": { # [Optional] The struct field values, in order of the struct type's declaration.
+ "a_key": # Object with schema name: QueryParameterValue
+ },
"arrayValues": [ # [Optional] The array values, if this is an array type.
# Object with schema name: QueryParameterValue
],
@@ -1932,7 +1932,7 @@
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
# Object with schema name: TableFieldSchema
],
- "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
+ "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
"description": "A String", # [Optional] The field description. The maximum length is 16K characters.
"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
diff --git a/docs/dyn/bigquery_v2.tables.html b/docs/dyn/bigquery_v2.tables.html
index 0e2b666..d0906dc 100644
--- a/docs/dyn/bigquery_v2.tables.html
+++ b/docs/dyn/bigquery_v2.tables.html
@@ -182,7 +182,7 @@
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
# Object with schema name: TableFieldSchema
],
- "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
+ "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
"description": "A String", # [Optional] The field description. The maximum length is 16K characters.
"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
@@ -216,7 +216,7 @@
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
# Object with schema name: TableFieldSchema
],
- "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
+ "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
"description": "A String", # [Optional] The field description. The maximum length is 16K characters.
"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
@@ -303,7 +303,7 @@
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
# Object with schema name: TableFieldSchema
],
- "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
+ "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
"description": "A String", # [Optional] The field description. The maximum length is 16K characters.
"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
@@ -337,7 +337,7 @@
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
# Object with schema name: TableFieldSchema
],
- "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
+ "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
"description": "A String", # [Optional] The field description. The maximum length is 16K characters.
"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
@@ -417,7 +417,7 @@
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
# Object with schema name: TableFieldSchema
],
- "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
+ "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
"description": "A String", # [Optional] The field description. The maximum length is 16K characters.
"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
@@ -451,7 +451,7 @@
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
# Object with schema name: TableFieldSchema
],
- "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
+ "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
"description": "A String", # [Optional] The field description. The maximum length is 16K characters.
"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
@@ -587,7 +587,7 @@
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
# Object with schema name: TableFieldSchema
],
- "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
+ "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
"description": "A String", # [Optional] The field description. The maximum length is 16K characters.
"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
@@ -621,7 +621,7 @@
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
# Object with schema name: TableFieldSchema
],
- "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
+ "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
"description": "A String", # [Optional] The field description. The maximum length is 16K characters.
"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
@@ -701,7 +701,7 @@
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
# Object with schema name: TableFieldSchema
],
- "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
+ "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
"description": "A String", # [Optional] The field description. The maximum length is 16K characters.
"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
@@ -735,7 +735,7 @@
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
# Object with schema name: TableFieldSchema
],
- "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
+ "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
"description": "A String", # [Optional] The field description. The maximum length is 16K characters.
"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
@@ -823,7 +823,7 @@
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
# Object with schema name: TableFieldSchema
],
- "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
+ "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
"description": "A String", # [Optional] The field description. The maximum length is 16K characters.
"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
@@ -857,7 +857,7 @@
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
# Object with schema name: TableFieldSchema
],
- "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
+ "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
"description": "A String", # [Optional] The field description. The maximum length is 16K characters.
"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
@@ -937,7 +937,7 @@
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
# Object with schema name: TableFieldSchema
],
- "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
+ "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
"description": "A String", # [Optional] The field description. The maximum length is 16K characters.
"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
@@ -971,7 +971,7 @@
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
# Object with schema name: TableFieldSchema
],
- "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
+ "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
"description": "A String", # [Optional] The field description. The maximum length is 16K characters.
"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
diff --git a/docs/dyn/books_v1.series.html b/docs/dyn/books_v1.series.html
index 011b154..52426c3 100644
--- a/docs/dyn/books_v1.series.html
+++ b/docs/dyn/books_v1.series.html
@@ -94,7 +94,7 @@
An object of the form:
{
- "series": [
+ "series": [ # Series info list. The client always expects this element in the JSON output, hence declared here as OutputAlways.
{
"seriesId": "A String",
"bannerImageUrl": "A String",
diff --git a/docs/dyn/books_v1.volumes.html b/docs/dyn/books_v1.volumes.html
index 718d57c..8e02591 100644
--- a/docs/dyn/books_v1.volumes.html
+++ b/docs/dyn/books_v1.volumes.html
@@ -98,7 +98,7 @@
<code><a href="#get">get(volumeId, user_library_consistent_read=None, projection=None, source=None, country=None, includeNonComicsSeries=None, partner=None)</a></code></p>
<p class="firstline">Gets volume information for a single volume.</p>
<p class="toc_element">
- <code><a href="#list">list(q, orderBy=None, projection=None, showPreorders=None, download=None, startIndex=None, partner=None, source=None, maxResults=None, libraryRestrict=None, langRestrict=None, printType=None, filter=None)</a></code></p>
+ <code><a href="#list">list(q, orderBy=None, projection=None, printType=None, showPreorders=None, download=None, startIndex=None, partner=None, source=None, maxResults=None, libraryRestrict=None, langRestrict=None, maxAllowedMaturityRating=None, filter=None)</a></code></p>
<p class="firstline">Performs a book search.</p>
<h3>Method Details</h3>
<div class="method">
@@ -344,7 +344,7 @@
</div>
<div class="method">
- <code class="details" id="list">list(q, orderBy=None, projection=None, showPreorders=None, download=None, startIndex=None, partner=None, source=None, maxResults=None, libraryRestrict=None, langRestrict=None, printType=None, filter=None)</code>
+ <code class="details" id="list">list(q, orderBy=None, projection=None, printType=None, showPreorders=None, download=None, startIndex=None, partner=None, source=None, maxResults=None, libraryRestrict=None, langRestrict=None, maxAllowedMaturityRating=None, filter=None)</code>
<pre>Performs a book search.
Args:
@@ -357,6 +357,11 @@
Allowed values
full - Includes all volume data.
lite - Includes a subset of fields in volumeInfo and accessInfo.
+ printType: string, Restrict to books or magazines.
+ Allowed values
+ all - All volume content types.
+ books - Just books.
+ magazines - Just magazines.
showPreorders: boolean, Set to true to show books available for preorder. Defaults to false.
download: string, Restrict to volumes by download availability.
Allowed values
@@ -370,11 +375,10 @@
my-library - Restrict to the user's library, any shelf.
no-restrict - Do not restrict based on user's library.
langRestrict: string, Restrict results to books with this language code.
- printType: string, Restrict to books or magazines.
+ maxAllowedMaturityRating: string, The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out.
Allowed values
- all - All volume content types.
- books - Just books.
- magazines - Just magazines.
+ mature - Show books which are rated mature or lower.
+ not-mature - Show books which are rated not mature.
filter: string, Filter search results.
Allowed values
ebooks - All Google eBooks.
diff --git a/docs/dyn/classroom_v1.courses.html b/docs/dyn/classroom_v1.courses.html
index 08c3d1b..35adde3 100644
--- a/docs/dyn/classroom_v1.courses.html
+++ b/docs/dyn/classroom_v1.courses.html
@@ -104,7 +104,7 @@
<code><a href="#get">get(id, x__xgafv=None)</a></code></p>
<p class="firstline">Returns a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID.</p>
<p class="toc_element">
- <code><a href="#list">list(studentId=None, pageSize=None, teacherId=None, pageToken=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(studentId=None, pageSize=None, courseStates=None, teacherId=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns a list of courses that the requesting user is permitted to view, restricted to those that match the request. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the query argument is malformed. * `NOT_FOUND` if any users specified in the query arguments do not exist.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -126,6 +126,7 @@
{ # A Course in Classroom.
"updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only.
+ "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only.
"description": "A String", # Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters.
"alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
"enrollmentCode": "A String", # Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only.
@@ -185,6 +186,7 @@
{ # A Course in Classroom.
"updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only.
+ "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only.
"description": "A String", # Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters.
"alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
"enrollmentCode": "A String", # Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only.
@@ -266,6 +268,7 @@
{ # A Course in Classroom.
"updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only.
+ "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only.
"description": "A String", # Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters.
"alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
"enrollmentCode": "A String", # Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only.
@@ -320,12 +323,13 @@
</div>
<div class="method">
- <code class="details" id="list">list(studentId=None, pageSize=None, teacherId=None, pageToken=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(studentId=None, pageSize=None, courseStates=None, teacherId=None, pageToken=None, x__xgafv=None)</code>
<pre>Returns a list of courses that the requesting user is permitted to view, restricted to those that match the request. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the query argument is malformed. * `NOT_FOUND` if any users specified in the query arguments do not exist.
Args:
studentId: string, Restricts returned courses to those having a student with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
pageSize: integer, Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
+ courseStates: string, Restricts returned courses to those in one of the specified states (repeated)
teacherId: string, Restricts returned courses to those having a teacher with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
pageToken: string, nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
x__xgafv: string, V1 error format.
@@ -338,6 +342,7 @@
"courses": [ # Courses that match the list request.
{ # A Course in Classroom.
"updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only.
+ "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only.
"description": "A String", # Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters.
"alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
"enrollmentCode": "A String", # Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only.
@@ -418,6 +423,7 @@
{ # A Course in Classroom.
"updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only.
+ "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only.
"description": "A String", # Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters.
"alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
"enrollmentCode": "A String", # Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only.
@@ -478,6 +484,7 @@
{ # A Course in Classroom.
"updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only.
+ "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only.
"description": "A String", # Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters.
"alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
"enrollmentCode": "A String", # Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only.
@@ -542,6 +549,7 @@
{ # A Course in Classroom.
"updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only.
+ "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only.
"description": "A String", # Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters.
"alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
"enrollmentCode": "A String", # Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only.
@@ -601,6 +609,7 @@
{ # A Course in Classroom.
"updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only.
+ "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only.
"description": "A String", # Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters.
"alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
"enrollmentCode": "A String", # Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only.
diff --git a/docs/dyn/classroom_v1.userProfiles.guardianInvitations.html b/docs/dyn/classroom_v1.userProfiles.guardianInvitations.html
new file mode 100644
index 0000000..f9a6e16
--- /dev/null
+++ b/docs/dyn/classroom_v1.userProfiles.guardianInvitations.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="classroom_v1.html">Google Classroom API</a> . <a href="classroom_v1.userProfiles.html">userProfiles</a> . <a href="classroom_v1.userProfiles.guardianInvitations.html">guardianInvitations</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#create">create(studentId, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Creates a guardian invitation, and sends an email to the guardian asking them to confirm that they are the student's guardian. Once the guardian accepts the invitation, their `state` will change to `COMPLETED` and they will start receiving guardian notifications. A `Guardian` resource will also be created to represent the active guardian. The request object must have the `student_id` and `invited_email_address` fields set. Failing to set these fields, or setting any other fields in the request, will result in an error. This method returns the following error codes: * `PERMISSION_DENIED` if the current user does not have permission to manage guardians, if the guardian in question has already rejected too many requests for that student, if guardians are not enabled for the domain in question, or for other access errors. * `RESOURCE_EXHAUSTED` if the student or guardian has exceeded the guardian link limit. * `INVALID_ARGUMENT` if the guardian email address is not valid (for example, if it is too long), or if the format of the student ID provided cannot be recognized (it is not an email address, nor a `user_id` from this API). This error will also be returned if read-only fields are set, or if the `state` field is set to to a value other than `PENDING`. * `NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student. * `ALREADY_EXISTS` if there is already a pending guardian invitation for the student and `invited_email_address` provided, or if the provided `invited_email_address` matches the Google account of an existing `Guardian` for this user.</p>
+<p class="toc_element">
+ <code><a href="#get">get(studentId, invitationId, x__xgafv=None)</a></code></p>
+<p class="firstline">Returns a specific guardian invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view guardian invitations for the student identified by the `student_id`, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). * `NOT_FOUND` if Classroom cannot find any record of the given student or `invitation_id`. May also be returned if the student exists, but the requesting user does not have access to see that student.</p>
+<p class="toc_element">
+ <code><a href="#list">list(studentId, invitedEmailAddress=None, pageSize=None, states=None, pageToken=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Returns a list of guardian invitations that the requesting user is permitted to view, filtered by the parameters provided. This method returns the following error codes: * `PERMISSION_DENIED` if a `student_id` is specified, and the requesting user is not permitted to view guardian invitations for that student, if `"-"` is specified as the `student_id` and the user is not a domain administrator, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). May also be returned if an invalid `page_token` or `state` is provided. * `NOT_FOUND` if a `student_id` is specified, and its format can be recognized, but Classroom has no record of that student.</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>
+<p class="toc_element">
+ <code><a href="#patch">patch(studentId, invitationId, body, updateMask=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Modifies a guardian invitation. Currently, the only valid modification is to change the `state` from `PENDING` to `COMPLETE`. This has the effect of withdrawing the invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the current user does not have permission to manage guardians, if guardians are not enabled for the domain in question or for other access errors. * `FAILED_PRECONDITION` if the guardian link is not in the `PENDING` state. * `INVALID_ARGUMENT` if the format of the student ID provided cannot be recognized (it is not an email address, nor a `user_id` from this API), or if the passed `GuardianInvitation` has a `state` other than `COMPLETE`, or if it modifies fields other than `state`. * `NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student, or if the `id` field does not refer to a guardian invitation known to Classroom.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="create">create(studentId, body, x__xgafv=None)</code>
+ <pre>Creates a guardian invitation, and sends an email to the guardian asking them to confirm that they are the student's guardian. Once the guardian accepts the invitation, their `state` will change to `COMPLETED` and they will start receiving guardian notifications. A `Guardian` resource will also be created to represent the active guardian. The request object must have the `student_id` and `invited_email_address` fields set. Failing to set these fields, or setting any other fields in the request, will result in an error. This method returns the following error codes: * `PERMISSION_DENIED` if the current user does not have permission to manage guardians, if the guardian in question has already rejected too many requests for that student, if guardians are not enabled for the domain in question, or for other access errors. * `RESOURCE_EXHAUSTED` if the student or guardian has exceeded the guardian link limit. * `INVALID_ARGUMENT` if the guardian email address is not valid (for example, if it is too long), or if the format of the student ID provided cannot be recognized (it is not an email address, nor a `user_id` from this API). This error will also be returned if read-only fields are set, or if the `state` field is set to to a value other than `PENDING`. * `NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student. * `ALREADY_EXISTS` if there is already a pending guardian invitation for the student and `invited_email_address` provided, or if the provided `invited_email_address` matches the Google account of an existing `Guardian` for this user.
+
+Args:
+ studentId: string, ID of the student (in standard format) (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An invitation to become the guardian of a specified user, sent to a specified email address.
+ "invitationId": "A String", # Unique identifier for this invitation. Read-only.
+ "studentId": "A String", # ID of the student (in standard format)
+ "creationTime": "A String", # The time that this invitation was created. Read-only.
+ "invitedEmailAddress": "A String", # Email address that the invitation was sent to. This field is only visible to domain administrators.
+ "state": "A String", # The state that this invitation is in.
+ }
+
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # An invitation to become the guardian of a specified user, sent to a specified email address.
+ "invitationId": "A String", # Unique identifier for this invitation. Read-only.
+ "studentId": "A String", # ID of the student (in standard format)
+ "creationTime": "A String", # The time that this invitation was created. Read-only.
+ "invitedEmailAddress": "A String", # Email address that the invitation was sent to. This field is only visible to domain administrators.
+ "state": "A String", # The state that this invitation is in.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(studentId, invitationId, x__xgafv=None)</code>
+ <pre>Returns a specific guardian invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view guardian invitations for the student identified by the `student_id`, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). * `NOT_FOUND` if Classroom cannot find any record of the given student or `invitation_id`. May also be returned if the student exists, but the requesting user does not have access to see that student.
+
+Args:
+ studentId: string, The ID of the student whose guardian invitation is being requested. (required)
+ invitationId: string, The `id` field of the `GuardianInvitation` being requested. (required)
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # An invitation to become the guardian of a specified user, sent to a specified email address.
+ "invitationId": "A String", # Unique identifier for this invitation. Read-only.
+ "studentId": "A String", # ID of the student (in standard format)
+ "creationTime": "A String", # The time that this invitation was created. Read-only.
+ "invitedEmailAddress": "A String", # Email address that the invitation was sent to. This field is only visible to domain administrators.
+ "state": "A String", # The state that this invitation is in.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(studentId, invitedEmailAddress=None, pageSize=None, states=None, pageToken=None, x__xgafv=None)</code>
+ <pre>Returns a list of guardian invitations that the requesting user is permitted to view, filtered by the parameters provided. This method returns the following error codes: * `PERMISSION_DENIED` if a `student_id` is specified, and the requesting user is not permitted to view guardian invitations for that student, if `"-"` is specified as the `student_id` and the user is not a domain administrator, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). May also be returned if an invalid `page_token` or `state` is provided. * `NOT_FOUND` if a `student_id` is specified, and its format can be recognized, but Classroom has no record of that student.
+
+Args:
+ studentId: string, The ID of the student whose guardian invitations are to be returned. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user * the string literal `"-"`, indicating that results should be returned for all students that the requesting user is permitted to view guardian invitations. (required)
+ invitedEmailAddress: string, If specified, only results with the specified `invited_email_address` will be returned.
+ pageSize: integer, Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
+ states: string, If specified, only results with the specified `state` values will be returned. Otherwise, results with a `state` of `PENDING` will be returned. (repeated)
+ pageToken: string, nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # Response when listing guardian invitations.
+ "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further results are available.
+ "guardianInvitations": [ # Guardian invitations that matched the list request.
+ { # An invitation to become the guardian of a specified user, sent to a specified email address.
+ "invitationId": "A String", # Unique identifier for this invitation. Read-only.
+ "studentId": "A String", # ID of the student (in standard format)
+ "creationTime": "A String", # The time that this invitation was created. Read-only.
+ "invitedEmailAddress": "A String", # Email address that the invitation was sent to. This field is only visible to domain administrators.
+ "state": "A String", # The state that this invitation is in.
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
+ <pre>Retrieves the next page of results.
+
+Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+Returns:
+ A request object that you can call 'execute()' on to request the next
+ page. Returns None if there are no more items in the collection.
+ </pre>
+</div>
+
+<div class="method">
+ <code class="details" id="patch">patch(studentId, invitationId, body, updateMask=None, x__xgafv=None)</code>
+ <pre>Modifies a guardian invitation. Currently, the only valid modification is to change the `state` from `PENDING` to `COMPLETE`. This has the effect of withdrawing the invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the current user does not have permission to manage guardians, if guardians are not enabled for the domain in question or for other access errors. * `FAILED_PRECONDITION` if the guardian link is not in the `PENDING` state. * `INVALID_ARGUMENT` if the format of the student ID provided cannot be recognized (it is not an email address, nor a `user_id` from this API), or if the passed `GuardianInvitation` has a `state` other than `COMPLETE`, or if it modifies fields other than `state`. * `NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student, or if the `id` field does not refer to a guardian invitation known to Classroom.
+
+Args:
+ studentId: string, The ID of the student whose guardian invitation is to be modified. (required)
+ invitationId: string, The `id` field of the `GuardianInvitation` to be modified. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An invitation to become the guardian of a specified user, sent to a specified email address.
+ "invitationId": "A String", # Unique identifier for this invitation. Read-only.
+ "studentId": "A String", # ID of the student (in standard format)
+ "creationTime": "A String", # The time that this invitation was created. Read-only.
+ "invitedEmailAddress": "A String", # Email address that the invitation was sent to. This field is only visible to domain administrators.
+ "state": "A String", # The state that this invitation is in.
+ }
+
+ updateMask: string, Mask that identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. The following fields are valid: * `state` When set in a query parameter, this field should be specified as `updateMask=,,...`
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # An invitation to become the guardian of a specified user, sent to a specified email address.
+ "invitationId": "A String", # Unique identifier for this invitation. Read-only.
+ "studentId": "A String", # ID of the student (in standard format)
+ "creationTime": "A String", # The time that this invitation was created. Read-only.
+ "invitedEmailAddress": "A String", # Email address that the invitation was sent to. This field is only visible to domain administrators.
+ "state": "A String", # The state that this invitation is in.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/classroom_v1.userProfiles.guardians.html b/docs/dyn/classroom_v1.userProfiles.guardians.html
new file mode 100644
index 0000000..93faa57
--- /dev/null
+++ b/docs/dyn/classroom_v1.userProfiles.guardians.html
@@ -0,0 +1,195 @@
+<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="classroom_v1.html">Google Classroom API</a> . <a href="classroom_v1.userProfiles.html">userProfiles</a> . <a href="classroom_v1.userProfiles.guardians.html">guardians</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(studentId, guardianId, x__xgafv=None)</a></code></p>
+<p class="firstline">Deletes a guardian. The guardian will no longer receive guardian notifications and the guardian will no longer be accessible via the API. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to manage guardians for the student identified by the `student_id`, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API). * `NOT_FOUND` if Classroom cannot find any record of the given `student_id` or `guardian_id`, or if the guardian has already been disabled.</p>
+<p class="toc_element">
+ <code><a href="#get">get(studentId, guardianId, x__xgafv=None)</a></code></p>
+<p class="firstline">Returns a specific guardian. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view guardian information for the student identified by the `student_id`, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). * `NOT_FOUND` if Classroom cannot find any record of the given student or `guardian_id`, or if the guardian has been disabled.</p>
+<p class="toc_element">
+ <code><a href="#list">list(studentId, invitedEmailAddress=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Returns a list of guardians that the requesting user is permitted to view, restricted to those that match the request. To list guardians for any student that the requesting user may view guardians for, use the literal character `-` for the student ID. This method returns the following error codes: * `PERMISSION_DENIED` if a `student_id` is specified, and the requesting user is not permitted to view guardian information for that student, if `"-"` is specified as the `student_id` and the user is not a domain administrator, if guardians are not enabled for the domain in question, if the `invited_email_address` filter is set by a user who is not a domain administrator, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). May also be returned if an invalid `page_token` is provided. * `NOT_FOUND` if a `student_id` is specified, and its format can be recognized, but Classroom has no record of that student.</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>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(studentId, guardianId, x__xgafv=None)</code>
+ <pre>Deletes a guardian. The guardian will no longer receive guardian notifications and the guardian will no longer be accessible via the API. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to manage guardians for the student identified by the `student_id`, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API). * `NOT_FOUND` if Classroom cannot find any record of the given `student_id` or `guardian_id`, or if the guardian has already been disabled.
+
+Args:
+ studentId: string, The student whose guardian is to be deleted. One of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user (required)
+ guardianId: string, The `id` field from a `Guardian`. (required)
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(studentId, guardianId, x__xgafv=None)</code>
+ <pre>Returns a specific guardian. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view guardian information for the student identified by the `student_id`, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). * `NOT_FOUND` if Classroom cannot find any record of the given student or `guardian_id`, or if the guardian has been disabled.
+
+Args:
+ studentId: string, The student whose guardian is being requested. One of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user (required)
+ guardianId: string, The `id` field from a `Guardian`. (required)
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # Association between a student and a guardian of that student. The guardian may receive information about the student's course work.
+ "guardianId": "A String", # Identifier for the guardian.
+ "guardianProfile": { # Global information for a user. # User profile for the guardian.
+ "permissions": [ # Global permissions of the user. Read-only.
+ { # Global user permission description.
+ "permission": "A String", # Permission value.
+ },
+ ],
+ "photoUrl": "A String", # URL of user's profile photo. Read-only.
+ "emailAddress": "A String", # Email address of the user. Read-only.
+ "id": "A String", # Identifier of the user. Read-only.
+ "name": { # Details of the user's name. # Name of the user. Read-only.
+ "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only.
+ "givenName": "A String", # The user's first name. Read-only.
+ "familyName": "A String", # The user's last name. Read-only.
+ },
+ },
+ "studentId": "A String", # Identifier for the student to whom the guardian relationship applies.
+ "invitedEmailAddress": "A String", # The email address to which the initial guardian invitation was sent. This field is only visible to domain administrators.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(studentId, invitedEmailAddress=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
+ <pre>Returns a list of guardians that the requesting user is permitted to view, restricted to those that match the request. To list guardians for any student that the requesting user may view guardians for, use the literal character `-` for the student ID. This method returns the following error codes: * `PERMISSION_DENIED` if a `student_id` is specified, and the requesting user is not permitted to view guardian information for that student, if `"-"` is specified as the `student_id` and the user is not a domain administrator, if guardians are not enabled for the domain in question, if the `invited_email_address` filter is set by a user who is not a domain administrator, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). May also be returned if an invalid `page_token` is provided. * `NOT_FOUND` if a `student_id` is specified, and its format can be recognized, but Classroom has no record of that student.
+
+Args:
+ studentId: string, Filter results by the student who the guardian is linked to. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user * the string literal `"-"`, indicating that results should be returned for all students that the requesting user has access to view. (required)
+ invitedEmailAddress: string, Filter results by the email address that the original invitation was sent to, resulting in this guardian link. This filter can only be used by domain administrators.
+ pageSize: integer, Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
+ pageToken: string, nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # Response when listing guardians.
+ "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further results are available.
+ "guardians": [ # Guardians on this page of results that met the criteria specified in the request.
+ { # Association between a student and a guardian of that student. The guardian may receive information about the student's course work.
+ "guardianId": "A String", # Identifier for the guardian.
+ "guardianProfile": { # Global information for a user. # User profile for the guardian.
+ "permissions": [ # Global permissions of the user. Read-only.
+ { # Global user permission description.
+ "permission": "A String", # Permission value.
+ },
+ ],
+ "photoUrl": "A String", # URL of user's profile photo. Read-only.
+ "emailAddress": "A String", # Email address of the user. Read-only.
+ "id": "A String", # Identifier of the user. Read-only.
+ "name": { # Details of the user's name. # Name of the user. Read-only.
+ "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only.
+ "givenName": "A String", # The user's first name. Read-only.
+ "familyName": "A String", # The user's last name. Read-only.
+ },
+ },
+ "studentId": "A String", # Identifier for the student to whom the guardian relationship applies.
+ "invitedEmailAddress": "A String", # The email address to which the initial guardian invitation was sent. This field is only visible to domain administrators.
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
+ <pre>Retrieves the next page of results.
+
+Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+Returns:
+ A request object that you can call 'execute()' on to request the next
+ page. Returns None if there are no more items in the collection.
+ </pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/cloudbuild_v1.operations.html b/docs/dyn/cloudbuild_v1.operations.html
index 974f4ff..493f9a6 100644
--- a/docs/dyn/cloudbuild_v1.operations.html
+++ b/docs/dyn/cloudbuild_v1.operations.html
@@ -124,7 +124,7 @@
"name": "A String", # The server-assigned name, which is only unique within the same service that
# originally returns it. If you use the default HTTP mapping, the
# `name` should have the format of `operations/some/unique/name`.
- "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure.
+ "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
# programming environments, including REST APIs and RPC APIs. It is used by
# [gRPC](https://github.com/grpc). The error model is designed to be:
#
@@ -238,7 +238,7 @@
"name": "A String", # The server-assigned name, which is only unique within the same service that
# originally returns it. If you use the default HTTP mapping, the
# `name` should have the format of `operations/some/unique/name`.
- "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure.
+ "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
# programming environments, including REST APIs and RPC APIs. It is used by
# [gRPC](https://github.com/grpc). The error model is designed to be:
#
diff --git a/docs/dyn/cloudbuild_v1.projects.builds.html b/docs/dyn/cloudbuild_v1.projects.builds.html
index 5c40535..1ab68eb 100644
--- a/docs/dyn/cloudbuild_v1.projects.builds.html
+++ b/docs/dyn/cloudbuild_v1.projects.builds.html
@@ -84,7 +84,7 @@
<code><a href="#get">get(projectId, id, x__xgafv=None)</a></code></p>
<p class="firstline">Returns information about a previously requested build.</p>
<p class="toc_element">
- <code><a href="#list">list(projectId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(projectId, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists previously requested builds.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -116,6 +116,17 @@
# At a high level, a Build describes where to find source code, how to build
# it (for example, the builder image to run on the source), and what tag to
# apply to the built image when it is pushed to Google Container Registry.
+ #
+ # Fields can include the following variables which will be expanded when the
+ # build is created:
+ #
+ # - $PROJECT_ID: the project ID of the build.
+ # - $BUILD_ID: the autogenerated ID of the build.
+ # - $REPO_NAME: the source repository name specified by RepoSource.
+ # - $BRANCH_NAME: the branch name specified by RepoSource.
+ # - $TAG_NAME: the tag name specified by RepoSource.
+ # - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or
+ # resolved from the specified branch or tag.
"status": "A String", # Status of the build.
# @OutputOnly
"finishTime": "A String", # Time at which execution of the build was finished.
@@ -184,12 +195,35 @@
# successfully.
"A String",
],
- "name": "A String", # Name of the container image to use for creating this stage in the
- # pipeline, as presented to `docker pull`.
- "args": [ # Command-line arguments to use when running this step's container.
+ "name": "A String", # The name of the container image that will run this particular build step.
+ #
+ # If the image is already available in the host's
+ # Docker daemon's cache, it will be run directly. If not, the host will
+ # attempt to pull the image first, using the builder service account's
+ # credentials if necessary.
+ #
+ # The Docker daemon's cache will already have the latest versions of all of
+ # the officially supported build steps
+ # (https://github.com/GoogleCloudPlatform/cloud-builders). The Docker daemon
+ # will also have cached many of the layers for some popular images, like
+ # "ubuntu", "debian", but they will be refreshed at the time you attempt to
+ # use them.
+ #
+ # If you built an image in a previous build step, it will be stored in the
+ # host's Docker daemon's cache and is available to use as the name for a
+ # later build step.
+ "args": [ # A list of arguments that will be presented to the step when it is started.
+ #
+ # If the image used to run the step's container has an entrypoint, these args
+ # will be used as arguments to that entrypoint. If the image does not define
+ # an entrypoint, the first element in args will be used as the entrypoint,
+ # and the remainder will be used as arguments.
"A String",
],
- "env": [ # Additional environment variables to set for this step's container.
+ "env": [ # A list of environment variable definitions to be used when running a step.
+ #
+ # The elements are of the form "KEY=VALUE" for the environment variable "KEY"
+ # being given the value "VALUE".
"A String",
],
"id": "A String", # Optional unique identifier for this build step, used in wait_for to
@@ -247,14 +281,20 @@
},
"projectId": "A String", # ID of the project.
# @OutputOnly.
- "images": [ # List of images expected to be built and pushed to Google Container
- # Registry. If an image is listed here and the image is not produced by
- # one of the build steps, the build will fail. Any images present when
- # the build steps are complete will be pushed to Container Registry.
+ "images": [ # A list of images to be pushed upon the successful completion of all build
+ # steps.
+ #
+ # The images will be pushed using the builder
+ # service account's credentials.
+ #
+ # The digests of the pushed images will be stored in the Build resource's
+ # results field.
+ #
+ # If any of the images fail to be pushed, the build is marked FAILURE.
"A String",
],
"options": { # Optional arguments to enable specific features of builds. # Special options for this build.
- "requestedVerifyOption": "A String", # Options for a verifiable build with details uploaded to the Analysis API.
+ "requestedVerifyOption": "A String", # Requested verifiability options.
"sourceProvenanceHash": [ # Requested hash for SourceProvenance.
"A String",
],
@@ -282,6 +322,17 @@
# At a high level, a Build describes where to find source code, how to build
# it (for example, the builder image to run on the source), and what tag to
# apply to the built image when it is pushed to Google Container Registry.
+ #
+ # Fields can include the following variables which will be expanded when the
+ # build is created:
+ #
+ # - $PROJECT_ID: the project ID of the build.
+ # - $BUILD_ID: the autogenerated ID of the build.
+ # - $REPO_NAME: the source repository name specified by RepoSource.
+ # - $BRANCH_NAME: the branch name specified by RepoSource.
+ # - $TAG_NAME: the tag name specified by RepoSource.
+ # - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or
+ # resolved from the specified branch or tag.
"status": "A String", # Status of the build.
# @OutputOnly
"finishTime": "A String", # Time at which execution of the build was finished.
@@ -350,12 +401,35 @@
# successfully.
"A String",
],
- "name": "A String", # Name of the container image to use for creating this stage in the
- # pipeline, as presented to `docker pull`.
- "args": [ # Command-line arguments to use when running this step's container.
+ "name": "A String", # The name of the container image that will run this particular build step.
+ #
+ # If the image is already available in the host's
+ # Docker daemon's cache, it will be run directly. If not, the host will
+ # attempt to pull the image first, using the builder service account's
+ # credentials if necessary.
+ #
+ # The Docker daemon's cache will already have the latest versions of all of
+ # the officially supported build steps
+ # (https://github.com/GoogleCloudPlatform/cloud-builders). The Docker daemon
+ # will also have cached many of the layers for some popular images, like
+ # "ubuntu", "debian", but they will be refreshed at the time you attempt to
+ # use them.
+ #
+ # If you built an image in a previous build step, it will be stored in the
+ # host's Docker daemon's cache and is available to use as the name for a
+ # later build step.
+ "args": [ # A list of arguments that will be presented to the step when it is started.
+ #
+ # If the image used to run the step's container has an entrypoint, these args
+ # will be used as arguments to that entrypoint. If the image does not define
+ # an entrypoint, the first element in args will be used as the entrypoint,
+ # and the remainder will be used as arguments.
"A String",
],
- "env": [ # Additional environment variables to set for this step's container.
+ "env": [ # A list of environment variable definitions to be used when running a step.
+ #
+ # The elements are of the form "KEY=VALUE" for the environment variable "KEY"
+ # being given the value "VALUE".
"A String",
],
"id": "A String", # Optional unique identifier for this build step, used in wait_for to
@@ -413,14 +487,20 @@
},
"projectId": "A String", # ID of the project.
# @OutputOnly.
- "images": [ # List of images expected to be built and pushed to Google Container
- # Registry. If an image is listed here and the image is not produced by
- # one of the build steps, the build will fail. Any images present when
- # the build steps are complete will be pushed to Container Registry.
+ "images": [ # A list of images to be pushed upon the successful completion of all build
+ # steps.
+ #
+ # The images will be pushed using the builder
+ # service account's credentials.
+ #
+ # The digests of the pushed images will be stored in the Build resource's
+ # results field.
+ #
+ # If any of the images fail to be pushed, the build is marked FAILURE.
"A String",
],
"options": { # Optional arguments to enable specific features of builds. # Special options for this build.
- "requestedVerifyOption": "A String", # Options for a verifiable build with details uploaded to the Analysis API.
+ "requestedVerifyOption": "A String", # Requested verifiability options.
"sourceProvenanceHash": [ # Requested hash for SourceProvenance.
"A String",
],
@@ -461,7 +541,7 @@
"name": "A String", # The server-assigned name, which is only unique within the same service that
# originally returns it. If you use the default HTTP mapping, the
# `name` should have the format of `operations/some/unique/name`.
- "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure.
+ "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
# programming environments, including REST APIs and RPC APIs. It is used by
# [gRPC](https://github.com/grpc). The error model is designed to be:
#
@@ -550,6 +630,17 @@
# At a high level, a Build describes where to find source code, how to build
# it (for example, the builder image to run on the source), and what tag to
# apply to the built image when it is pushed to Google Container Registry.
+ #
+ # Fields can include the following variables which will be expanded when the
+ # build is created:
+ #
+ # - $PROJECT_ID: the project ID of the build.
+ # - $BUILD_ID: the autogenerated ID of the build.
+ # - $REPO_NAME: the source repository name specified by RepoSource.
+ # - $BRANCH_NAME: the branch name specified by RepoSource.
+ # - $TAG_NAME: the tag name specified by RepoSource.
+ # - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or
+ # resolved from the specified branch or tag.
"status": "A String", # Status of the build.
# @OutputOnly
"finishTime": "A String", # Time at which execution of the build was finished.
@@ -618,12 +709,35 @@
# successfully.
"A String",
],
- "name": "A String", # Name of the container image to use for creating this stage in the
- # pipeline, as presented to `docker pull`.
- "args": [ # Command-line arguments to use when running this step's container.
+ "name": "A String", # The name of the container image that will run this particular build step.
+ #
+ # If the image is already available in the host's
+ # Docker daemon's cache, it will be run directly. If not, the host will
+ # attempt to pull the image first, using the builder service account's
+ # credentials if necessary.
+ #
+ # The Docker daemon's cache will already have the latest versions of all of
+ # the officially supported build steps
+ # (https://github.com/GoogleCloudPlatform/cloud-builders). The Docker daemon
+ # will also have cached many of the layers for some popular images, like
+ # "ubuntu", "debian", but they will be refreshed at the time you attempt to
+ # use them.
+ #
+ # If you built an image in a previous build step, it will be stored in the
+ # host's Docker daemon's cache and is available to use as the name for a
+ # later build step.
+ "args": [ # A list of arguments that will be presented to the step when it is started.
+ #
+ # If the image used to run the step's container has an entrypoint, these args
+ # will be used as arguments to that entrypoint. If the image does not define
+ # an entrypoint, the first element in args will be used as the entrypoint,
+ # and the remainder will be used as arguments.
"A String",
],
- "env": [ # Additional environment variables to set for this step's container.
+ "env": [ # A list of environment variable definitions to be used when running a step.
+ #
+ # The elements are of the form "KEY=VALUE" for the environment variable "KEY"
+ # being given the value "VALUE".
"A String",
],
"id": "A String", # Optional unique identifier for this build step, used in wait_for to
@@ -681,14 +795,20 @@
},
"projectId": "A String", # ID of the project.
# @OutputOnly.
- "images": [ # List of images expected to be built and pushed to Google Container
- # Registry. If an image is listed here and the image is not produced by
- # one of the build steps, the build will fail. Any images present when
- # the build steps are complete will be pushed to Container Registry.
+ "images": [ # A list of images to be pushed upon the successful completion of all build
+ # steps.
+ #
+ # The images will be pushed using the builder
+ # service account's credentials.
+ #
+ # The digests of the pushed images will be stored in the Build resource's
+ # results field.
+ #
+ # If any of the images fail to be pushed, the build is marked FAILURE.
"A String",
],
"options": { # Optional arguments to enable specific features of builds. # Special options for this build.
- "requestedVerifyOption": "A String", # Options for a verifiable build with details uploaded to the Analysis API.
+ "requestedVerifyOption": "A String", # Requested verifiability options.
"sourceProvenanceHash": [ # Requested hash for SourceProvenance.
"A String",
],
@@ -699,7 +819,7 @@
</div>
<div class="method">
- <code class="details" id="list">list(projectId, pageSize=None, pageToken=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(projectId, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists previously requested builds.
Previously requested builds may still be in-progress, or may have finished
@@ -708,6 +828,7 @@
Args:
projectId: string, ID of the project. (required)
pageSize: integer, Number of results to return in the list.
+ filter: string, The raw filter text to constrain the results.
pageToken: string, Token to provide to skip to a particular spot in the list.
x__xgafv: string, V1 error format.
Allowed values
@@ -725,6 +846,17 @@
# At a high level, a Build describes where to find source code, how to build
# it (for example, the builder image to run on the source), and what tag to
# apply to the built image when it is pushed to Google Container Registry.
+ #
+ # Fields can include the following variables which will be expanded when the
+ # build is created:
+ #
+ # - $PROJECT_ID: the project ID of the build.
+ # - $BUILD_ID: the autogenerated ID of the build.
+ # - $REPO_NAME: the source repository name specified by RepoSource.
+ # - $BRANCH_NAME: the branch name specified by RepoSource.
+ # - $TAG_NAME: the tag name specified by RepoSource.
+ # - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or
+ # resolved from the specified branch or tag.
"status": "A String", # Status of the build.
# @OutputOnly
"finishTime": "A String", # Time at which execution of the build was finished.
@@ -793,12 +925,35 @@
# successfully.
"A String",
],
- "name": "A String", # Name of the container image to use for creating this stage in the
- # pipeline, as presented to `docker pull`.
- "args": [ # Command-line arguments to use when running this step's container.
+ "name": "A String", # The name of the container image that will run this particular build step.
+ #
+ # If the image is already available in the host's
+ # Docker daemon's cache, it will be run directly. If not, the host will
+ # attempt to pull the image first, using the builder service account's
+ # credentials if necessary.
+ #
+ # The Docker daemon's cache will already have the latest versions of all of
+ # the officially supported build steps
+ # (https://github.com/GoogleCloudPlatform/cloud-builders). The Docker daemon
+ # will also have cached many of the layers for some popular images, like
+ # "ubuntu", "debian", but they will be refreshed at the time you attempt to
+ # use them.
+ #
+ # If you built an image in a previous build step, it will be stored in the
+ # host's Docker daemon's cache and is available to use as the name for a
+ # later build step.
+ "args": [ # A list of arguments that will be presented to the step when it is started.
+ #
+ # If the image used to run the step's container has an entrypoint, these args
+ # will be used as arguments to that entrypoint. If the image does not define
+ # an entrypoint, the first element in args will be used as the entrypoint,
+ # and the remainder will be used as arguments.
"A String",
],
- "env": [ # Additional environment variables to set for this step's container.
+ "env": [ # A list of environment variable definitions to be used when running a step.
+ #
+ # The elements are of the form "KEY=VALUE" for the environment variable "KEY"
+ # being given the value "VALUE".
"A String",
],
"id": "A String", # Optional unique identifier for this build step, used in wait_for to
@@ -856,14 +1011,20 @@
},
"projectId": "A String", # ID of the project.
# @OutputOnly.
- "images": [ # List of images expected to be built and pushed to Google Container
- # Registry. If an image is listed here and the image is not produced by
- # one of the build steps, the build will fail. Any images present when
- # the build steps are complete will be pushed to Container Registry.
+ "images": [ # A list of images to be pushed upon the successful completion of all build
+ # steps.
+ #
+ # The images will be pushed using the builder
+ # service account's credentials.
+ #
+ # The digests of the pushed images will be stored in the Build resource's
+ # results field.
+ #
+ # If any of the images fail to be pushed, the build is marked FAILURE.
"A String",
],
"options": { # Optional arguments to enable specific features of builds. # Special options for this build.
- "requestedVerifyOption": "A String", # Options for a verifiable build with details uploaded to the Analysis API.
+ "requestedVerifyOption": "A String", # Requested verifiability options.
"sourceProvenanceHash": [ # Requested hash for SourceProvenance.
"A String",
],
diff --git a/docs/dyn/cloudbuild_v1.projects.triggers.html b/docs/dyn/cloudbuild_v1.projects.triggers.html
index 1a16924..95aecd5 100644
--- a/docs/dyn/cloudbuild_v1.projects.triggers.html
+++ b/docs/dyn/cloudbuild_v1.projects.triggers.html
@@ -103,14 +103,29 @@
{ # Configuration for an automated build in response to source repository
# changes.
- "id": "A String", # Unique identifier of the trigger.
+ "description": "A String", # Human-readable description of this trigger.
+ "createTime": "A String", # Time when the trigger was created.
#
# @OutputOnly
+ "filename": "A String", # Path, from the source root, to a file whose contents is used for the
+ # template.
+ "disabled": True or False, # If true, the trigger will never result in a build.
"build": { # A build resource in the Container Builder API. # Contents of the build template.
#
# At a high level, a Build describes where to find source code, how to build
# it (for example, the builder image to run on the source), and what tag to
# apply to the built image when it is pushed to Google Container Registry.
+ #
+ # Fields can include the following variables which will be expanded when the
+ # build is created:
+ #
+ # - $PROJECT_ID: the project ID of the build.
+ # - $BUILD_ID: the autogenerated ID of the build.
+ # - $REPO_NAME: the source repository name specified by RepoSource.
+ # - $BRANCH_NAME: the branch name specified by RepoSource.
+ # - $TAG_NAME: the tag name specified by RepoSource.
+ # - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or
+ # resolved from the specified branch or tag.
"status": "A String", # Status of the build.
# @OutputOnly
"finishTime": "A String", # Time at which execution of the build was finished.
@@ -179,12 +194,35 @@
# successfully.
"A String",
],
- "name": "A String", # Name of the container image to use for creating this stage in the
- # pipeline, as presented to `docker pull`.
- "args": [ # Command-line arguments to use when running this step's container.
+ "name": "A String", # The name of the container image that will run this particular build step.
+ #
+ # If the image is already available in the host's
+ # Docker daemon's cache, it will be run directly. If not, the host will
+ # attempt to pull the image first, using the builder service account's
+ # credentials if necessary.
+ #
+ # The Docker daemon's cache will already have the latest versions of all of
+ # the officially supported build steps
+ # (https://github.com/GoogleCloudPlatform/cloud-builders). The Docker daemon
+ # will also have cached many of the layers for some popular images, like
+ # "ubuntu", "debian", but they will be refreshed at the time you attempt to
+ # use them.
+ #
+ # If you built an image in a previous build step, it will be stored in the
+ # host's Docker daemon's cache and is available to use as the name for a
+ # later build step.
+ "args": [ # A list of arguments that will be presented to the step when it is started.
+ #
+ # If the image used to run the step's container has an entrypoint, these args
+ # will be used as arguments to that entrypoint. If the image does not define
+ # an entrypoint, the first element in args will be used as the entrypoint,
+ # and the remainder will be used as arguments.
"A String",
],
- "env": [ # Additional environment variables to set for this step's container.
+ "env": [ # A list of environment variable definitions to be used when running a step.
+ #
+ # The elements are of the form "KEY=VALUE" for the environment variable "KEY"
+ # being given the value "VALUE".
"A String",
],
"id": "A String", # Optional unique identifier for this build step, used in wait_for to
@@ -242,14 +280,20 @@
},
"projectId": "A String", # ID of the project.
# @OutputOnly.
- "images": [ # List of images expected to be built and pushed to Google Container
- # Registry. If an image is listed here and the image is not produced by
- # one of the build steps, the build will fail. Any images present when
- # the build steps are complete will be pushed to Container Registry.
+ "images": [ # A list of images to be pushed upon the successful completion of all build
+ # steps.
+ #
+ # The images will be pushed using the builder
+ # service account's credentials.
+ #
+ # The digests of the pushed images will be stored in the Build resource's
+ # results field.
+ #
+ # If any of the images fail to be pushed, the build is marked FAILURE.
"A String",
],
"options": { # Optional arguments to enable specific features of builds. # Special options for this build.
- "requestedVerifyOption": "A String", # Options for a verifiable build with details uploaded to the Analysis API.
+ "requestedVerifyOption": "A String", # Requested verifiability options.
"sourceProvenanceHash": [ # Requested hash for SourceProvenance.
"A String",
],
@@ -257,6 +301,9 @@
"logUrl": "A String", # URL to logs for this build in Google Cloud Logging.
# @OutputOnly
},
+ "id": "A String", # Unique identifier of the trigger.
+ #
+ # @OutputOnly
"triggerTemplate": { # RepoSource describes the location of the source in a Google Cloud Source # Template describing the types of source changes to trigger a build.
#
# Branch and tag names in trigger templates are interpreted as regular
@@ -270,11 +317,6 @@
"tagName": "A String", # Name of the tag to build.
"commitSha": "A String", # Explicit commit SHA to build.
},
- "createTime": "A String", # Time when the trigger was created.
- #
- # @OutputOnly
- "filename": "A String", # Path, from the source root, to a file whose contents is used for the
- # template.
}
x__xgafv: string, V1 error format.
@@ -287,14 +329,29 @@
{ # Configuration for an automated build in response to source repository
# changes.
- "id": "A String", # Unique identifier of the trigger.
+ "description": "A String", # Human-readable description of this trigger.
+ "createTime": "A String", # Time when the trigger was created.
#
# @OutputOnly
+ "filename": "A String", # Path, from the source root, to a file whose contents is used for the
+ # template.
+ "disabled": True or False, # If true, the trigger will never result in a build.
"build": { # A build resource in the Container Builder API. # Contents of the build template.
#
# At a high level, a Build describes where to find source code, how to build
# it (for example, the builder image to run on the source), and what tag to
# apply to the built image when it is pushed to Google Container Registry.
+ #
+ # Fields can include the following variables which will be expanded when the
+ # build is created:
+ #
+ # - $PROJECT_ID: the project ID of the build.
+ # - $BUILD_ID: the autogenerated ID of the build.
+ # - $REPO_NAME: the source repository name specified by RepoSource.
+ # - $BRANCH_NAME: the branch name specified by RepoSource.
+ # - $TAG_NAME: the tag name specified by RepoSource.
+ # - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or
+ # resolved from the specified branch or tag.
"status": "A String", # Status of the build.
# @OutputOnly
"finishTime": "A String", # Time at which execution of the build was finished.
@@ -363,12 +420,35 @@
# successfully.
"A String",
],
- "name": "A String", # Name of the container image to use for creating this stage in the
- # pipeline, as presented to `docker pull`.
- "args": [ # Command-line arguments to use when running this step's container.
+ "name": "A String", # The name of the container image that will run this particular build step.
+ #
+ # If the image is already available in the host's
+ # Docker daemon's cache, it will be run directly. If not, the host will
+ # attempt to pull the image first, using the builder service account's
+ # credentials if necessary.
+ #
+ # The Docker daemon's cache will already have the latest versions of all of
+ # the officially supported build steps
+ # (https://github.com/GoogleCloudPlatform/cloud-builders). The Docker daemon
+ # will also have cached many of the layers for some popular images, like
+ # "ubuntu", "debian", but they will be refreshed at the time you attempt to
+ # use them.
+ #
+ # If you built an image in a previous build step, it will be stored in the
+ # host's Docker daemon's cache and is available to use as the name for a
+ # later build step.
+ "args": [ # A list of arguments that will be presented to the step when it is started.
+ #
+ # If the image used to run the step's container has an entrypoint, these args
+ # will be used as arguments to that entrypoint. If the image does not define
+ # an entrypoint, the first element in args will be used as the entrypoint,
+ # and the remainder will be used as arguments.
"A String",
],
- "env": [ # Additional environment variables to set for this step's container.
+ "env": [ # A list of environment variable definitions to be used when running a step.
+ #
+ # The elements are of the form "KEY=VALUE" for the environment variable "KEY"
+ # being given the value "VALUE".
"A String",
],
"id": "A String", # Optional unique identifier for this build step, used in wait_for to
@@ -426,14 +506,20 @@
},
"projectId": "A String", # ID of the project.
# @OutputOnly.
- "images": [ # List of images expected to be built and pushed to Google Container
- # Registry. If an image is listed here and the image is not produced by
- # one of the build steps, the build will fail. Any images present when
- # the build steps are complete will be pushed to Container Registry.
+ "images": [ # A list of images to be pushed upon the successful completion of all build
+ # steps.
+ #
+ # The images will be pushed using the builder
+ # service account's credentials.
+ #
+ # The digests of the pushed images will be stored in the Build resource's
+ # results field.
+ #
+ # If any of the images fail to be pushed, the build is marked FAILURE.
"A String",
],
"options": { # Optional arguments to enable specific features of builds. # Special options for this build.
- "requestedVerifyOption": "A String", # Options for a verifiable build with details uploaded to the Analysis API.
+ "requestedVerifyOption": "A String", # Requested verifiability options.
"sourceProvenanceHash": [ # Requested hash for SourceProvenance.
"A String",
],
@@ -441,6 +527,9 @@
"logUrl": "A String", # URL to logs for this build in Google Cloud Logging.
# @OutputOnly
},
+ "id": "A String", # Unique identifier of the trigger.
+ #
+ # @OutputOnly
"triggerTemplate": { # RepoSource describes the location of the source in a Google Cloud Source # Template describing the types of source changes to trigger a build.
#
# Branch and tag names in trigger templates are interpreted as regular
@@ -454,11 +543,6 @@
"tagName": "A String", # Name of the tag to build.
"commitSha": "A String", # Explicit commit SHA to build.
},
- "createTime": "A String", # Time when the trigger was created.
- #
- # @OutputOnly
- "filename": "A String", # Path, from the source root, to a file whose contents is used for the
- # template.
}</pre>
</div>
@@ -510,14 +594,29 @@
{ # Configuration for an automated build in response to source repository
# changes.
- "id": "A String", # Unique identifier of the trigger.
+ "description": "A String", # Human-readable description of this trigger.
+ "createTime": "A String", # Time when the trigger was created.
#
# @OutputOnly
+ "filename": "A String", # Path, from the source root, to a file whose contents is used for the
+ # template.
+ "disabled": True or False, # If true, the trigger will never result in a build.
"build": { # A build resource in the Container Builder API. # Contents of the build template.
#
# At a high level, a Build describes where to find source code, how to build
# it (for example, the builder image to run on the source), and what tag to
# apply to the built image when it is pushed to Google Container Registry.
+ #
+ # Fields can include the following variables which will be expanded when the
+ # build is created:
+ #
+ # - $PROJECT_ID: the project ID of the build.
+ # - $BUILD_ID: the autogenerated ID of the build.
+ # - $REPO_NAME: the source repository name specified by RepoSource.
+ # - $BRANCH_NAME: the branch name specified by RepoSource.
+ # - $TAG_NAME: the tag name specified by RepoSource.
+ # - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or
+ # resolved from the specified branch or tag.
"status": "A String", # Status of the build.
# @OutputOnly
"finishTime": "A String", # Time at which execution of the build was finished.
@@ -586,12 +685,35 @@
# successfully.
"A String",
],
- "name": "A String", # Name of the container image to use for creating this stage in the
- # pipeline, as presented to `docker pull`.
- "args": [ # Command-line arguments to use when running this step's container.
+ "name": "A String", # The name of the container image that will run this particular build step.
+ #
+ # If the image is already available in the host's
+ # Docker daemon's cache, it will be run directly. If not, the host will
+ # attempt to pull the image first, using the builder service account's
+ # credentials if necessary.
+ #
+ # The Docker daemon's cache will already have the latest versions of all of
+ # the officially supported build steps
+ # (https://github.com/GoogleCloudPlatform/cloud-builders). The Docker daemon
+ # will also have cached many of the layers for some popular images, like
+ # "ubuntu", "debian", but they will be refreshed at the time you attempt to
+ # use them.
+ #
+ # If you built an image in a previous build step, it will be stored in the
+ # host's Docker daemon's cache and is available to use as the name for a
+ # later build step.
+ "args": [ # A list of arguments that will be presented to the step when it is started.
+ #
+ # If the image used to run the step's container has an entrypoint, these args
+ # will be used as arguments to that entrypoint. If the image does not define
+ # an entrypoint, the first element in args will be used as the entrypoint,
+ # and the remainder will be used as arguments.
"A String",
],
- "env": [ # Additional environment variables to set for this step's container.
+ "env": [ # A list of environment variable definitions to be used when running a step.
+ #
+ # The elements are of the form "KEY=VALUE" for the environment variable "KEY"
+ # being given the value "VALUE".
"A String",
],
"id": "A String", # Optional unique identifier for this build step, used in wait_for to
@@ -649,14 +771,20 @@
},
"projectId": "A String", # ID of the project.
# @OutputOnly.
- "images": [ # List of images expected to be built and pushed to Google Container
- # Registry. If an image is listed here and the image is not produced by
- # one of the build steps, the build will fail. Any images present when
- # the build steps are complete will be pushed to Container Registry.
+ "images": [ # A list of images to be pushed upon the successful completion of all build
+ # steps.
+ #
+ # The images will be pushed using the builder
+ # service account's credentials.
+ #
+ # The digests of the pushed images will be stored in the Build resource's
+ # results field.
+ #
+ # If any of the images fail to be pushed, the build is marked FAILURE.
"A String",
],
"options": { # Optional arguments to enable specific features of builds. # Special options for this build.
- "requestedVerifyOption": "A String", # Options for a verifiable build with details uploaded to the Analysis API.
+ "requestedVerifyOption": "A String", # Requested verifiability options.
"sourceProvenanceHash": [ # Requested hash for SourceProvenance.
"A String",
],
@@ -664,6 +792,9 @@
"logUrl": "A String", # URL to logs for this build in Google Cloud Logging.
# @OutputOnly
},
+ "id": "A String", # Unique identifier of the trigger.
+ #
+ # @OutputOnly
"triggerTemplate": { # RepoSource describes the location of the source in a Google Cloud Source # Template describing the types of source changes to trigger a build.
#
# Branch and tag names in trigger templates are interpreted as regular
@@ -677,11 +808,6 @@
"tagName": "A String", # Name of the tag to build.
"commitSha": "A String", # Explicit commit SHA to build.
},
- "createTime": "A String", # Time when the trigger was created.
- #
- # @OutputOnly
- "filename": "A String", # Path, from the source root, to a file whose contents is used for the
- # template.
}</pre>
</div>
@@ -705,14 +831,29 @@
"triggers": [ # BuildTriggers for the project, sorted by create_time descending.
{ # Configuration for an automated build in response to source repository
# changes.
- "id": "A String", # Unique identifier of the trigger.
+ "description": "A String", # Human-readable description of this trigger.
+ "createTime": "A String", # Time when the trigger was created.
#
# @OutputOnly
+ "filename": "A String", # Path, from the source root, to a file whose contents is used for the
+ # template.
+ "disabled": True or False, # If true, the trigger will never result in a build.
"build": { # A build resource in the Container Builder API. # Contents of the build template.
#
# At a high level, a Build describes where to find source code, how to build
# it (for example, the builder image to run on the source), and what tag to
# apply to the built image when it is pushed to Google Container Registry.
+ #
+ # Fields can include the following variables which will be expanded when the
+ # build is created:
+ #
+ # - $PROJECT_ID: the project ID of the build.
+ # - $BUILD_ID: the autogenerated ID of the build.
+ # - $REPO_NAME: the source repository name specified by RepoSource.
+ # - $BRANCH_NAME: the branch name specified by RepoSource.
+ # - $TAG_NAME: the tag name specified by RepoSource.
+ # - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or
+ # resolved from the specified branch or tag.
"status": "A String", # Status of the build.
# @OutputOnly
"finishTime": "A String", # Time at which execution of the build was finished.
@@ -781,12 +922,35 @@
# successfully.
"A String",
],
- "name": "A String", # Name of the container image to use for creating this stage in the
- # pipeline, as presented to `docker pull`.
- "args": [ # Command-line arguments to use when running this step's container.
+ "name": "A String", # The name of the container image that will run this particular build step.
+ #
+ # If the image is already available in the host's
+ # Docker daemon's cache, it will be run directly. If not, the host will
+ # attempt to pull the image first, using the builder service account's
+ # credentials if necessary.
+ #
+ # The Docker daemon's cache will already have the latest versions of all of
+ # the officially supported build steps
+ # (https://github.com/GoogleCloudPlatform/cloud-builders). The Docker daemon
+ # will also have cached many of the layers for some popular images, like
+ # "ubuntu", "debian", but they will be refreshed at the time you attempt to
+ # use them.
+ #
+ # If you built an image in a previous build step, it will be stored in the
+ # host's Docker daemon's cache and is available to use as the name for a
+ # later build step.
+ "args": [ # A list of arguments that will be presented to the step when it is started.
+ #
+ # If the image used to run the step's container has an entrypoint, these args
+ # will be used as arguments to that entrypoint. If the image does not define
+ # an entrypoint, the first element in args will be used as the entrypoint,
+ # and the remainder will be used as arguments.
"A String",
],
- "env": [ # Additional environment variables to set for this step's container.
+ "env": [ # A list of environment variable definitions to be used when running a step.
+ #
+ # The elements are of the form "KEY=VALUE" for the environment variable "KEY"
+ # being given the value "VALUE".
"A String",
],
"id": "A String", # Optional unique identifier for this build step, used in wait_for to
@@ -844,14 +1008,20 @@
},
"projectId": "A String", # ID of the project.
# @OutputOnly.
- "images": [ # List of images expected to be built and pushed to Google Container
- # Registry. If an image is listed here and the image is not produced by
- # one of the build steps, the build will fail. Any images present when
- # the build steps are complete will be pushed to Container Registry.
+ "images": [ # A list of images to be pushed upon the successful completion of all build
+ # steps.
+ #
+ # The images will be pushed using the builder
+ # service account's credentials.
+ #
+ # The digests of the pushed images will be stored in the Build resource's
+ # results field.
+ #
+ # If any of the images fail to be pushed, the build is marked FAILURE.
"A String",
],
"options": { # Optional arguments to enable specific features of builds. # Special options for this build.
- "requestedVerifyOption": "A String", # Options for a verifiable build with details uploaded to the Analysis API.
+ "requestedVerifyOption": "A String", # Requested verifiability options.
"sourceProvenanceHash": [ # Requested hash for SourceProvenance.
"A String",
],
@@ -859,6 +1029,9 @@
"logUrl": "A String", # URL to logs for this build in Google Cloud Logging.
# @OutputOnly
},
+ "id": "A String", # Unique identifier of the trigger.
+ #
+ # @OutputOnly
"triggerTemplate": { # RepoSource describes the location of the source in a Google Cloud Source # Template describing the types of source changes to trigger a build.
#
# Branch and tag names in trigger templates are interpreted as regular
@@ -872,11 +1045,6 @@
"tagName": "A String", # Name of the tag to build.
"commitSha": "A String", # Explicit commit SHA to build.
},
- "createTime": "A String", # Time when the trigger was created.
- #
- # @OutputOnly
- "filename": "A String", # Path, from the source root, to a file whose contents is used for the
- # template.
},
],
}</pre>
@@ -896,14 +1064,29 @@
{ # Configuration for an automated build in response to source repository
# changes.
- "id": "A String", # Unique identifier of the trigger.
+ "description": "A String", # Human-readable description of this trigger.
+ "createTime": "A String", # Time when the trigger was created.
#
# @OutputOnly
+ "filename": "A String", # Path, from the source root, to a file whose contents is used for the
+ # template.
+ "disabled": True or False, # If true, the trigger will never result in a build.
"build": { # A build resource in the Container Builder API. # Contents of the build template.
#
# At a high level, a Build describes where to find source code, how to build
# it (for example, the builder image to run on the source), and what tag to
# apply to the built image when it is pushed to Google Container Registry.
+ #
+ # Fields can include the following variables which will be expanded when the
+ # build is created:
+ #
+ # - $PROJECT_ID: the project ID of the build.
+ # - $BUILD_ID: the autogenerated ID of the build.
+ # - $REPO_NAME: the source repository name specified by RepoSource.
+ # - $BRANCH_NAME: the branch name specified by RepoSource.
+ # - $TAG_NAME: the tag name specified by RepoSource.
+ # - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or
+ # resolved from the specified branch or tag.
"status": "A String", # Status of the build.
# @OutputOnly
"finishTime": "A String", # Time at which execution of the build was finished.
@@ -972,12 +1155,35 @@
# successfully.
"A String",
],
- "name": "A String", # Name of the container image to use for creating this stage in the
- # pipeline, as presented to `docker pull`.
- "args": [ # Command-line arguments to use when running this step's container.
+ "name": "A String", # The name of the container image that will run this particular build step.
+ #
+ # If the image is already available in the host's
+ # Docker daemon's cache, it will be run directly. If not, the host will
+ # attempt to pull the image first, using the builder service account's
+ # credentials if necessary.
+ #
+ # The Docker daemon's cache will already have the latest versions of all of
+ # the officially supported build steps
+ # (https://github.com/GoogleCloudPlatform/cloud-builders). The Docker daemon
+ # will also have cached many of the layers for some popular images, like
+ # "ubuntu", "debian", but they will be refreshed at the time you attempt to
+ # use them.
+ #
+ # If you built an image in a previous build step, it will be stored in the
+ # host's Docker daemon's cache and is available to use as the name for a
+ # later build step.
+ "args": [ # A list of arguments that will be presented to the step when it is started.
+ #
+ # If the image used to run the step's container has an entrypoint, these args
+ # will be used as arguments to that entrypoint. If the image does not define
+ # an entrypoint, the first element in args will be used as the entrypoint,
+ # and the remainder will be used as arguments.
"A String",
],
- "env": [ # Additional environment variables to set for this step's container.
+ "env": [ # A list of environment variable definitions to be used when running a step.
+ #
+ # The elements are of the form "KEY=VALUE" for the environment variable "KEY"
+ # being given the value "VALUE".
"A String",
],
"id": "A String", # Optional unique identifier for this build step, used in wait_for to
@@ -1035,14 +1241,20 @@
},
"projectId": "A String", # ID of the project.
# @OutputOnly.
- "images": [ # List of images expected to be built and pushed to Google Container
- # Registry. If an image is listed here and the image is not produced by
- # one of the build steps, the build will fail. Any images present when
- # the build steps are complete will be pushed to Container Registry.
+ "images": [ # A list of images to be pushed upon the successful completion of all build
+ # steps.
+ #
+ # The images will be pushed using the builder
+ # service account's credentials.
+ #
+ # The digests of the pushed images will be stored in the Build resource's
+ # results field.
+ #
+ # If any of the images fail to be pushed, the build is marked FAILURE.
"A String",
],
"options": { # Optional arguments to enable specific features of builds. # Special options for this build.
- "requestedVerifyOption": "A String", # Options for a verifiable build with details uploaded to the Analysis API.
+ "requestedVerifyOption": "A String", # Requested verifiability options.
"sourceProvenanceHash": [ # Requested hash for SourceProvenance.
"A String",
],
@@ -1050,6 +1262,9 @@
"logUrl": "A String", # URL to logs for this build in Google Cloud Logging.
# @OutputOnly
},
+ "id": "A String", # Unique identifier of the trigger.
+ #
+ # @OutputOnly
"triggerTemplate": { # RepoSource describes the location of the source in a Google Cloud Source # Template describing the types of source changes to trigger a build.
#
# Branch and tag names in trigger templates are interpreted as regular
@@ -1063,11 +1278,6 @@
"tagName": "A String", # Name of the tag to build.
"commitSha": "A String", # Explicit commit SHA to build.
},
- "createTime": "A String", # Time when the trigger was created.
- #
- # @OutputOnly
- "filename": "A String", # Path, from the source root, to a file whose contents is used for the
- # template.
}
x__xgafv: string, V1 error format.
@@ -1080,14 +1290,29 @@
{ # Configuration for an automated build in response to source repository
# changes.
- "id": "A String", # Unique identifier of the trigger.
+ "description": "A String", # Human-readable description of this trigger.
+ "createTime": "A String", # Time when the trigger was created.
#
# @OutputOnly
+ "filename": "A String", # Path, from the source root, to a file whose contents is used for the
+ # template.
+ "disabled": True or False, # If true, the trigger will never result in a build.
"build": { # A build resource in the Container Builder API. # Contents of the build template.
#
# At a high level, a Build describes where to find source code, how to build
# it (for example, the builder image to run on the source), and what tag to
# apply to the built image when it is pushed to Google Container Registry.
+ #
+ # Fields can include the following variables which will be expanded when the
+ # build is created:
+ #
+ # - $PROJECT_ID: the project ID of the build.
+ # - $BUILD_ID: the autogenerated ID of the build.
+ # - $REPO_NAME: the source repository name specified by RepoSource.
+ # - $BRANCH_NAME: the branch name specified by RepoSource.
+ # - $TAG_NAME: the tag name specified by RepoSource.
+ # - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or
+ # resolved from the specified branch or tag.
"status": "A String", # Status of the build.
# @OutputOnly
"finishTime": "A String", # Time at which execution of the build was finished.
@@ -1156,12 +1381,35 @@
# successfully.
"A String",
],
- "name": "A String", # Name of the container image to use for creating this stage in the
- # pipeline, as presented to `docker pull`.
- "args": [ # Command-line arguments to use when running this step's container.
+ "name": "A String", # The name of the container image that will run this particular build step.
+ #
+ # If the image is already available in the host's
+ # Docker daemon's cache, it will be run directly. If not, the host will
+ # attempt to pull the image first, using the builder service account's
+ # credentials if necessary.
+ #
+ # The Docker daemon's cache will already have the latest versions of all of
+ # the officially supported build steps
+ # (https://github.com/GoogleCloudPlatform/cloud-builders). The Docker daemon
+ # will also have cached many of the layers for some popular images, like
+ # "ubuntu", "debian", but they will be refreshed at the time you attempt to
+ # use them.
+ #
+ # If you built an image in a previous build step, it will be stored in the
+ # host's Docker daemon's cache and is available to use as the name for a
+ # later build step.
+ "args": [ # A list of arguments that will be presented to the step when it is started.
+ #
+ # If the image used to run the step's container has an entrypoint, these args
+ # will be used as arguments to that entrypoint. If the image does not define
+ # an entrypoint, the first element in args will be used as the entrypoint,
+ # and the remainder will be used as arguments.
"A String",
],
- "env": [ # Additional environment variables to set for this step's container.
+ "env": [ # A list of environment variable definitions to be used when running a step.
+ #
+ # The elements are of the form "KEY=VALUE" for the environment variable "KEY"
+ # being given the value "VALUE".
"A String",
],
"id": "A String", # Optional unique identifier for this build step, used in wait_for to
@@ -1219,14 +1467,20 @@
},
"projectId": "A String", # ID of the project.
# @OutputOnly.
- "images": [ # List of images expected to be built and pushed to Google Container
- # Registry. If an image is listed here and the image is not produced by
- # one of the build steps, the build will fail. Any images present when
- # the build steps are complete will be pushed to Container Registry.
+ "images": [ # A list of images to be pushed upon the successful completion of all build
+ # steps.
+ #
+ # The images will be pushed using the builder
+ # service account's credentials.
+ #
+ # The digests of the pushed images will be stored in the Build resource's
+ # results field.
+ #
+ # If any of the images fail to be pushed, the build is marked FAILURE.
"A String",
],
"options": { # Optional arguments to enable specific features of builds. # Special options for this build.
- "requestedVerifyOption": "A String", # Options for a verifiable build with details uploaded to the Analysis API.
+ "requestedVerifyOption": "A String", # Requested verifiability options.
"sourceProvenanceHash": [ # Requested hash for SourceProvenance.
"A String",
],
@@ -1234,6 +1488,9 @@
"logUrl": "A String", # URL to logs for this build in Google Cloud Logging.
# @OutputOnly
},
+ "id": "A String", # Unique identifier of the trigger.
+ #
+ # @OutputOnly
"triggerTemplate": { # RepoSource describes the location of the source in a Google Cloud Source # Template describing the types of source changes to trigger a build.
#
# Branch and tag names in trigger templates are interpreted as regular
@@ -1247,11 +1504,6 @@
"tagName": "A String", # Name of the tag to build.
"commitSha": "A String", # Explicit commit SHA to build.
},
- "createTime": "A String", # Time when the trigger was created.
- #
- # @OutputOnly
- "filename": "A String", # Path, from the source root, to a file whose contents is used for the
- # template.
}</pre>
</div>
diff --git a/docs/dyn/clouderrorreporting_v1beta1.projects.groupStats.html b/docs/dyn/clouderrorreporting_v1beta1.projects.groupStats.html
index 7284390..53bd6b3 100644
--- a/docs/dyn/clouderrorreporting_v1beta1.projects.groupStats.html
+++ b/docs/dyn/clouderrorreporting_v1beta1.projects.groupStats.html
@@ -112,9 +112,7 @@
[`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version).
serviceFilter_service: string, [Optional] The exact value to match against
[`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service).
- groupId: string, [Optional] List all <code>ErrorGroupStats</code> with these IDs.
-If not specified, all error group stats with a non-zero error count
-for the given selection criteria are returned. (repeated)
+ groupId: string, [Optional] List all <code>ErrorGroupStats</code> with these IDs. (repeated)
order: string, [Optional] The sort order in which the results are returned.
Default is `COUNT_DESC`.
@@ -126,14 +124,15 @@
# Pass this token, along with the same query parameters as the first
# request, to view the next page of results.
"errorGroupStats": [ # The error group stats which match the given request.
- { # Data extracted for a specific group based on certain selection criteria,
+ { # Data extracted for a specific group based on certain filter criteria,
# such as a given time period and/or service filter.
"count": "A String", # Approximate total number of events in the given group that match
- # the selection criteria.
- "firstSeenTime": "A String", # Approximate first occurrence that was seen for this group and
- # which matches the given selection criteria.
+ # the filter criteria.
+ "firstSeenTime": "A String", # Approximate first occurrence that was ever seen for this group
+ # and which matches the given filter criteria, ignoring the
+ # time_range that was specified in the request.
"affectedUsersCount": "A String", # Approximate number of affected users in the given group that
- # match the selection criteria.
+ # match the filter criteria.
# Users are distinguished by data in the `ErrorContext` of the
# individual error events, such as their login name or their remote
# IP address in case of HTTP requests.
@@ -144,7 +143,7 @@
# context that was provided in the error report. If more users are
# implicitly affected, such as due to a crash of the whole service,
# this is not reflected here.
- "group": { # Description of a group of similar error events. # Group data that is independent of the selection criteria.
+ "group": { # Description of a group of similar error events. # Group data that is independent of the filter criteria.
"trackingIssues": [ # Associated tracking issues.
{ # Information related to tracking the progress on resolving the error.
"url": "A String", # A URL pointing to a related entry in an issue tracking system.
@@ -170,8 +169,9 @@
"startTime": "A String", # Start of the time period to which `count` refers (included).
},
],
- "lastSeenTime": "A String", # Approximate last occurrence that was seen for this group
- # and which matches the given selection criteria.
+ "lastSeenTime": "A String", # Approximate last occurrence that was ever seen for this group and
+ # which matches the given filter criteria, ignoring the time_range
+ # that was specified in the request.
"representative": { # An error event which is returned by the Error Reporting system. # An arbitrary event that is chosen as representative for the whole group.
# The representative event is intended to be used as a quick preview for
# the whole group. Events in the group are usually sufficiently similar
@@ -240,8 +240,8 @@
},
},
"numAffectedServices": 42, # The total number of services with a non-zero error count for the given
- # selection criteria.
- "affectedServices": [ # Service contexts with a non-zero error count for the given selection
+ # filter criteria.
+ "affectedServices": [ # Service contexts with a non-zero error count for the given filter
# criteria. This list can be truncated if multiple services are affected.
# Refer to `num_affected_services` for the total count.
{ # Describes a running service that sends errors.
diff --git a/docs/dyn/cloudresourcemanager_v1.html b/docs/dyn/cloudresourcemanager_v1.html
index 62b9758..efcac49 100644
--- a/docs/dyn/cloudresourcemanager_v1.html
+++ b/docs/dyn/cloudresourcemanager_v1.html
@@ -80,6 +80,11 @@
<p class="firstline">Returns the operations Resource.</p>
<p class="toc_element">
+ <code><a href="cloudresourcemanager_v1.organizations.html">organizations()</a></code>
+</p>
+<p class="firstline">Returns the organizations Resource.</p>
+
+<p class="toc_element">
<code><a href="cloudresourcemanager_v1.projects.html">projects()</a></code>
</p>
<p class="firstline">Returns the projects Resource.</p>
diff --git a/docs/dyn/cloudresourcemanager_v1.operations.html b/docs/dyn/cloudresourcemanager_v1.operations.html
index d2dc68f..996cd92 100644
--- a/docs/dyn/cloudresourcemanager_v1.operations.html
+++ b/docs/dyn/cloudresourcemanager_v1.operations.html
@@ -91,21 +91,21 @@
{ # This resource represents a long-running operation that is the result of a network API call.
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
{
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
},
"done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
diff --git a/docs/dyn/cloudresourcemanager_v1.organizations.html b/docs/dyn/cloudresourcemanager_v1.organizations.html
new file mode 100644
index 0000000..933fc5b
--- /dev/null
+++ b/docs/dyn/cloudresourcemanager_v1.organizations.html
@@ -0,0 +1,251 @@
+<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="cloudresourcemanager_v1.html">Google Cloud Resource Manager API</a> . <a href="cloudresourcemanager_v1.organizations.html">organizations</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
+<p class="firstline">Fetches an Organization resource identified by the specified resource name.</p>
+<p class="toc_element">
+ <code><a href="#getIamPolicy">getIamPolicy(resource, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Gets the access control policy for an Organization resource. May be empty if no such policy or resource exists. The `resource` field should be the organization's resource name, e.g. "organizations/123".</p>
+<p class="toc_element">
+ <code><a href="#search">search(body, x__xgafv=None)</a></code></p>
+<p class="firstline">Searches Organization resources that are visible to the user and satisfy the specified filter. This method returns Organizations in an unspecified order. New Organizations do not necessarily appear at the end of the results.</p>
+<p class="toc_element">
+ <code><a href="#setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Sets the access control policy on an Organization resource. Replaces any existing policy. The `resource` field should be the organization's resource name, e.g. "organizations/123".</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified Organization. The `resource` field should be the organization's resource name, e.g. "organizations/123".</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="get">get(name, x__xgafv=None)</code>
+ <pre>Fetches an Organization resource identified by the specified resource name.
+
+Args:
+ name: string, The resource name of the Organization to fetch, e.g. "organizations/1234". (required)
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # The root node in the resource hierarchy to which a particular entity's (e.g., company) resources belong.
+ "owner": { # The entity that owns an Organization. The lifetime of the Organization and all of its descendants are bound to the `OrganizationOwner`. If the `OrganizationOwner` is deleted, the Organization and all its descendants will be deleted. # The owner of this Organization. The owner should be specified on creation. Once set, it cannot be changed. This field is required.
+ "directoryCustomerId": "A String", # The Google for Work customer id used in the Directory API.
+ },
+ "creationTime": "A String", # Timestamp when the Organization was created. Assigned by the server. @OutputOnly
+ "displayName": "A String", # A friendly string to be used to refer to the Organization in the UI. Assigned by the server, set to the firm name of the Google For Work customer that owns this organization. @OutputOnly
+ "name": "A String", # Output Only. The resource name of the organization. This is the organization's relative path in the API. Its format is "organizations/[organization_id]". For example, "organizations/1234".
+ "lifecycleState": "A String", # The organization's current lifecycle state. Assigned by the server. @OutputOnly
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="getIamPolicy">getIamPolicy(resource, body, x__xgafv=None)</code>
+ <pre>Gets the access control policy for an Organization resource. May be empty if no such policy or resource exists. The `resource` field should be the organization's resource name, e.g. "organizations/123".
+
+Args:
+ resource: string, REQUIRED: The resource for which the policy is being requested. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Request message for `GetIamPolicy` method.
+ }
+
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
+ "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
+ { # Associates `members` with a `role`.
+ "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
+ "A String",
+ ],
+ },
+ ],
+ "version": 42, # Version of the `Policy`. The default version is 0.
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="search">search(body, x__xgafv=None)</code>
+ <pre>Searches Organization resources that are visible to the user and satisfy the specified filter. This method returns Organizations in an unspecified order. New Organizations do not necessarily appear at the end of the results.
+
+Args:
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The request sent to the `SearchOrganizations` method.
+ "filter": "A String", # An optional query string used to filter the Organizations to return in the response. Filter rules are case-insensitive. Organizations may be filtered by `owner.directoryCustomerId` or by `domain`, where the domain is a Google for Work domain, for example: |Filter|Description| |------|-----------| |owner.directorycustomerid:123456789|Organizations with `owner.directory_customer_id` equal to `123456789`.| |domain:google.com|Organizations corresponding to the domain `google.com`.| This field is optional.
+ "pageToken": "A String", # A pagination token returned from a previous call to `SearchOrganizations` that indicates from where listing should continue. This field is optional.
+ "pageSize": 42, # The maximum number of Organizations to return in the response. This field is optional.
+ }
+
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # The response returned from the `SearchOrganizations` method.
+ "nextPageToken": "A String", # A pagination token to be used to retrieve the next page of results. If the result is too large to fit within the page size specified in the request, this field will be set with a token that can be used to fetch the next page of results. If this field is empty, it indicates that this response contains the last page of results.
+ "organizations": [ # The list of Organizations that matched the search query, possibly paginated.
+ { # The root node in the resource hierarchy to which a particular entity's (e.g., company) resources belong.
+ "owner": { # The entity that owns an Organization. The lifetime of the Organization and all of its descendants are bound to the `OrganizationOwner`. If the `OrganizationOwner` is deleted, the Organization and all its descendants will be deleted. # The owner of this Organization. The owner should be specified on creation. Once set, it cannot be changed. This field is required.
+ "directoryCustomerId": "A String", # The Google for Work customer id used in the Directory API.
+ },
+ "creationTime": "A String", # Timestamp when the Organization was created. Assigned by the server. @OutputOnly
+ "displayName": "A String", # A friendly string to be used to refer to the Organization in the UI. Assigned by the server, set to the firm name of the Google For Work customer that owns this organization. @OutputOnly
+ "name": "A String", # Output Only. The resource name of the organization. This is the organization's relative path in the API. Its format is "organizations/[organization_id]". For example, "organizations/1234".
+ "lifecycleState": "A String", # The organization's current lifecycle state. Assigned by the server. @OutputOnly
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</code>
+ <pre>Sets the access control policy on an Organization resource. Replaces any existing policy. The `resource` field should be the organization's resource name, e.g. "organizations/123".
+
+Args:
+ resource: string, REQUIRED: The resource for which the policy is being specified. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Request message for `SetIamPolicy` method.
+ "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
+ "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
+ { # Associates `members` with a `role`.
+ "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
+ "A String",
+ ],
+ },
+ ],
+ "version": 42, # Version of the `Policy`. The default version is 0.
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
+ },
+ }
+
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
+ "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
+ { # Associates `members` with a `role`.
+ "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
+ "A String",
+ ],
+ },
+ ],
+ "version": 42, # Version of the `Policy`. The default version is 0.
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</code>
+ <pre>Returns permissions that a caller has on the specified Organization. The `resource` field should be the organization's resource name, e.g. "organizations/123".
+
+Args:
+ resource: string, REQUIRED: The resource for which the policy detail is being requested. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Request message for `TestIamPermissions` method.
+ "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
+ "A String",
+ ],
+ }
+
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # Response message for `TestIamPermissions` method.
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/cloudresourcemanager_v1.projects.html b/docs/dyn/cloudresourcemanager_v1.projects.html
index 1dd10e3..faa247a 100644
--- a/docs/dyn/cloudresourcemanager_v1.projects.html
+++ b/docs/dyn/cloudresourcemanager_v1.projects.html
@@ -75,6 +75,9 @@
<h1><a href="cloudresourcemanager_v1.html">Google Cloud Resource Manager API</a> . <a href="cloudresourcemanager_v1.projects.html">projects</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
+ <code><a href="#create">create(body, x__xgafv=None)</a></code></p>
+<p class="firstline">Request that a new Project be created. The result is an Operation which can be used to track the creation process. It is automatically deleted after a few hours, so there is no need to call DeleteOperation. Our SLO permits Project creation to take up to 30 seconds at the 90th percentile. As of 2016-08-29, we are observing 6 seconds 50th percentile latency. 95th percentile latency is around 11 seconds. We recommend polling at the 5th second with an exponential backoff.</p>
+<p class="toc_element">
<code><a href="#delete">delete(projectId, x__xgafv=None)</a></code></p>
<p class="firstline">Marks the Project identified by the specified `project_id` (for example, `my-project-123`) for deletion. This method will only affect the Project if the following criteria are met: + The Project does not have a billing account associated with it. + The Project has a lifecycle state of ACTIVE. This method changes the Project's lifecycle state from ACTIVE to DELETE_REQUESTED. The deletion starts at an unspecified time, at which point the Project is no longer accessible. Until the deletion completes, you can check the lifecycle state checked by retrieving the Project with GetProject, and the Project remains visible to ListProjects. However, you cannot update the project. After the deletion completes, the Project is not retrievable by the GetProject and ListProjects methods. The caller must have modify permissions for this Project.</p>
<p class="toc_element">
@@ -91,7 +94,7 @@
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</a></code></p>
-<p class="firstline">Sets the IAM access control policy for the specified Project. Replaces any existing policy. The following constraints apply when using `setIamPolicy()`: + Project does not support `allUsers` and `allAuthenticatedUsers` as `members` in a `Binding` of a `Policy`. + The owner role can be granted only to `user` and `serviceAccount`. + Service accounts can be made owners of a project directly without any restrictions. However, to be added as an owner, a user must be invited via Cloud Platform console and must accept the invitation. + A user cannot be granted the owner role using `setIamPolicy()`. The user must be granted the owner role using the Cloud Platform Console and must explicitly accept the invitation. + Invitations to grant the owner role cannot be sent using `setIamPolicy()`; they must be sent only using the Cloud Platform Console. + Membership changes that leave the project without any owners that have accepted the Terms of Service (ToS) will be rejected. + Members cannot be added to more than one role in the same policy. + There must be at least one owner who has accepted the Terms of Service (ToS) agreement in the policy. Calling `setIamPolicy()` to to remove the last ToS-accepted owner from the policy will fail. This restriction also applies to legacy projects that no longer have owners who have accepted the ToS. Edits to IAM policies will be rejected until the lack of a ToS-accepting owner is rectified. + Calling this method requires enabling the App Engine Admin API. Note: Removing service accounts from policies or changing their roles can render services completely inoperable. It is important to understand how the service account is being used before removing or updating its roles.</p>
+<p class="firstline">Sets the IAM access control policy for the specified Project. Replaces any existing policy. The following constraints apply when using `setIamPolicy()`: + Project does not support `allUsers` and `allAuthenticatedUsers` as `members` in a `Binding` of a `Policy`. + The owner role can be granted only to `user` and `serviceAccount`. + Service accounts can be made owners of a project directly without any restrictions. However, to be added as an owner, a user must be invited via Cloud Platform console and must accept the invitation. + A user cannot be granted the owner role using `setIamPolicy()`. The user must be granted the owner role using the Cloud Platform Console and must explicitly accept the invitation. + Invitations to grant the owner role cannot be sent using `setIamPolicy()`; they must be sent only using the Cloud Platform Console. + Membership changes that leave the project without any owners that have accepted the Terms of Service (ToS) will be rejected. + There must be at least one owner who has accepted the Terms of Service (ToS) agreement in the policy. Calling `setIamPolicy()` to to remove the last ToS-accepted owner from the policy will fail. This restriction also applies to legacy projects that no longer have owners who have accepted the ToS. Edits to IAM policies will be rejected until the lack of a ToS-accepting owner is rectified. + Calling this method requires enabling the App Engine Admin API. Note: Removing service accounts from policies or changing their roles can render services completely inoperable. It is important to understand how the service account is being used before removing or updating its roles.</p>
<p class="toc_element">
<code><a href="#testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</a></code></p>
<p class="firstline">Returns permissions that a caller has on the specified Project.</p>
@@ -103,6 +106,55 @@
<p class="firstline">Updates the attributes of the Project identified by the specified `project_id` (for example, `my-project-123`). The caller must have modify permissions for this Project.</p>
<h3>Method Details</h3>
<div class="method">
+ <code class="details" id="create">create(body, x__xgafv=None)</code>
+ <pre>Request that a new Project be created. The result is an Operation which can be used to track the creation process. It is automatically deleted after a few hours, so there is no need to call DeleteOperation. Our SLO permits Project creation to take up to 30 seconds at the 90th percentile. As of 2016-08-29, we are observing 6 seconds 50th percentile latency. 95th percentile latency is around 11 seconds. We recommend polling at the 5th second with an exponential backoff.
+
+Args:
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, AppEngine Apps, VMs, and other Google Cloud Platform resources.
+ "name": "A String", # The user-assigned display name of the Project. It must be 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: My Project Read-write.
+ "parent": { # A container to reference an id for any resource type. A `resource` in Google Cloud Platform is a generic term for something you (a developer) may want to interact with through one of our API's. Some examples are an AppEngine app, a Compute Engine instance, a Cloud SQL database, and so on. # An optional reference to a parent Resource. The only supported parent type is "organization". Once set, the parent cannot be modified. Read-write.
+ "type": "A String", # Required field representing the resource type this id is for. At present, the only valid type is "organization".
+ "id": "A String", # Required field for the type-specific id. This should correspond to the id used in the type-specific API's.
+ },
+ "projectId": "A String", # The unique, user-assigned ID of the Project. It must be 6 to 30 lowercase letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: tokyo-rain-123 Read-only after creation.
+ "labels": { # The labels associated with this Project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. Label values must be between 0 and 63 characters long and must conform to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. No more than 256 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: "environment" : "dev" Read-write.
+ "a_key": "A String",
+ },
+ "projectNumber": "A String", # The number uniquely identifying the project. Example: 415104041262 Read-only.
+ "lifecycleState": "A String", # The Project lifecycle state. Read-only.
+ "createTime": "A String", # Creation time. Read-only.
+}
+
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ }</pre>
+</div>
+
+<div class="method">
<code class="details" id="delete">delete(projectId, x__xgafv=None)</code>
<pre>Marks the Project identified by the specified `project_id` (for example, `my-project-123`) for deletion. This method will only affect the Project if the following criteria are met: + The Project does not have a billing account associated with it. + The Project has a lifecycle state of ACTIVE. This method changes the Project's lifecycle state from ACTIVE to DELETE_REQUESTED. The deletion starts at an unspecified time, at which point the Project is no longer accessible. Until the deletion completes, you can check the lifecycle state checked by retrieving the Project with GetProject, and the Project remains visible to ListProjects. However, you cannot update the project. After the deletion completes, the Project is not retrievable by the GetProject and ListProjects methods. The caller must have modify permissions for this Project.
@@ -149,7 +201,7 @@
<pre>Returns the IAM access control policy for the specified Project. Permission is denied if the policy or the resource does not exist.
Args:
- resource: string, REQUIRED: The resource for which the policy is being requested. `resource` is usually specified as a path, such as `projects/*project*/zones/*zone*/disks/*disk*`. The format for the path specified in this value is resource specific and is specified in the `getIamPolicy` documentation. (required)
+ resource: string, REQUIRED: The resource for which the policy is being requested. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
body: object, The request body. (required)
The object takes the form of:
@@ -225,10 +277,10 @@
<div class="method">
<code class="details" id="setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</code>
- <pre>Sets the IAM access control policy for the specified Project. Replaces any existing policy. The following constraints apply when using `setIamPolicy()`: + Project does not support `allUsers` and `allAuthenticatedUsers` as `members` in a `Binding` of a `Policy`. + The owner role can be granted only to `user` and `serviceAccount`. + Service accounts can be made owners of a project directly without any restrictions. However, to be added as an owner, a user must be invited via Cloud Platform console and must accept the invitation. + A user cannot be granted the owner role using `setIamPolicy()`. The user must be granted the owner role using the Cloud Platform Console and must explicitly accept the invitation. + Invitations to grant the owner role cannot be sent using `setIamPolicy()`; they must be sent only using the Cloud Platform Console. + Membership changes that leave the project without any owners that have accepted the Terms of Service (ToS) will be rejected. + Members cannot be added to more than one role in the same policy. + There must be at least one owner who has accepted the Terms of Service (ToS) agreement in the policy. Calling `setIamPolicy()` to to remove the last ToS-accepted owner from the policy will fail. This restriction also applies to legacy projects that no longer have owners who have accepted the ToS. Edits to IAM policies will be rejected until the lack of a ToS-accepting owner is rectified. + Calling this method requires enabling the App Engine Admin API. Note: Removing service accounts from policies or changing their roles can render services completely inoperable. It is important to understand how the service account is being used before removing or updating its roles.
+ <pre>Sets the IAM access control policy for the specified Project. Replaces any existing policy. The following constraints apply when using `setIamPolicy()`: + Project does not support `allUsers` and `allAuthenticatedUsers` as `members` in a `Binding` of a `Policy`. + The owner role can be granted only to `user` and `serviceAccount`. + Service accounts can be made owners of a project directly without any restrictions. However, to be added as an owner, a user must be invited via Cloud Platform console and must accept the invitation. + A user cannot be granted the owner role using `setIamPolicy()`. The user must be granted the owner role using the Cloud Platform Console and must explicitly accept the invitation. + Invitations to grant the owner role cannot be sent using `setIamPolicy()`; they must be sent only using the Cloud Platform Console. + Membership changes that leave the project without any owners that have accepted the Terms of Service (ToS) will be rejected. + There must be at least one owner who has accepted the Terms of Service (ToS) agreement in the policy. Calling `setIamPolicy()` to to remove the last ToS-accepted owner from the policy will fail. This restriction also applies to legacy projects that no longer have owners who have accepted the ToS. Edits to IAM policies will be rejected until the lack of a ToS-accepting owner is rectified. + Calling this method requires enabling the App Engine Admin API. Note: Removing service accounts from policies or changing their roles can render services completely inoperable. It is important to understand how the service account is being used before removing or updating its roles.
Args:
- resource: string, REQUIRED: The resource for which the policy is being specified. `resource` is usually specified as a path, such as `projects/*project*/zones/*zone*/disks/*disk*`. The format for the path specified in this value is resource specific and is specified in the `setIamPolicy` documentation. (required)
+ resource: string, REQUIRED: The resource for which the policy is being specified. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
body: object, The request body. (required)
The object takes the form of:
@@ -271,12 +323,12 @@
<pre>Returns permissions that a caller has on the specified Project.
Args:
- resource: string, REQUIRED: The resource for which the policy detail is being requested. `resource` is usually specified as a path, such as `projects/*project*/zones/*zone*/disks/*disk*`. The format for the path specified in this value is resource specific and is specified in the `testIamPermissions` documentation. (required)
+ resource: string, REQUIRED: The resource for which the policy detail is being requested. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Request message for `TestIamPermissions` method.
- "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see IAM Overview.
+ "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
"A String",
],
}
diff --git a/docs/dyn/compute_v1.addresses.html b/docs/dyn/compute_v1.addresses.html
index b891a10..ec6feb6 100644
--- a/docs/dyn/compute_v1.addresses.html
+++ b/docs/dyn/compute_v1.addresses.html
@@ -75,7 +75,7 @@
<h1><a href="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.addresses.html">addresses</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
+ <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves an aggregated list of addresses.</p>
<p class="toc_element">
<code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
@@ -90,18 +90,23 @@
<code><a href="#insert">insert(project, region, body)</a></code></p>
<p class="firstline">Creates an address resource in the specified project using the data included in the request.</p>
<p class="toc_element">
- <code><a href="#list">list(project, region, maxResults=None, pageToken=None, filter=None)</a></code></p>
+ <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves a list of addresses contained within the specified region.</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>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</code>
+ <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves an aggregated list of addresses.
Args:
project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
@@ -225,7 +230,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -329,17 +334,22 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(project, region, maxResults=None, pageToken=None, filter=None)</code>
+ <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves a list of addresses contained within the specified region.
Args:
project: string, Project ID for this request. (required)
region: string, Name of the region for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
diff --git a/docs/dyn/compute_v1.autoscalers.html b/docs/dyn/compute_v1.autoscalers.html
index 52b2f5f..81f36dd 100644
--- a/docs/dyn/compute_v1.autoscalers.html
+++ b/docs/dyn/compute_v1.autoscalers.html
@@ -75,7 +75,7 @@
<h1><a href="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.autoscalers.html">autoscalers</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
+ <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves an aggregated list of autoscalers.</p>
<p class="toc_element">
<code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
@@ -90,7 +90,7 @@
<code><a href="#insert">insert(project, zone, body)</a></code></p>
<p class="firstline">Creates an autoscaler 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>
+ <code><a href="#list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves a list of autoscalers contained within the specified zone.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -103,11 +103,16 @@
<p class="firstline">Updates an autoscaler in the specified project using the data included in the request.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</code>
+ <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves an aggregated list of autoscalers.
Args:
project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
@@ -143,6 +148,7 @@
"kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
+ "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
"autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
#
# If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
@@ -155,15 +161,13 @@
},
"customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.
{ # Custom utilization metric policy.
- "metric": "A String", # The identifier of the Cloud Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
+ "metric": "A String", # The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
#
# For example, the following is a valid metric:
# compute.googleapis.com/instance/network/received_bytes_count
- #
- #
# The following is not a valid metric because it does not increase or decrease based on usage:
# compute.googleapis.com/instance/cpu/reserved_cores
- "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Cloud Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
+ "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
"utilizationTarget": 3.14, # Target value of the metric which autoscaler should maintain. Must be a positive value.
},
],
@@ -260,7 +264,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -280,6 +284,7 @@
"kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
+ "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
"autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
#
# If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
@@ -292,15 +297,13 @@
},
"customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.
{ # Custom utilization metric policy.
- "metric": "A String", # The identifier of the Cloud Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
+ "metric": "A String", # The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
#
# For example, the following is a valid metric:
# compute.googleapis.com/instance/network/received_bytes_count
- #
- #
# The following is not a valid metric because it does not increase or decrease based on usage:
# compute.googleapis.com/instance/cpu/reserved_cores
- "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Cloud Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
+ "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
"utilizationTarget": 3.14, # Target value of the metric which autoscaler should maintain. Must be a positive value.
},
],
@@ -335,6 +338,7 @@
"kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
+ "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
"autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
#
# If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
@@ -347,15 +351,13 @@
},
"customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.
{ # Custom utilization metric policy.
- "metric": "A String", # The identifier of the Cloud Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
+ "metric": "A String", # The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
#
# For example, the following is a valid metric:
# compute.googleapis.com/instance/network/received_bytes_count
- #
- #
# The following is not a valid metric because it does not increase or decrease based on usage:
# compute.googleapis.com/instance/cpu/reserved_cores
- "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Cloud Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
+ "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
"utilizationTarget": 3.14, # Target value of the metric which autoscaler should maintain. Must be a positive value.
},
],
@@ -422,17 +424,22 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(project, zone, maxResults=None, pageToken=None, filter=None)</code>
+ <code class="details" id="list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves a list of autoscalers contained within the specified zone.
Args:
project: string, Project ID for this request. (required)
zone: string, Name of the zone for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
@@ -455,6 +462,7 @@
"kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
+ "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
"autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
#
# If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
@@ -467,15 +475,13 @@
},
"customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.
{ # Custom utilization metric policy.
- "metric": "A String", # The identifier of the Cloud Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
+ "metric": "A String", # The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
#
# For example, the following is a valid metric:
# compute.googleapis.com/instance/network/received_bytes_count
- #
- #
# The following is not a valid metric because it does not increase or decrease based on usage:
# compute.googleapis.com/instance/cpu/reserved_cores
- "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Cloud Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
+ "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
"utilizationTarget": 3.14, # Target value of the metric which autoscaler should maintain. Must be a positive value.
},
],
@@ -530,6 +536,7 @@
"kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
+ "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
"autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
#
# If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
@@ -542,15 +549,13 @@
},
"customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.
{ # Custom utilization metric policy.
- "metric": "A String", # The identifier of the Cloud Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
+ "metric": "A String", # The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
#
# For example, the following is a valid metric:
# compute.googleapis.com/instance/network/received_bytes_count
- #
- #
# The following is not a valid metric because it does not increase or decrease based on usage:
# compute.googleapis.com/instance/cpu/reserved_cores
- "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Cloud Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
+ "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
"utilizationTarget": 3.14, # Target value of the metric which autoscaler should maintain. Must be a positive value.
},
],
@@ -617,7 +622,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -635,6 +640,7 @@
"kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
+ "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
"autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
#
# If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
@@ -647,15 +653,13 @@
},
"customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.
{ # Custom utilization metric policy.
- "metric": "A String", # The identifier of the Cloud Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
+ "metric": "A String", # The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
#
# For example, the following is a valid metric:
# compute.googleapis.com/instance/network/received_bytes_count
- #
- #
# The following is not a valid metric because it does not increase or decrease based on usage:
# compute.googleapis.com/instance/cpu/reserved_cores
- "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Cloud Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
+ "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
"utilizationTarget": 3.14, # Target value of the metric which autoscaler should maintain. Must be a positive value.
},
],
@@ -723,7 +727,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
diff --git a/docs/dyn/compute_v1.backendServices.html b/docs/dyn/compute_v1.backendServices.html
index 08fe6f6..dc04bc5 100644
--- a/docs/dyn/compute_v1.backendServices.html
+++ b/docs/dyn/compute_v1.backendServices.html
@@ -87,17 +87,17 @@
<code><a href="#insert">insert(project, body)</a></code></p>
<p class="firstline">Creates a BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a backend service. Read Restrictions and Guidelines for more information.</p>
<p class="toc_element">
- <code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
+ <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves the list of BackendService resources available to the specified project.</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>
<p class="toc_element">
<code><a href="#patch">patch(project, backendService, body)</a></code></p>
-<p class="firstline">Updates the entire content of the BackendService resource. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports patch semantics.</p>
+<p class="firstline">Updates the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#update">update(project, backendService, body)</a></code></p>
-<p class="firstline">Updates the entire content of the BackendService resource. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information.</p>
+<p class="firstline">Updates the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="delete">delete(project, backendService)</code>
@@ -153,7 +153,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -169,6 +169,9 @@
An object of the form:
{ # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
+ "connectionDraining": { # Message containing connection draining configuration.
+ "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
+ },
"kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
"protocol": "A String", # The protocol this BackendService uses to communicate with backends.
#
@@ -201,13 +204,19 @@
"maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
#
# This cannot be used for internal load balancing.
- "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (either UTILIZATION or RATE). Default value is 1, which means the group will serve up to 100% of its configured CPU or RPS (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available CPU or RPS. Valid range is [0.0,1.0].
+ "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
#
# This cannot be used for internal load balancing.
"maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
#
# This cannot be used for internal load balancing.
- "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) load balancing, the default is UTILIZATION. Valid values are UTILIZATION and RATE.
+ "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
#
# This cannot be used for internal load balancing.
},
@@ -246,7 +255,7 @@
The object takes the form of:
{
- "group": "A String", # A URI referencing one of the resource views listed in the backend service.
+ "group": "A String", # A URI referencing one of the instance groups listed in the backend service.
}
@@ -276,6 +285,9 @@
The object takes the form of:
{ # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
+ "connectionDraining": { # Message containing connection draining configuration.
+ "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
+ },
"kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
"protocol": "A String", # The protocol this BackendService uses to communicate with backends.
#
@@ -308,13 +320,19 @@
"maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
#
# This cannot be used for internal load balancing.
- "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (either UTILIZATION or RATE). Default value is 1, which means the group will serve up to 100% of its configured CPU or RPS (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available CPU or RPS. Valid range is [0.0,1.0].
+ "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
#
# This cannot be used for internal load balancing.
"maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
#
# This cannot be used for internal load balancing.
- "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) load balancing, the default is UTILIZATION. Valid values are UTILIZATION and RATE.
+ "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
#
# This cannot be used for internal load balancing.
},
@@ -388,16 +406,21 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves the list of BackendService resources available to the specified project.
Args:
project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
@@ -417,6 +440,9 @@
"nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
"items": [ # A list of BackendService resources.
{ # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
+ "connectionDraining": { # Message containing connection draining configuration.
+ "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
+ },
"kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
"protocol": "A String", # The protocol this BackendService uses to communicate with backends.
#
@@ -449,13 +475,19 @@
"maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
#
# This cannot be used for internal load balancing.
- "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (either UTILIZATION or RATE). Default value is 1, which means the group will serve up to 100% of its configured CPU or RPS (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available CPU or RPS. Valid range is [0.0,1.0].
+ "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
#
# This cannot be used for internal load balancing.
"maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
#
# This cannot be used for internal load balancing.
- "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) load balancing, the default is UTILIZATION. Valid values are UTILIZATION and RATE.
+ "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
#
# This cannot be used for internal load balancing.
},
@@ -504,7 +536,7 @@
<div class="method">
<code class="details" id="patch">patch(project, backendService, body)</code>
- <pre>Updates the entire content of the BackendService resource. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports patch semantics.
+ <pre>Updates the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports patch semantics.
Args:
project: string, Project ID for this request. (required)
@@ -513,6 +545,9 @@
The object takes the form of:
{ # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
+ "connectionDraining": { # Message containing connection draining configuration.
+ "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
+ },
"kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
"protocol": "A String", # The protocol this BackendService uses to communicate with backends.
#
@@ -545,13 +580,19 @@
"maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
#
# This cannot be used for internal load balancing.
- "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (either UTILIZATION or RATE). Default value is 1, which means the group will serve up to 100% of its configured CPU or RPS (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available CPU or RPS. Valid range is [0.0,1.0].
+ "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
#
# This cannot be used for internal load balancing.
"maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
#
# This cannot be used for internal load balancing.
- "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) load balancing, the default is UTILIZATION. Valid values are UTILIZATION and RATE.
+ "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
#
# This cannot be used for internal load balancing.
},
@@ -625,13 +666,13 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(project, backendService, body)</code>
- <pre>Updates the entire content of the BackendService resource. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information.
+ <pre>Updates the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information.
Args:
project: string, Project ID for this request. (required)
@@ -640,6 +681,9 @@
The object takes the form of:
{ # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
+ "connectionDraining": { # Message containing connection draining configuration.
+ "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
+ },
"kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
"protocol": "A String", # The protocol this BackendService uses to communicate with backends.
#
@@ -672,13 +716,19 @@
"maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
#
# This cannot be used for internal load balancing.
- "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (either UTILIZATION or RATE). Default value is 1, which means the group will serve up to 100% of its configured CPU or RPS (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available CPU or RPS. Valid range is [0.0,1.0].
+ "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
#
# This cannot be used for internal load balancing.
"maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
#
# This cannot be used for internal load balancing.
- "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) load balancing, the default is UTILIZATION. Valid values are UTILIZATION and RATE.
+ "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
#
# This cannot be used for internal load balancing.
},
@@ -752,7 +802,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
diff --git a/docs/dyn/compute_v1.diskTypes.html b/docs/dyn/compute_v1.diskTypes.html
index f62dc80..0cdac34 100644
--- a/docs/dyn/compute_v1.diskTypes.html
+++ b/docs/dyn/compute_v1.diskTypes.html
@@ -75,7 +75,7 @@
<h1><a href="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.diskTypes.html">diskTypes</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
+ <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves an aggregated list of disk types.</p>
<p class="toc_element">
<code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
@@ -84,18 +84,23 @@
<code><a href="#get">get(project, zone, diskType)</a></code></p>
<p class="firstline">Returns the specified disk type. Get a list of available disk types by making a list() request.</p>
<p class="toc_element">
- <code><a href="#list">list(project, zone, maxResults=None, pageToken=None, filter=None)</a></code></p>
+ <code><a href="#list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves a list of disk types available to the specified project.</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>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</code>
+ <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves an aggregated list of disk types.
Args:
project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
@@ -201,12 +206,17 @@
</div>
<div class="method">
- <code class="details" id="list">list(project, zone, maxResults=None, pageToken=None, filter=None)</code>
+ <code class="details" id="list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves a list of disk types available to the specified project.
Args:
project: string, Project ID for this request. (required)
zone: string, The name of the zone for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
diff --git a/docs/dyn/compute_v1.disks.html b/docs/dyn/compute_v1.disks.html
index af9565f..c6f42ee 100644
--- a/docs/dyn/compute_v1.disks.html
+++ b/docs/dyn/compute_v1.disks.html
@@ -75,7 +75,7 @@
<h1><a href="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.disks.html">disks</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
+ <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves an aggregated list of persistent disks.</p>
<p class="toc_element">
<code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
@@ -93,7 +93,7 @@
<code><a href="#insert">insert(project, zone, body, sourceImage=None)</a></code></p>
<p class="firstline">Creates a persistent disk in the specified project using the data in the request. You can create a disk with a sourceImage, a sourceSnapshot, or create an empty 500 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property.</p>
<p class="toc_element">
- <code><a href="#list">list(project, zone, maxResults=None, pageToken=None, filter=None)</a></code></p>
+ <code><a href="#list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves a 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>
@@ -103,11 +103,16 @@
<p class="firstline">Resizes the specified persistent disk.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</code>
+ <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves an aggregated list of persistent disks.
Args:
project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
@@ -316,7 +321,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -375,7 +380,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -580,17 +585,22 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(project, zone, maxResults=None, pageToken=None, filter=None)</code>
+ <code class="details" id="list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves a list of persistent disks contained within the specified zone.
Args:
project: string, Project ID for this request. (required)
zone: string, The name of the zone for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
@@ -756,7 +766,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
diff --git a/docs/dyn/compute_v1.firewalls.html b/docs/dyn/compute_v1.firewalls.html
index faf30fa..ae9b0d1 100644
--- a/docs/dyn/compute_v1.firewalls.html
+++ b/docs/dyn/compute_v1.firewalls.html
@@ -84,7 +84,7 @@
<code><a href="#insert">insert(project, body)</a></code></p>
<p class="firstline">Creates a firewall rule in the specified project using the data included in the request.</p>
<p class="toc_element">
- <code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
+ <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves the list of firewall rules available to the specified project.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -150,7 +150,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -290,16 +290,21 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves the list of firewall rules available to the specified project.
Args:
project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
@@ -463,7 +468,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -558,7 +563,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
diff --git a/docs/dyn/compute_v1.forwardingRules.html b/docs/dyn/compute_v1.forwardingRules.html
index 7daf5e1..0302baf 100644
--- a/docs/dyn/compute_v1.forwardingRules.html
+++ b/docs/dyn/compute_v1.forwardingRules.html
@@ -75,7 +75,7 @@
<h1><a href="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.forwardingRules.html">forwardingRules</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
+ <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves an aggregated list of forwarding rules.</p>
<p class="toc_element">
<code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
@@ -90,7 +90,7 @@
<code><a href="#insert">insert(project, region, body)</a></code></p>
<p class="firstline">Creates a ForwardingRule resource in the specified project and region using the data included in the request.</p>
<p class="toc_element">
- <code><a href="#list">list(project, region, maxResults=None, pageToken=None, filter=None)</a></code></p>
+ <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves a list of ForwardingRule resources available to the specified project and region.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -100,11 +100,16 @@
<p class="firstline">Changes target URL for forwarding rule. The new target should be of the same type as the old target.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</code>
+ <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves an aggregated list of forwarding rules.
Args:
project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
@@ -237,7 +242,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -359,17 +364,22 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(project, region, maxResults=None, pageToken=None, filter=None)</code>
+ <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves a list of ForwardingRule resources available to the specified project and region.
Args:
project: string, Project ID for this request. (required)
region: string, Name of the region scoping this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
@@ -494,7 +504,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
diff --git a/docs/dyn/compute_v1.globalAddresses.html b/docs/dyn/compute_v1.globalAddresses.html
index 099c4f6..77b4128 100644
--- a/docs/dyn/compute_v1.globalAddresses.html
+++ b/docs/dyn/compute_v1.globalAddresses.html
@@ -84,7 +84,7 @@
<code><a href="#insert">insert(project, body)</a></code></p>
<p class="firstline">Creates an address resource in the specified project using the data included in the request.</p>
<p class="toc_element">
- <code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
+ <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves a list of global addresses.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -144,7 +144,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -246,16 +246,21 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves a list of global addresses.
Args:
project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
diff --git a/docs/dyn/compute_v1.globalForwardingRules.html b/docs/dyn/compute_v1.globalForwardingRules.html
index c7075e3..377a561 100644
--- a/docs/dyn/compute_v1.globalForwardingRules.html
+++ b/docs/dyn/compute_v1.globalForwardingRules.html
@@ -84,7 +84,7 @@
<code><a href="#insert">insert(project, body)</a></code></p>
<p class="firstline">Creates a ForwardingRule resource in the specified project and region using the data included in the request.</p>
<p class="toc_element">
- <code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
+ <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves a list of ForwardingRule resources available to the specified project.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -147,7 +147,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -267,16 +267,21 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves a list of ForwardingRule resources available to the specified project.
Args:
project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
@@ -400,7 +405,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
diff --git a/docs/dyn/compute_v1.globalOperations.html b/docs/dyn/compute_v1.globalOperations.html
index a198247..eaa759b 100644
--- a/docs/dyn/compute_v1.globalOperations.html
+++ b/docs/dyn/compute_v1.globalOperations.html
@@ -75,7 +75,7 @@
<h1><a href="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.globalOperations.html">globalOperations</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
+ <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves an aggregated list of all operations.</p>
<p class="toc_element">
<code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
@@ -87,18 +87,23 @@
<code><a href="#get">get(project, operation)</a></code></p>
<p class="firstline">Retrieves the specified Operations resource. Get a list of operations by making a list() request.</p>
<p class="toc_element">
- <code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
+ <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves a list of Operation resources contained within the specified project.</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>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</code>
+ <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves an aggregated list of all operations.
Args:
project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
@@ -162,7 +167,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
},
],
"warning": { # [Output Only] Informational warning which replaces the list of operations when the list is empty.
@@ -262,16 +267,21 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves a list of Operation resources contained within the specified project.
Args:
project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
@@ -333,7 +343,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
},
],
"kind": "compute#operationList", # [Output Only] Type of resource. Always compute#operations for Operations resource.
diff --git a/docs/dyn/compute_v1.healthChecks.html b/docs/dyn/compute_v1.healthChecks.html
new file mode 100644
index 0000000..34872cd
--- /dev/null
+++ b/docs/dyn/compute_v1.healthChecks.html
@@ -0,0 +1,645 @@
+<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="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.healthChecks.html">healthChecks</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(project, healthCheck)</a></code></p>
+<p class="firstline">Deletes the specified HealthCheck resource.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, healthCheck)</a></code></p>
+<p class="firstline">Returns the specified HealthCheck resource. Get a list of available health checks by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, body)</a></code></p>
+<p class="firstline">Creates a HealthCheck resource in the specified project using the data included in the request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves the list of HealthCheck resources available to the specified project.</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>
+<p class="toc_element">
+ <code><a href="#patch">patch(project, healthCheck, body)</a></code></p>
+<p class="firstline">Updates a HealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.</p>
+<p class="toc_element">
+ <code><a href="#update">update(project, healthCheck, body)</a></code></p>
+<p class="firstline">Updates a HealthCheck resource in the specified project using the data included in the request.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(project, healthCheck)</code>
+ <pre>Deletes the specified HealthCheck resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ healthCheck: string, Name of the HealthCheck resource to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "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 value 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] The URL of the region where the operation resides. Only available when performing regional operations.
+ "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 that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, healthCheck)</code>
+ <pre>Returns the specified HealthCheck resource. Get a list of available health checks by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ healthCheck: string, Name of the HealthCheck resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols.
+ "kind": "compute#healthCheck", # Type of the resource.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
+ "type": "A String", # Specifies the type of the healthCheck, either TCP, UDP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.
+ "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
+ "tcpHealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 80.
+ "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
+ },
+ "httpHealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 80.
+ "requestPath": "A String", # The request path of the HTTP health check request. The default value is /.
+ },
+ "httpsHealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 443.
+ "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /.
+ },
+ "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
+ "http2HealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "host": "A String", # The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 443.
+ "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.
+ },
+ "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
+ "sslHealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "request": "A String", # The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 443.
+ "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
+ },
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is 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>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, body)</code>
+ <pre>Creates a HealthCheck resource in the specified project using the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols.
+ "kind": "compute#healthCheck", # Type of the resource.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
+ "type": "A String", # Specifies the type of the healthCheck, either TCP, UDP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.
+ "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
+ "tcpHealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 80.
+ "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
+ },
+ "httpHealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 80.
+ "requestPath": "A String", # The request path of the HTTP health check request. The default value is /.
+ },
+ "httpsHealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 443.
+ "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /.
+ },
+ "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
+ "http2HealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "host": "A String", # The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 443.
+ "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.
+ },
+ "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
+ "sslHealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "request": "A String", # The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 443.
+ "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
+ },
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is 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.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "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 value 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] The URL of the region where the operation resides. Only available when performing regional operations.
+ "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 that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves the list of HealthCheck resources available to the specified project.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of HealthCheck resources.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # A list of HealthCheck resources.
+ { # An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols.
+ "kind": "compute#healthCheck", # Type of the resource.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
+ "type": "A String", # Specifies the type of the healthCheck, either TCP, UDP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.
+ "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
+ "tcpHealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 80.
+ "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
+ },
+ "httpHealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 80.
+ "requestPath": "A String", # The request path of the HTTP health check request. The default value is /.
+ },
+ "httpsHealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 443.
+ "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /.
+ },
+ "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
+ "http2HealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "host": "A String", # The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 443.
+ "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.
+ },
+ "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
+ "sslHealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "request": "A String", # The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 443.
+ "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
+ },
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is 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#healthCheckList", # Type of resource.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
+ <pre>Retrieves the next page of results.
+
+Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+Returns:
+ A request object that you can call 'execute()' on to request the next
+ page. Returns None if there are no more items in the collection.
+ </pre>
+</div>
+
+<div class="method">
+ <code class="details" id="patch">patch(project, healthCheck, body)</code>
+ <pre>Updates a HealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.
+
+Args:
+ project: string, Project ID for this request. (required)
+ healthCheck: string, Name of the HealthCheck resource to update. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols.
+ "kind": "compute#healthCheck", # Type of the resource.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
+ "type": "A String", # Specifies the type of the healthCheck, either TCP, UDP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.
+ "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
+ "tcpHealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 80.
+ "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
+ },
+ "httpHealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 80.
+ "requestPath": "A String", # The request path of the HTTP health check request. The default value is /.
+ },
+ "httpsHealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 443.
+ "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /.
+ },
+ "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
+ "http2HealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "host": "A String", # The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 443.
+ "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.
+ },
+ "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
+ "sslHealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "request": "A String", # The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 443.
+ "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
+ },
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is 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.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "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 value 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] The URL of the region where the operation resides. Only available when performing regional operations.
+ "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 that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(project, healthCheck, body)</code>
+ <pre>Updates a HealthCheck resource in the specified project using the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ healthCheck: string, Name of the HealthCheck resource to update. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols.
+ "kind": "compute#healthCheck", # Type of the resource.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
+ "type": "A String", # Specifies the type of the healthCheck, either TCP, UDP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.
+ "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
+ "tcpHealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 80.
+ "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
+ },
+ "httpHealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 80.
+ "requestPath": "A String", # The request path of the HTTP health check request. The default value is /.
+ },
+ "httpsHealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 443.
+ "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /.
+ },
+ "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
+ "http2HealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "host": "A String", # The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 443.
+ "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.
+ },
+ "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
+ "sslHealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "request": "A String", # The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 443.
+ "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
+ },
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is 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.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "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 value 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] The URL of the region where the operation resides. Only available when performing regional operations.
+ "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 that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_v1.html b/docs/dyn/compute_v1.html
index a078d15..9b64698 100644
--- a/docs/dyn/compute_v1.html
+++ b/docs/dyn/compute_v1.html
@@ -125,6 +125,11 @@
<p class="firstline">Returns the globalOperations Resource.</p>
<p class="toc_element">
+ <code><a href="compute_v1.healthChecks.html">healthChecks()</a></code>
+</p>
+<p class="firstline">Returns the healthChecks Resource.</p>
+
+<p class="toc_element">
<code><a href="compute_v1.httpHealthChecks.html">httpHealthChecks()</a></code>
</p>
<p class="firstline">Returns the httpHealthChecks Resource.</p>
@@ -235,6 +240,11 @@
<p class="firstline">Returns the targetPools Resource.</p>
<p class="toc_element">
+ <code><a href="compute_v1.targetSslProxies.html">targetSslProxies()</a></code>
+</p>
+<p class="firstline">Returns the targetSslProxies Resource.</p>
+
+<p class="toc_element">
<code><a href="compute_v1.targetVpnGateways.html">targetVpnGateways()</a></code>
</p>
<p class="firstline">Returns the targetVpnGateways Resource.</p>
diff --git a/docs/dyn/compute_v1.httpHealthChecks.html b/docs/dyn/compute_v1.httpHealthChecks.html
index 0f737f3..0d247e4 100644
--- a/docs/dyn/compute_v1.httpHealthChecks.html
+++ b/docs/dyn/compute_v1.httpHealthChecks.html
@@ -84,7 +84,7 @@
<code><a href="#insert">insert(project, body)</a></code></p>
<p class="firstline">Creates a HttpHealthCheck resource in the specified project using the data included in the request.</p>
<p class="toc_element">
- <code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
+ <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves the list of HttpHealthCheck resources available to the specified project.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -150,7 +150,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -254,16 +254,21 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves the list of HttpHealthCheck resources available to the specified project.
Args:
project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
@@ -391,7 +396,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -468,7 +473,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
diff --git a/docs/dyn/compute_v1.httpsHealthChecks.html b/docs/dyn/compute_v1.httpsHealthChecks.html
index 84ec57a..2d7bf59 100644
--- a/docs/dyn/compute_v1.httpsHealthChecks.html
+++ b/docs/dyn/compute_v1.httpsHealthChecks.html
@@ -84,7 +84,7 @@
<code><a href="#insert">insert(project, body)</a></code></p>
<p class="firstline">Creates a HttpsHealthCheck resource in the specified project using the data included in the request.</p>
<p class="toc_element">
- <code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
+ <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves the list of HttpsHealthCheck resources available to the specified project.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -150,7 +150,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -254,16 +254,21 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves the list of HttpsHealthCheck resources available to the specified project.
Args:
project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
@@ -391,7 +396,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -468,7 +473,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
diff --git a/docs/dyn/compute_v1.images.html b/docs/dyn/compute_v1.images.html
index 6896f08..adcbfbc 100644
--- a/docs/dyn/compute_v1.images.html
+++ b/docs/dyn/compute_v1.images.html
@@ -90,7 +90,7 @@
<code><a href="#insert">insert(project, body)</a></code></p>
<p class="firstline">Creates an image in the specified project using the data included in the request.</p>
<p class="toc_element">
- <code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
+ <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves the list of private images available to the specified project. Private images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -150,7 +150,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -221,7 +221,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -449,16 +449,21 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves the list of private images available to the specified project. Private images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud.
Args:
project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
diff --git a/docs/dyn/compute_v1.instanceGroupManagers.html b/docs/dyn/compute_v1.instanceGroupManagers.html
index b162591..3068e0b 100644
--- a/docs/dyn/compute_v1.instanceGroupManagers.html
+++ b/docs/dyn/compute_v1.instanceGroupManagers.html
@@ -78,7 +78,7 @@
<code><a href="#abandonInstances">abandonInstances(project, zone, instanceGroupManager, body)</a></code></p>
<p class="firstline">Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.</p>
<p class="toc_element">
- <code><a href="#aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
+ <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves the list of managed instance groups and groups them by zone.</p>
<p class="toc_element">
<code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
@@ -96,7 +96,7 @@
<code><a href="#insert">insert(project, zone, body)</a></code></p>
<p class="firstline">Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.</p>
<p class="toc_element">
- <code><a href="#list">list(project, zone, maxResults=None, pageToken=None, filter=None)</a></code></p>
+ <code><a href="#list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves a list of managed instance groups that are contained within the specified project and zone.</p>
<p class="toc_element">
<code><a href="#listManagedInstances">listManagedInstances(project, zone, instanceGroupManager)</a></code></p>
@@ -181,16 +181,21 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
<div class="method">
- <code class="details" id="aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</code>
+ <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves the list of managed instance groups and groups them by zone.
Args:
project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
@@ -232,12 +237,13 @@
"restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
"abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
"deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
- "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's target_size value accordingly.
+ "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
"refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
},
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
"targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
+ "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
"instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
"kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
"targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
@@ -335,7 +341,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -403,7 +409,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -429,12 +435,13 @@
"restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
"abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
"deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
- "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's target_size value accordingly.
+ "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
"refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
},
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
"targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
+ "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
"instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
"kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
"targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
@@ -476,12 +483,13 @@
"restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
"abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
"deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
- "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's target_size value accordingly.
+ "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
"refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
},
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
"targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
+ "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
"instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
"kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
"targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
@@ -549,17 +557,22 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(project, zone, maxResults=None, pageToken=None, filter=None)</code>
+ <code class="details" id="list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves a list of managed instance groups that are contained within the specified project and zone.
Args:
project: string, Project ID for this request. (required)
zone: string, The name of the zone where the managed instance group is located. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
@@ -588,12 +601,13 @@
"restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
"abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
"deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
- "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's target_size value accordingly.
+ "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
"refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
},
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
"targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
+ "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
"instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
"kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
"targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
@@ -616,7 +630,7 @@
],
"kind": "compute#instanceGroupManagerList", # [Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups.
"id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
- "selfLink": "A String", # [Output Only] The URL for this resource type. The server generates this URL.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
}</pre>
</div>
@@ -741,7 +755,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -801,7 +815,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -867,7 +881,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -936,7 +950,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
diff --git a/docs/dyn/compute_v1.instanceGroups.html b/docs/dyn/compute_v1.instanceGroups.html
index 3b7ab31..85fc2a3 100644
--- a/docs/dyn/compute_v1.instanceGroups.html
+++ b/docs/dyn/compute_v1.instanceGroups.html
@@ -78,7 +78,7 @@
<code><a href="#addInstances">addInstances(project, zone, instanceGroup, body)</a></code></p>
<p class="firstline">Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information.</p>
<p class="toc_element">
- <code><a href="#aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
+ <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves the list of instance groups and sorts them by zone.</p>
<p class="toc_element">
<code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
@@ -93,10 +93,10 @@
<code><a href="#insert">insert(project, zone, body)</a></code></p>
<p class="firstline">Creates an instance group in the specified project using the parameters that are 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>
+ <code><a href="#list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves the list of instance groups that are located in the specified project and zone.</p>
<p class="toc_element">
- <code><a href="#listInstances">listInstances(project, zone, instanceGroup, body, maxResults=None, pageToken=None, filter=None)</a></code></p>
+ <code><a href="#listInstances">listInstances(project, zone, instanceGroup, body, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Lists the instances in the specified instance group.</p>
<p class="toc_element">
<code><a href="#listInstances_next">listInstances_next(previous_request, previous_response)</a></code></p>
@@ -177,16 +177,21 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
<div class="method">
- <code class="details" id="aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</code>
+ <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves the list of instance groups and sorts them by zone.
Args:
project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
@@ -223,6 +228,7 @@
"kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"zone": "A String", # [Output Only] The URL of the zone where the instance group is located (for zonal resources).
+ "region": "A String", # The URL of the region where the instance group is located (for regional resources).
"network": "A String", # The URL of the network to which all instances in the instance group belong.
"fingerprint": "A String", # [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
"subnetwork": "A String", # The URL of the subnetwork to which all instances in the instance group belong.
@@ -237,7 +243,7 @@
},
],
"creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance group in RFC3339 text format.
- "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
+ "id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server.
"selfLink": "A String", # [Output Only] The URL for this instance group. The server generates this URL.
"name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
},
@@ -319,7 +325,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -340,6 +346,7 @@
"kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"zone": "A String", # [Output Only] The URL of the zone where the instance group is located (for zonal resources).
+ "region": "A String", # The URL of the region where the instance group is located (for regional resources).
"network": "A String", # The URL of the network to which all instances in the instance group belong.
"fingerprint": "A String", # [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
"subnetwork": "A String", # The URL of the subnetwork to which all instances in the instance group belong.
@@ -354,7 +361,7 @@
},
],
"creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance group in RFC3339 text format.
- "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
+ "id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server.
"selfLink": "A String", # [Output Only] The URL for this instance group. The server generates this URL.
"name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
}</pre>
@@ -375,6 +382,7 @@
"kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"zone": "A String", # [Output Only] The URL of the zone where the instance group is located (for zonal resources).
+ "region": "A String", # The URL of the region where the instance group is located (for regional resources).
"network": "A String", # The URL of the network to which all instances in the instance group belong.
"fingerprint": "A String", # [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
"subnetwork": "A String", # The URL of the subnetwork to which all instances in the instance group belong.
@@ -389,7 +397,7 @@
},
],
"creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance group in RFC3339 text format.
- "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
+ "id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server.
"selfLink": "A String", # [Output Only] The URL for this instance group. The server generates this URL.
"name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
}
@@ -441,17 +449,22 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(project, zone, maxResults=None, pageToken=None, filter=None)</code>
+ <code class="details" id="list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves the list of instance groups that are located in the specified project and zone.
Args:
project: string, Project ID for this request. (required)
zone: string, The name of the zone where the instance group is located. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
@@ -475,6 +488,7 @@
"kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"zone": "A String", # [Output Only] The URL of the zone where the instance group is located (for zonal resources).
+ "region": "A String", # The URL of the region where the instance group is located (for regional resources).
"network": "A String", # The URL of the network to which all instances in the instance group belong.
"fingerprint": "A String", # [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
"subnetwork": "A String", # The URL of the subnetwork to which all instances in the instance group belong.
@@ -489,7 +503,7 @@
},
],
"creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance group in RFC3339 text format.
- "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
+ "id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server.
"selfLink": "A String", # [Output Only] The URL for this instance group. The server generates this URL.
"name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
},
@@ -501,7 +515,7 @@
</div>
<div class="method">
- <code class="details" id="listInstances">listInstances(project, zone, instanceGroup, body, maxResults=None, pageToken=None, filter=None)</code>
+ <code class="details" id="listInstances">listInstances(project, zone, instanceGroup, body, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
<pre>Lists the instances in the specified instance group.
Args:
@@ -515,6 +529,11 @@
"instanceState": "A String", # A filter for the state of the instances in the instance group. Valid options are ALL or RUNNING. If you do not specify this parameter the list includes all instances regardless of their state.
}
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
@@ -644,7 +663,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -716,7 +735,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
diff --git a/docs/dyn/compute_v1.instanceTemplates.html b/docs/dyn/compute_v1.instanceTemplates.html
index 6c42928..05075d4 100644
--- a/docs/dyn/compute_v1.instanceTemplates.html
+++ b/docs/dyn/compute_v1.instanceTemplates.html
@@ -84,7 +84,7 @@
<code><a href="#insert">insert(project, body)</a></code></p>
<p class="firstline">Creates an instance template in the specified project using the data that is included in the request. If you are creating a new template to update an existing instance group, your new instance template must use the same network or, if applicable, the same subnetwork as the original template.</p>
<p class="toc_element">
- <code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
+ <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves a list of instance templates that are contained within the specified project and zone.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -144,7 +144,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -494,16 +494,21 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves a list of instance templates that are contained within the specified project and zone.
Args:
project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
diff --git a/docs/dyn/compute_v1.instances.html b/docs/dyn/compute_v1.instances.html
index 7706d49..f3db40d 100644
--- a/docs/dyn/compute_v1.instances.html
+++ b/docs/dyn/compute_v1.instances.html
@@ -78,7 +78,7 @@
<code><a href="#addAccessConfig">addAccessConfig(project, zone, instance, networkInterface, body)</a></code></p>
<p class="firstline">Adds an access config to an instance's network interface.</p>
<p class="toc_element">
- <code><a href="#aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
+ <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves aggregated list of instances.</p>
<p class="toc_element">
<code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
@@ -105,7 +105,7 @@
<code><a href="#insert">insert(project, zone, body)</a></code></p>
<p class="firstline">Creates an instance resource 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>
+ <code><a href="#list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves the list of instances contained within the specified zone.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -204,16 +204,21 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
<div class="method">
- <code class="details" id="aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</code>
+ <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves aggregated list of instances.
Args:
project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
@@ -236,7 +241,7 @@
"instances": [ # [Output Only] List of instances contained in this scope.
{ # An Instance resource.
"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.
- "status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDED, SUSPENDING, and TERMINATED.
+ "status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, and 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 description of this resource. Provide this property when you create the resource.
@@ -543,7 +548,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -602,7 +607,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -663,7 +668,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -723,7 +728,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -741,7 +746,7 @@
{ # An Instance resource.
"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.
- "status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDED, SUSPENDING, and TERMINATED.
+ "status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, and 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 description of this resource. Provide this property when you create the resource.
@@ -905,7 +910,7 @@
{ # 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.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
"contents": "A String", # [Output Only] The contents of the console output.
}</pre>
</div>
@@ -922,7 +927,7 @@
{ # An Instance resource.
"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.
- "status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDED, SUSPENDING, and TERMINATED.
+ "status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, and 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 description of this resource. Provide this property when you create the resource.
@@ -1117,17 +1122,22 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(project, zone, maxResults=None, pageToken=None, filter=None)</code>
+ <code class="details" id="list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves the list of instances contained within the specified zone.
Args:
project: string, Project ID for this request. (required)
zone: string, The name of the zone for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
@@ -1148,7 +1158,7 @@
"items": [ # [Output Only] A list of instances.
{ # An Instance resource.
"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.
- "status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDED, SUSPENDING, and TERMINATED.
+ "status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, and 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 description of this resource. Provide this property when you create the resource.
@@ -1371,7 +1381,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -1432,7 +1442,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -1498,7 +1508,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -1571,7 +1581,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -1639,7 +1649,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -1710,7 +1720,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -1769,7 +1779,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -1847,7 +1857,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -1906,7 +1916,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
diff --git a/docs/dyn/compute_v1.machineTypes.html b/docs/dyn/compute_v1.machineTypes.html
index a62c4ec..e213d7c 100644
--- a/docs/dyn/compute_v1.machineTypes.html
+++ b/docs/dyn/compute_v1.machineTypes.html
@@ -75,7 +75,7 @@
<h1><a href="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.machineTypes.html">machineTypes</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
+ <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves an aggregated list of machine types.</p>
<p class="toc_element">
<code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
@@ -84,18 +84,23 @@
<code><a href="#get">get(project, zone, machineType)</a></code></p>
<p class="firstline">Returns the specified machine type. Get a list of available machine types by making a list() request.</p>
<p class="toc_element">
- <code><a href="#list">list(project, zone, maxResults=None, pageToken=None, filter=None)</a></code></p>
+ <code><a href="#list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves a list of machine types available to the specified project.</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>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</code>
+ <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves an aggregated list of machine types.
Args:
project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
@@ -219,12 +224,17 @@
</div>
<div class="method">
- <code class="details" id="list">list(project, zone, maxResults=None, pageToken=None, filter=None)</code>
+ <code class="details" id="list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves a list of machine types available to the specified project.
Args:
project: string, Project ID for this request. (required)
zone: string, The name of the zone for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
diff --git a/docs/dyn/compute_v1.networks.html b/docs/dyn/compute_v1.networks.html
index b810a48..383e07b 100644
--- a/docs/dyn/compute_v1.networks.html
+++ b/docs/dyn/compute_v1.networks.html
@@ -84,7 +84,7 @@
<code><a href="#insert">insert(project, body)</a></code></p>
<p class="firstline">Creates a network in the specified project using the data included in the request.</p>
<p class="toc_element">
- <code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
+ <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves the list of networks available to the specified project.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -144,7 +144,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -250,16 +250,21 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves the list of networks available to the specified project.
Args:
project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
@@ -297,7 +302,7 @@
],
"kind": "compute#networkList", # [Output Only] Type of resource. Always compute#networkList for lists of networks.
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
- "selfLink": "A String", # [Output Only] Server-defined URL for this resource .
+ "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 22d1ff8..8bc5d12 100644
--- a/docs/dyn/compute_v1.projects.html
+++ b/docs/dyn/compute_v1.projects.html
@@ -202,7 +202,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -273,7 +273,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -344,7 +344,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -409,7 +409,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
diff --git a/docs/dyn/compute_v1.regionOperations.html b/docs/dyn/compute_v1.regionOperations.html
index 31ba5e6..1f37609 100644
--- a/docs/dyn/compute_v1.regionOperations.html
+++ b/docs/dyn/compute_v1.regionOperations.html
@@ -81,7 +81,7 @@
<code><a href="#get">get(project, region, operation)</a></code></p>
<p class="firstline">Retrieves the specified region-specific Operations resource.</p>
<p class="toc_element">
- <code><a href="#list">list(project, region, maxResults=None, pageToken=None, filter=None)</a></code></p>
+ <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves a list of Operation resources contained within the specified region.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -153,17 +153,22 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(project, region, maxResults=None, pageToken=None, filter=None)</code>
+ <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves a list of Operation resources contained within the specified region.
Args:
project: string, Project ID for this request. (required)
region: string, Name of the region for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
@@ -225,7 +230,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
},
],
"kind": "compute#operationList", # [Output Only] Type of resource. Always compute#operations for Operations resource.
diff --git a/docs/dyn/compute_v1.regions.html b/docs/dyn/compute_v1.regions.html
index b5ed388..a89d89e 100644
--- a/docs/dyn/compute_v1.regions.html
+++ b/docs/dyn/compute_v1.regions.html
@@ -78,7 +78,7 @@
<code><a href="#get">get(project, region)</a></code></p>
<p class="firstline">Returns the specified Region resource. Get a list of available regions by making a list() request.</p>
<p class="toc_element">
- <code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
+ <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves the list of region resources available to the specified project.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -124,11 +124,16 @@
</div>
<div class="method">
- <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves the list of region resources available to the specified project.
Args:
project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
diff --git a/docs/dyn/compute_v1.routers.html b/docs/dyn/compute_v1.routers.html
index d1a99d5..821acf9 100644
--- a/docs/dyn/compute_v1.routers.html
+++ b/docs/dyn/compute_v1.routers.html
@@ -75,7 +75,7 @@
<h1><a href="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.routers.html">routers</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
+ <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves an aggregated list of routers.</p>
<p class="toc_element">
<code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
@@ -93,27 +93,32 @@
<code><a href="#insert">insert(project, region, body)</a></code></p>
<p class="firstline">Creates a Router resource in the specified project and region using the data included in the request.</p>
<p class="toc_element">
- <code><a href="#list">list(project, region, maxResults=None, pageToken=None, filter=None)</a></code></p>
+ <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves a list of Router resources available to the specified project.</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>
<p class="toc_element">
<code><a href="#patch">patch(project, region, router, body)</a></code></p>
-<p class="firstline">Updates the entire content of the Router resource. This method supports patch semantics.</p>
+<p class="firstline">Updates the specified Router resource with the data included in the request. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#preview">preview(project, region, router, body)</a></code></p>
<p class="firstline">Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router.</p>
<p class="toc_element">
<code><a href="#update">update(project, region, router, body)</a></code></p>
-<p class="firstline">Updates the entire content of the Router resource.</p>
+<p class="firstline">Updates the specified Router resource with the data included in the request.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</code>
+ <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves an aggregated list of routers.
Args:
project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
@@ -253,7 +258,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -500,17 +505,22 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(project, region, maxResults=None, pageToken=None, filter=None)</code>
+ <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves a list of Router resources available to the specified project.
Args:
project: string, Project ID for this request. (required)
region: string, Name of the region for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
@@ -562,7 +572,7 @@
],
"kind": "compute#routerList", # [Output Only] Type of resource. Always compute#router for routers.
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
- "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
}</pre>
</div>
@@ -582,7 +592,7 @@
<div class="method">
<code class="details" id="patch">patch(project, region, router, body)</code>
- <pre>Updates the entire content of the Router resource. This method supports patch semantics.
+ <pre>Updates the specified Router resource with the data included in the request. This method supports patch semantics.
Args:
project: string, Project ID for this request. (required)
@@ -669,7 +679,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -755,7 +765,7 @@
<div class="method">
<code class="details" id="update">update(project, region, router, body)</code>
- <pre>Updates the entire content of the Router resource.
+ <pre>Updates the specified Router resource with the data included in the request.
Args:
project: string, Project ID for this request. (required)
@@ -842,7 +852,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
diff --git a/docs/dyn/compute_v1.routes.html b/docs/dyn/compute_v1.routes.html
index 4523d8c..c42e09e 100644
--- a/docs/dyn/compute_v1.routes.html
+++ b/docs/dyn/compute_v1.routes.html
@@ -84,7 +84,7 @@
<code><a href="#insert">insert(project, body)</a></code></p>
<p class="firstline">Creates a Route resource in the specified project using the data included in the request.</p>
<p class="toc_element">
- <code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
+ <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves the list of Route resources available to the specified project.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -144,7 +144,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -292,16 +292,21 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves the list of Route resources available to the specified project.
Args:
project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
diff --git a/docs/dyn/compute_v1.snapshots.html b/docs/dyn/compute_v1.snapshots.html
index e2ea2b5..e038b1f 100644
--- a/docs/dyn/compute_v1.snapshots.html
+++ b/docs/dyn/compute_v1.snapshots.html
@@ -81,7 +81,7 @@
<code><a href="#get">get(project, snapshot)</a></code></p>
<p class="firstline">Returns the specified Snapshot resource. Get a list of available snapshots by making a list() request.</p>
<p class="toc_element">
- <code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
+ <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves the list of Snapshot resources contained within the specified project.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -143,7 +143,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -192,11 +192,16 @@
</div>
<div class="method">
- <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves the list of Snapshot resources contained within the specified project.
Args:
project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
diff --git a/docs/dyn/compute_v1.sslCertificates.html b/docs/dyn/compute_v1.sslCertificates.html
index 686a270..e2fec84 100644
--- a/docs/dyn/compute_v1.sslCertificates.html
+++ b/docs/dyn/compute_v1.sslCertificates.html
@@ -84,7 +84,7 @@
<code><a href="#insert">insert(project, body)</a></code></p>
<p class="firstline">Creates a SslCertificate resource in the specified project using the data included in the request.</p>
<p class="toc_element">
- <code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
+ <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves the list of SslCertificate resources available to the specified project.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -144,7 +144,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -238,16 +238,21 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves the list of SslCertificate resources available to the specified project.
Args:
project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
diff --git a/docs/dyn/compute_v1.subnetworks.html b/docs/dyn/compute_v1.subnetworks.html
index 3f2d1b2..4d52f0f 100644
--- a/docs/dyn/compute_v1.subnetworks.html
+++ b/docs/dyn/compute_v1.subnetworks.html
@@ -75,7 +75,7 @@
<h1><a href="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.subnetworks.html">subnetworks</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
+ <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves an aggregated list of subnetworks.</p>
<p class="toc_element">
<code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
@@ -90,18 +90,23 @@
<code><a href="#insert">insert(project, region, body)</a></code></p>
<p class="firstline">Creates a subnetwork in the specified project using the data included in the request.</p>
<p class="toc_element">
- <code><a href="#list">list(project, region, maxResults=None, pageToken=None, filter=None)</a></code></p>
+ <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves a list of subnetworks available to the specified project.</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>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</code>
+ <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves an aggregated list of subnetworks.
Args:
project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
@@ -223,7 +228,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -323,17 +328,22 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(project, region, maxResults=None, pageToken=None, filter=None)</code>
+ <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves a list of subnetworks available to the specified project.
Args:
project: string, Project ID for this request. (required)
region: string, Name of the region scoping this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
diff --git a/docs/dyn/compute_v1.targetHttpProxies.html b/docs/dyn/compute_v1.targetHttpProxies.html
index 224059d..75d76ff 100644
--- a/docs/dyn/compute_v1.targetHttpProxies.html
+++ b/docs/dyn/compute_v1.targetHttpProxies.html
@@ -84,7 +84,7 @@
<code><a href="#insert">insert(project, body)</a></code></p>
<p class="firstline">Creates a TargetHttpProxy resource in the specified project using the data included in the request.</p>
<p class="toc_element">
- <code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
+ <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves the list of TargetHttpProxy resources available to the specified project.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -147,7 +147,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -239,16 +239,21 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves the list of TargetHttpProxy resources available to the specified project.
Args:
project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
@@ -358,7 +363,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
diff --git a/docs/dyn/compute_v1.targetHttpsProxies.html b/docs/dyn/compute_v1.targetHttpsProxies.html
index 2f9932d..f252cf0 100644
--- a/docs/dyn/compute_v1.targetHttpsProxies.html
+++ b/docs/dyn/compute_v1.targetHttpsProxies.html
@@ -84,7 +84,7 @@
<code><a href="#insert">insert(project, body)</a></code></p>
<p class="firstline">Creates a TargetHttpsProxy resource in the specified project using the data included in the request.</p>
<p class="toc_element">
- <code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
+ <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves the list of TargetHttpsProxy resources available to the specified project.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -150,7 +150,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -254,16 +254,21 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves the list of TargetHttpsProxy resources available to the specified project.
Args:
project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
@@ -381,7 +386,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -446,7 +451,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
diff --git a/docs/dyn/compute_v1.targetInstances.html b/docs/dyn/compute_v1.targetInstances.html
index 302954d..c8c9882 100644
--- a/docs/dyn/compute_v1.targetInstances.html
+++ b/docs/dyn/compute_v1.targetInstances.html
@@ -75,7 +75,7 @@
<h1><a href="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.targetInstances.html">targetInstances</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
+ <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves an aggregated list of target instances.</p>
<p class="toc_element">
<code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
@@ -90,18 +90,23 @@
<code><a href="#insert">insert(project, zone, body)</a></code></p>
<p class="firstline">Creates a TargetInstance resource in the specified project and zone 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>
+ <code><a href="#list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves a list of TargetInstance resources available to the specified project and 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>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</code>
+ <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves an aggregated list of target instances.
Args:
project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
@@ -225,7 +230,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -329,17 +334,22 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(project, zone, maxResults=None, pageToken=None, filter=None)</code>
+ <code class="details" id="list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves a list of TargetInstance resources available to the specified project and zone.
Args:
project: string, Project ID for this request. (required)
zone: string, Name of the zone scoping this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
diff --git a/docs/dyn/compute_v1.targetPools.html b/docs/dyn/compute_v1.targetPools.html
index fb7d8e3..a2272ad 100644
--- a/docs/dyn/compute_v1.targetPools.html
+++ b/docs/dyn/compute_v1.targetPools.html
@@ -81,7 +81,7 @@
<code><a href="#addInstance">addInstance(project, region, targetPool, body)</a></code></p>
<p class="firstline">Adds an instance to a target pool.</p>
<p class="toc_element">
- <code><a href="#aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
+ <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves an aggregated list of target pools.</p>
<p class="toc_element">
<code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
@@ -99,7 +99,7 @@
<code><a href="#insert">insert(project, region, body)</a></code></p>
<p class="firstline">Creates a target pool in the specified project and region using the data included in the request.</p>
<p class="toc_element">
- <code><a href="#list">list(project, region, maxResults=None, pageToken=None, filter=None)</a></code></p>
+ <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves a list of target pools available to the specified project and region.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -183,7 +183,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -256,16 +256,21 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
<div class="method">
- <code class="details" id="aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</code>
+ <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves an aggregated list of target pools.
Args:
project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
@@ -404,7 +409,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -570,17 +575,22 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(project, region, maxResults=None, pageToken=None, filter=None)</code>
+ <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves a list of target pools available to the specified project and region.
Args:
project: string, Project ID for this request. (required)
region: string, Name of the region scoping this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
@@ -721,7 +731,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -791,7 +801,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -858,7 +868,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
diff --git a/docs/dyn/compute_v1.targetSslProxies.html b/docs/dyn/compute_v1.targetSslProxies.html
new file mode 100644
index 0000000..91e8850
--- /dev/null
+++ b/docs/dyn/compute_v1.targetSslProxies.html
@@ -0,0 +1,520 @@
+<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="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.targetSslProxies.html">targetSslProxies</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(project, targetSslProxy)</a></code></p>
+<p class="firstline">Deletes the specified TargetSslProxy resource.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, targetSslProxy)</a></code></p>
+<p class="firstline">Returns the specified TargetSslProxy resource. Get a list of available target SSL proxies by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, body)</a></code></p>
+<p class="firstline">Creates a TargetSslProxy resource in the specified project using the data included in the request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves the list of TargetSslProxy resources available to the specified project.</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>
+<p class="toc_element">
+ <code><a href="#setBackendService">setBackendService(project, targetSslProxy, body)</a></code></p>
+<p class="firstline">Changes the BackendService for TargetSslProxy.</p>
+<p class="toc_element">
+ <code><a href="#setProxyHeader">setProxyHeader(project, targetSslProxy, body)</a></code></p>
+<p class="firstline">Changes the ProxyHeaderType for TargetSslProxy.</p>
+<p class="toc_element">
+ <code><a href="#setSslCertificates">setSslCertificates(project, targetSslProxy, body)</a></code></p>
+<p class="firstline">Changes SslCertificates for TargetSslProxy.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(project, targetSslProxy)</code>
+ <pre>Deletes the specified TargetSslProxy resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ targetSslProxy: string, Name of the TargetSslProxy resource to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "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 value 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] The URL of the region where the operation resides. Only available when performing regional operations.
+ "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 that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, targetSslProxy)</code>
+ <pre>Returns the specified TargetSslProxy resource. Get a list of available target SSL proxies by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ targetSslProxy: string, Name of the TargetSslProxy resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # A TargetSslProxy resource. This resource defines an SSL proxy.
+ "kind": "compute#targetSslProxy", # [Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "service": "A String", # URL to the BackendService resource.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections to Backends. Currently exactly one SSL certificate must be specified.
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is 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>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, body)</code>
+ <pre>Creates a TargetSslProxy resource in the specified project using the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A TargetSslProxy resource. This resource defines an SSL proxy.
+ "kind": "compute#targetSslProxy", # [Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "service": "A String", # URL to the BackendService resource.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections to Backends. Currently exactly one SSL certificate must be specified.
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is 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.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "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 value 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] The URL of the region where the operation resides. Only available when performing regional operations.
+ "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 that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves the list of TargetSslProxy resources available to the specified project.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of TargetSslProxy resources.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # A list of TargetSslProxy resources.
+ { # A TargetSslProxy resource. This resource defines an SSL proxy.
+ "kind": "compute#targetSslProxy", # [Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "service": "A String", # URL to the BackendService resource.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections to Backends. Currently exactly one SSL certificate must be specified.
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is 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#targetSslProxyList", # Type of resource.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
+ <pre>Retrieves the next page of results.
+
+Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+Returns:
+ A request object that you can call 'execute()' on to request the next
+ page. Returns None if there are no more items in the collection.
+ </pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setBackendService">setBackendService(project, targetSslProxy, body)</code>
+ <pre>Changes the BackendService for TargetSslProxy.
+
+Args:
+ project: string, Project ID for this request. (required)
+ targetSslProxy: string, Name of the TargetSslProxy resource whose BackendService resource is to be set. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "service": "A String", # The URL of the new BackendService resource for the targetSslProxy.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "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 value 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] The URL of the region where the operation resides. Only available when performing regional operations.
+ "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 that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setProxyHeader">setProxyHeader(project, targetSslProxy, body)</code>
+ <pre>Changes the ProxyHeaderType for TargetSslProxy.
+
+Args:
+ project: string, Project ID for this request. (required)
+ targetSslProxy: string, Name of the TargetSslProxy resource whose ProxyHeader is to be set. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "proxyHeader": "A String", # The new type of proxy header to append before sending data to the backend. NONE or PROXY_V1 are allowed.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "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 value 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] The URL of the region where the operation resides. Only available when performing regional operations.
+ "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 that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setSslCertificates">setSslCertificates(project, targetSslProxy, body)</code>
+ <pre>Changes SslCertificates for TargetSslProxy.
+
+Args:
+ project: string, Project ID for this request. (required)
+ targetSslProxy: string, Name of the TargetSslProxy resource whose SslCertificate resource is to be set. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "sslCertificates": [ # New set of URLs to SslCertificate resources to associate with this TargetSslProxy. Currently exactly one ssl certificate must be specified.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "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 value 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] The URL of the region where the operation resides. Only available when performing regional operations.
+ "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 that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_v1.targetVpnGateways.html b/docs/dyn/compute_v1.targetVpnGateways.html
index ff0a6f1..781e38e 100644
--- a/docs/dyn/compute_v1.targetVpnGateways.html
+++ b/docs/dyn/compute_v1.targetVpnGateways.html
@@ -75,7 +75,7 @@
<h1><a href="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.targetVpnGateways.html">targetVpnGateways</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
+ <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves an aggregated list of target VPN gateways.</p>
<p class="toc_element">
<code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
@@ -90,18 +90,23 @@
<code><a href="#insert">insert(project, region, body)</a></code></p>
<p class="firstline">Creates a target VPN gateway in the specified project and region using the data included in the request.</p>
<p class="toc_element">
- <code><a href="#list">list(project, region, maxResults=None, pageToken=None, filter=None)</a></code></p>
+ <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves a list of target VPN gateways available to the specified project and region.</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>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</code>
+ <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves an aggregated list of target VPN gateways.
Args:
project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
@@ -155,7 +160,7 @@
},
"kind": "compute#targetVpnGatewayAggregatedList", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
- "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
}</pre>
</div>
@@ -228,7 +233,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -338,17 +343,22 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(project, region, maxResults=None, pageToken=None, filter=None)</code>
+ <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves a list of target VPN gateways available to the specified project and region.
Args:
project: string, Project ID for this request. (required)
region: string, Name of the region for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
@@ -387,7 +397,7 @@
],
"kind": "compute#targetVpnGatewayList", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
- "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
}</pre>
</div>
diff --git a/docs/dyn/compute_v1.urlMaps.html b/docs/dyn/compute_v1.urlMaps.html
index 1af13d4..9857a33 100644
--- a/docs/dyn/compute_v1.urlMaps.html
+++ b/docs/dyn/compute_v1.urlMaps.html
@@ -87,17 +87,17 @@
<code><a href="#invalidateCache">invalidateCache(project, urlMap, body)</a></code></p>
<p class="firstline">Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap.</p>
<p class="toc_element">
- <code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
+ <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves the list of UrlMap resources available to the specified project.</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>
<p class="toc_element">
<code><a href="#patch">patch(project, urlMap, body)</a></code></p>
-<p class="firstline">Updates the entire content of the UrlMap resource. This method supports patch semantics.</p>
+<p class="firstline">Updates the specified UrlMap resource with the data included in the request. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#update">update(project, urlMap, body)</a></code></p>
-<p class="firstline">Updates the entire content of the UrlMap resource.</p>
+<p class="firstline">Updates the specified UrlMap resource with the data included in the request.</p>
<p class="toc_element">
<code><a href="#validate">validate(project, urlMap, body)</a></code></p>
<p class="firstline">Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.</p>
@@ -156,7 +156,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -320,7 +320,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -385,16 +385,21 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves the list of UrlMap resources available to the specified project.
Args:
project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
@@ -481,7 +486,7 @@
<div class="method">
<code class="details" id="patch">patch(project, urlMap, body)</code>
- <pre>Updates the entire content of the UrlMap resource. This method supports patch semantics.
+ <pre>Updates the specified UrlMap resource with the data included in the request. This method supports patch semantics.
Args:
project: string, Project ID for this request. (required)
@@ -582,13 +587,13 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(project, urlMap, body)</code>
- <pre>Updates the entire content of the UrlMap resource.
+ <pre>Updates the specified UrlMap resource with the data included in the request.
Args:
project: string, Project ID for this request. (required)
@@ -689,7 +694,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
diff --git a/docs/dyn/compute_v1.vpnTunnels.html b/docs/dyn/compute_v1.vpnTunnels.html
index 669f9cc..1198a10 100644
--- a/docs/dyn/compute_v1.vpnTunnels.html
+++ b/docs/dyn/compute_v1.vpnTunnels.html
@@ -75,7 +75,7 @@
<h1><a href="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.vpnTunnels.html">vpnTunnels</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
+ <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves an aggregated list of VPN tunnels.</p>
<p class="toc_element">
<code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
@@ -90,18 +90,23 @@
<code><a href="#insert">insert(project, region, body)</a></code></p>
<p class="firstline">Creates a VpnTunnel resource in the specified project and region using the data included in the request.</p>
<p class="toc_element">
- <code><a href="#list">list(project, region, maxResults=None, pageToken=None, filter=None)</a></code></p>
+ <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves a list of VpnTunnel resources contained in the specified project and region.</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>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</code>
+ <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves an aggregated list of VPN tunnels.
Args:
project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
@@ -234,7 +239,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
@@ -356,17 +361,22 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(project, region, maxResults=None, pageToken=None, filter=None)</code>
+ <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves a list of VpnTunnel resources contained in the specified project and region.
Args:
project: string, Project ID for this request. (required)
region: string, Name of the region for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
@@ -411,7 +421,7 @@
],
"kind": "compute#vpnTunnelList", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
- "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
}</pre>
</div>
diff --git a/docs/dyn/compute_v1.zoneOperations.html b/docs/dyn/compute_v1.zoneOperations.html
index 684b46e..e056a11 100644
--- a/docs/dyn/compute_v1.zoneOperations.html
+++ b/docs/dyn/compute_v1.zoneOperations.html
@@ -81,7 +81,7 @@
<code><a href="#get">get(project, zone, operation)</a></code></p>
<p class="firstline">Retrieves the specified zone-specific Operations resource.</p>
<p class="toc_element">
- <code><a href="#list">list(project, zone, maxResults=None, pageToken=None, filter=None)</a></code></p>
+ <code><a href="#list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves a list of Operation resources contained within the specified zone.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -153,17 +153,22 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(project, zone, maxResults=None, pageToken=None, filter=None)</code>
+ <code class="details" id="list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves a list of Operation resources contained within the specified zone.
Args:
project: string, Project ID for this request. (required)
zone: string, Name of the zone for request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
@@ -225,7 +230,7 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
},
],
"kind": "compute#operationList", # [Output Only] Type of resource. Always compute#operations for Operations resource.
diff --git a/docs/dyn/compute_v1.zones.html b/docs/dyn/compute_v1.zones.html
index 51ff31d..5981a1a 100644
--- a/docs/dyn/compute_v1.zones.html
+++ b/docs/dyn/compute_v1.zones.html
@@ -78,7 +78,7 @@
<code><a href="#get">get(project, zone)</a></code></p>
<p class="firstline">Returns the specified Zone resource. Get a list of available zones by making a list() request.</p>
<p class="toc_element">
- <code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
+ <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves the list of Zone resources available to the specified project.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -115,11 +115,16 @@
</div>
<div class="method">
- <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves the list of Zone resources available to the specified project.
Args:
project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
diff --git a/docs/dyn/consumersurveys_v2.results.html b/docs/dyn/consumersurveys_v2.results.html
index 6557b08..713ea0a 100644
--- a/docs/dyn/consumersurveys_v2.results.html
+++ b/docs/dyn/consumersurveys_v2.results.html
@@ -76,14 +76,14 @@
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(surveyUrlId)</a></code></p>
-<p class="firstline">Retrieves any survey results that have been produced so far. Results are formatted as an Excel file.</p>
+<p class="firstline">Retrieves any survey results that have been produced so far. Results are formatted as an Excel file. You must add "?alt=media" to the URL as an argument to get results.</p>
<p class="toc_element">
<code><a href="#get_media">get_media(surveyUrlId)</a></code></p>
-<p class="firstline">Retrieves any survey results that have been produced so far. Results are formatted as an Excel file.</p>
+<p class="firstline">Retrieves any survey results that have been produced so far. Results are formatted as an Excel file. You must add "?alt=media" to the URL as an argument to get results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(surveyUrlId)</code>
- <pre>Retrieves any survey results that have been produced so far. Results are formatted as an Excel file.
+ <pre>Retrieves any survey results that have been produced so far. Results are formatted as an Excel file. You must add "?alt=media" to the URL as an argument to get results.
Args:
surveyUrlId: string, External URL ID for the survey. (required)
@@ -99,7 +99,7 @@
<div class="method">
<code class="details" id="get_media">get_media(surveyUrlId)</code>
- <pre>Retrieves any survey results that have been produced so far. Results are formatted as an Excel file.
+ <pre>Retrieves any survey results that have been produced so far. Results are formatted as an Excel file. You must add "?alt=media" to the URL as an argument to get results.
Args:
surveyUrlId: string, External URL ID for the survey. (required)
diff --git a/docs/dyn/consumersurveys_v2.surveys.html b/docs/dyn/consumersurveys_v2.surveys.html
index ffc6f19..35155c7 100644
--- a/docs/dyn/consumersurveys_v2.surveys.html
+++ b/docs/dyn/consumersurveys_v2.surveys.html
@@ -184,6 +184,10 @@
},
],
"wantedResponseCount": 42, # Number of responses desired for the survey.
+ "rejectionReason": { # Message representing why the survey was rejected from review, if it was. # Reason for the survey being rejected. Only present if the survey state is 'rejected'.
+ "explanation": "A String", # A human-readable explanation of what was wrong with the survey.
+ "type": "A String", # Which category of rejection this was. See the GCS Help Center for additional details on each category.
+ },
}</pre>
</div>
@@ -258,6 +262,10 @@
},
],
"wantedResponseCount": 42, # Number of responses desired for the survey.
+ "rejectionReason": { # Message representing why the survey was rejected from review, if it was. # Reason for the survey being rejected. Only present if the survey state is 'rejected'.
+ "explanation": "A String", # A human-readable explanation of what was wrong with the survey.
+ "type": "A String", # Which category of rejection this was. See the GCS Help Center for additional details on each category.
+ },
}
@@ -327,6 +335,10 @@
},
],
"wantedResponseCount": 42, # Number of responses desired for the survey.
+ "rejectionReason": { # Message representing why the survey was rejected from review, if it was. # Reason for the survey being rejected. Only present if the survey state is 'rejected'.
+ "explanation": "A String", # A human-readable explanation of what was wrong with the survey.
+ "type": "A String", # Which category of rejection this was. See the GCS Help Center for additional details on each category.
+ },
}</pre>
</div>
@@ -416,6 +428,10 @@
},
],
"wantedResponseCount": 42, # Number of responses desired for the survey.
+ "rejectionReason": { # Message representing why the survey was rejected from review, if it was. # Reason for the survey being rejected. Only present if the survey state is 'rejected'.
+ "explanation": "A String", # A human-readable explanation of what was wrong with the survey.
+ "type": "A String", # Which category of rejection this was. See the GCS Help Center for additional details on each category.
+ },
},
],
"requestId": "A String", # Unique request ID used for logging and debugging. Please include in any error reporting or troubleshooting requests.
@@ -503,6 +519,10 @@
},
],
"wantedResponseCount": 42, # Number of responses desired for the survey.
+ "rejectionReason": { # Message representing why the survey was rejected from review, if it was. # Reason for the survey being rejected. Only present if the survey state is 'rejected'.
+ "explanation": "A String", # A human-readable explanation of what was wrong with the survey.
+ "type": "A String", # Which category of rejection this was. See the GCS Help Center for additional details on each category.
+ },
},
"requestId": "A String", # Unique request ID used for logging and debugging. Please include in any error reporting or troubleshooting requests.
}</pre>
@@ -582,6 +602,10 @@
},
],
"wantedResponseCount": 42, # Number of responses desired for the survey.
+ "rejectionReason": { # Message representing why the survey was rejected from review, if it was. # Reason for the survey being rejected. Only present if the survey state is 'rejected'.
+ "explanation": "A String", # A human-readable explanation of what was wrong with the survey.
+ "type": "A String", # Which category of rejection this was. See the GCS Help Center for additional details on each category.
+ },
},
"requestId": "A String", # Unique request ID used for logging and debugging. Please include in any error reporting or troubleshooting requests.
}</pre>
@@ -659,6 +683,10 @@
},
],
"wantedResponseCount": 42, # Number of responses desired for the survey.
+ "rejectionReason": { # Message representing why the survey was rejected from review, if it was. # Reason for the survey being rejected. Only present if the survey state is 'rejected'.
+ "explanation": "A String", # A human-readable explanation of what was wrong with the survey.
+ "type": "A String", # Which category of rejection this was. See the GCS Help Center for additional details on each category.
+ },
}
@@ -728,6 +756,10 @@
},
],
"wantedResponseCount": 42, # Number of responses desired for the survey.
+ "rejectionReason": { # Message representing why the survey was rejected from review, if it was. # Reason for the survey being rejected. Only present if the survey state is 'rejected'.
+ "explanation": "A String", # A human-readable explanation of what was wrong with the survey.
+ "type": "A String", # Which category of rejection this was. See the GCS Help Center for additional details on each category.
+ },
}</pre>
</div>
diff --git a/docs/dyn/content_v2.orders.html b/docs/dyn/content_v2.orders.html
index f387df3..84b800e 100644
--- a/docs/dyn/content_v2.orders.html
+++ b/docs/dyn/content_v2.orders.html
@@ -523,6 +523,10 @@
},
"type": "A String", # The type of instrument (VISA, Mastercard, etc).
},
+ "shippingCost": { # The total cost of shipping for all items.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
"acknowledged": True or False, # Whether the order was acknowledged.
"paymentStatus": "A String", # The status of the payment.
"merchantId": "A String",
@@ -551,10 +555,7 @@
},
},
"placedDate": "A String", # The date when the order was placed, in ISO 8601 format.
- "shippingCost": { # The total cost of shipping for all items.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
- },
+ "channelType": "A String", # The channel type of the order: "purchaseOnGoogle" or "googleExpress".
"lineItems": [ # Line items that are ordered.
{
"product": { # Product data from the time of the order placement.
@@ -747,6 +748,10 @@
},
"type": "A String", # The type of instrument (VISA, Mastercard, etc).
},
+ "shippingCost": { # The total cost of shipping for all items.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
"acknowledged": True or False, # Whether the order was acknowledged.
"paymentStatus": "A String", # The status of the payment.
"merchantId": "A String",
@@ -775,10 +780,7 @@
},
},
"placedDate": "A String", # The date when the order was placed, in ISO 8601 format.
- "shippingCost": { # The total cost of shipping for all items.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
- },
+ "channelType": "A String", # The channel type of the order: "purchaseOnGoogle" or "googleExpress".
"lineItems": [ # Line items that are ordered.
{
"product": { # Product data from the time of the order placement.
@@ -969,6 +971,10 @@
},
"type": "A String", # The type of instrument (VISA, Mastercard, etc).
},
+ "shippingCost": { # The total cost of shipping for all items.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
"acknowledged": True or False, # Whether the order was acknowledged.
"paymentStatus": "A String", # The status of the payment.
"merchantId": "A String",
@@ -997,10 +1003,7 @@
},
},
"placedDate": "A String", # The date when the order was placed, in ISO 8601 format.
- "shippingCost": { # The total cost of shipping for all items.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
- },
+ "channelType": "A String", # The channel type of the order: "purchaseOnGoogle" or "googleExpress".
"lineItems": [ # Line items that are ordered.
{
"product": { # Product data from the time of the order placement.
@@ -1338,6 +1341,10 @@
},
"type": "A String", # The type of instrument (VISA, Mastercard, etc).
},
+ "shippingCost": { # The total cost of shipping for all items.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
"acknowledged": True or False, # Whether the order was acknowledged.
"paymentStatus": "A String", # The status of the payment.
"merchantId": "A String",
@@ -1366,10 +1373,7 @@
},
},
"placedDate": "A String", # The date when the order was placed, in ISO 8601 format.
- "shippingCost": { # The total cost of shipping for all items.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
- },
+ "channelType": "A String", # The channel type of the order: "purchaseOnGoogle" or "googleExpress".
"lineItems": [ # Line items that are ordered.
{
"product": { # Product data from the time of the order placement.
diff --git a/docs/dyn/dataflow_v1b3.projects.jobs.html b/docs/dyn/dataflow_v1b3.projects.jobs.html
index 28cb4e3..40bf964 100644
--- a/docs/dyn/dataflow_v1b3.projects.jobs.html
+++ b/docs/dyn/dataflow_v1b3.projects.jobs.html
@@ -142,6 +142,7 @@
"experiments": [ # The list of experiments to enable.
"A String",
],
+ "serviceAccountEmail": "A String", # Identity to run virtual machines as. Defaults to the default account.
"sdkPipelineOptions": { # The Dataflow SDK pipeline options specified by the user. These options are passed through the service and are used to recreate the SDK pipeline options on the worker in a language agnostic and platform independent way.
"a_key": "", # Properties of the object.
},
@@ -283,6 +284,7 @@
"experiments": [ # The list of experiments to enable.
"A String",
],
+ "serviceAccountEmail": "A String", # Identity to run virtual machines as. Defaults to the default account.
"sdkPipelineOptions": { # The Dataflow SDK pipeline options specified by the user. These options are passed through the service and are used to recreate the SDK pipeline options on the worker in a language agnostic and platform independent way.
"a_key": "", # Properties of the object.
},
@@ -431,6 +433,7 @@
"experiments": [ # The list of experiments to enable.
"A String",
],
+ "serviceAccountEmail": "A String", # Identity to run virtual machines as. Defaults to the default account.
"sdkPipelineOptions": { # The Dataflow SDK pipeline options specified by the user. These options are passed through the service and are used to recreate the SDK pipeline options on the worker in a language agnostic and platform independent way.
"a_key": "", # Properties of the object.
},
@@ -622,6 +625,7 @@
"experiments": [ # The list of experiments to enable.
"A String",
],
+ "serviceAccountEmail": "A String", # Identity to run virtual machines as. Defaults to the default account.
"sdkPipelineOptions": { # The Dataflow SDK pipeline options specified by the user. These options are passed through the service and are used to recreate the SDK pipeline options on the worker in a language agnostic and platform independent way.
"a_key": "", # Properties of the object.
},
@@ -783,6 +787,7 @@
"experiments": [ # The list of experiments to enable.
"A String",
],
+ "serviceAccountEmail": "A String", # Identity to run virtual machines as. Defaults to the default account.
"sdkPipelineOptions": { # The Dataflow SDK pipeline options specified by the user. These options are passed through the service and are used to recreate the SDK pipeline options on the worker in a language agnostic and platform independent way.
"a_key": "", # Properties of the object.
},
@@ -922,6 +927,7 @@
"experiments": [ # The list of experiments to enable.
"A String",
],
+ "serviceAccountEmail": "A String", # Identity to run virtual machines as. Defaults to the default account.
"sdkPipelineOptions": { # The Dataflow SDK pipeline options specified by the user. These options are passed through the service and are used to recreate the SDK pipeline options on the worker in a language agnostic and platform independent way.
"a_key": "", # Properties of the object.
},
diff --git a/docs/dyn/dataflow_v1b3.projects.templates.html b/docs/dyn/dataflow_v1b3.projects.templates.html
index 51148ab..27e4783 100644
--- a/docs/dyn/dataflow_v1b3.projects.templates.html
+++ b/docs/dyn/dataflow_v1b3.projects.templates.html
@@ -124,6 +124,7 @@
"experiments": [ # The list of experiments to enable.
"A String",
],
+ "serviceAccountEmail": "A String", # Identity to run virtual machines as. Defaults to the default account.
"sdkPipelineOptions": { # The Dataflow SDK pipeline options specified by the user. These options are passed through the service and are used to recreate the SDK pipeline options on the worker in a language agnostic and platform independent way.
"a_key": "", # Properties of the object.
},
diff --git a/docs/dyn/deploymentmanager_v2.deployments.html b/docs/dyn/deploymentmanager_v2.deployments.html
index 1142e08..ce846ee 100644
--- a/docs/dyn/deploymentmanager_v2.deployments.html
+++ b/docs/dyn/deploymentmanager_v2.deployments.html
@@ -84,6 +84,9 @@
<code><a href="#get">get(project, deployment)</a></code></p>
<p class="firstline">Gets information about a specific deployment.</p>
<p class="toc_element">
+ <code><a href="#getIamPolicy">getIamPolicy(project, resource)</a></code></p>
+<p class="firstline">Gets the access control policy for a resource. May be empty if no such policy or resource exists.</p>
+<p class="toc_element">
<code><a href="#insert">insert(project, body, preview=None)</a></code></p>
<p class="firstline">Creates a deployment and all of the resources described by the deployment manifest.</p>
<p class="toc_element">
@@ -96,9 +99,15 @@
<code><a href="#patch">patch(project, deployment, body, deletePolicy=None, createPolicy=None, preview=None)</a></code></p>
<p class="firstline">Updates a deployment and all of the resources described by the deployment manifest. This method supports patch semantics.</p>
<p class="toc_element">
+ <code><a href="#setIamPolicy">setIamPolicy(project, resource, body)</a></code></p>
+<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.</p>
+<p class="toc_element">
<code><a href="#stop">stop(project, deployment, body)</a></code></p>
<p class="firstline">Stops an ongoing operation. This does not roll back any work that has already been completed, but prevents any new work from being started.</p>
<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<p class="toc_element">
<code><a href="#update">update(project, deployment, body, deletePolicy=None, createPolicy=None, preview=None)</a></code></p>
<p class="firstline">Updates a deployment and all of the resources described by the deployment manifest.</p>
<h3>Method Details</h3>
@@ -323,6 +332,101 @@
</div>
<div class="method">
+ <code class="details" id="getIamPolicy">getIamPolicy(project, resource)</code>
+ <pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+
+Returns:
+ An object of the form:
+
+ { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
+ #
+ #
+ #
+ # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.
+ #
+ # **Example**
+ #
+ # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
+ #
+ # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
+ "auditConfigs": [ # Specifies audit logging configs for "data access". "data access": generally refers to data reads/writes and admin reads. "admin activity": generally refers to admin writes.
+ #
+ # Note: `AuditConfig` doesn't apply to "admin activity", which always enables audit logging.
+ { # Enables "data access" audit logging for a service and specifies a list of members that are log-exempted.
+ "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit logging for the `service` specified above. Follows the same format of Binding.members.
+ "A String",
+ ],
+ "service": "A String", # Specifies a service that will be enabled for "data access" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
+ },
+ ],
+ "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
+ { # A rule to be applied in a Policy.
+ "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
+ { # Specifies what kind of log the caller must write
+ "counter": { # Options for counters # Counter options.
+ "field": "A String", # The field value to attribute.
+ "metric": "A String", # The metric to update.
+ },
+ },
+ ],
+ "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
+ "A String",
+ ],
+ "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
+ "A String",
+ ],
+ "action": "A String", # Required
+ "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
+ "A String",
+ ],
+ "conditions": [ # Additional restrictions that must be met
+ { # A condition to be met.
+ "iam": "A String", # Trusted attributes supplied by the IAM system.
+ "svc": "A String", # Trusted attributes discharged by the service.
+ "value": "A String", # DEPRECATED. Use 'values' instead.
+ "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
+ "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
+ "A String",
+ ],
+ "op": "A String", # An operator to apply the subject with.
+ },
+ ],
+ "description": "A String", # Human-readable description of the rule.
+ },
+ ],
+ "version": 42, # Version of the `Policy`. The default version is 0.
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
+ #
+ # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
+ "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
+ { # Associates `members` with a `role`.
+ "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
+ #
+ # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
+ #
+ # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
+ #
+ # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.
+ #
+ # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
+ #
+ # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
+ #
+ # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
+ "A String",
+ ],
+ },
+ ],
+ "iamOwned": True or False,
+ }</pre>
+</div>
+
+<div class="method">
<code class="details" id="insert">insert(project, body, preview=None)</code>
<pre>Creates a deployment and all of the resources described by the deployment manifest.
@@ -744,6 +848,187 @@
</div>
<div class="method">
+ <code class="details" id="setIamPolicy">setIamPolicy(project, resource, body)</code>
+ <pre>Sets the access control policy on the specified resource. Replaces any existing policy.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
+ #
+ #
+ #
+ # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.
+ #
+ # **Example**
+ #
+ # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
+ #
+ # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
+ "auditConfigs": [ # Specifies audit logging configs for "data access". "data access": generally refers to data reads/writes and admin reads. "admin activity": generally refers to admin writes.
+ #
+ # Note: `AuditConfig` doesn't apply to "admin activity", which always enables audit logging.
+ { # Enables "data access" audit logging for a service and specifies a list of members that are log-exempted.
+ "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit logging for the `service` specified above. Follows the same format of Binding.members.
+ "A String",
+ ],
+ "service": "A String", # Specifies a service that will be enabled for "data access" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
+ },
+ ],
+ "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
+ { # A rule to be applied in a Policy.
+ "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
+ { # Specifies what kind of log the caller must write
+ "counter": { # Options for counters # Counter options.
+ "field": "A String", # The field value to attribute.
+ "metric": "A String", # The metric to update.
+ },
+ },
+ ],
+ "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
+ "A String",
+ ],
+ "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
+ "A String",
+ ],
+ "action": "A String", # Required
+ "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
+ "A String",
+ ],
+ "conditions": [ # Additional restrictions that must be met
+ { # A condition to be met.
+ "iam": "A String", # Trusted attributes supplied by the IAM system.
+ "svc": "A String", # Trusted attributes discharged by the service.
+ "value": "A String", # DEPRECATED. Use 'values' instead.
+ "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
+ "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
+ "A String",
+ ],
+ "op": "A String", # An operator to apply the subject with.
+ },
+ ],
+ "description": "A String", # Human-readable description of the rule.
+ },
+ ],
+ "version": 42, # Version of the `Policy`. The default version is 0.
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
+ #
+ # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
+ "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
+ { # Associates `members` with a `role`.
+ "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
+ #
+ # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
+ #
+ # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
+ #
+ # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.
+ #
+ # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
+ #
+ # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
+ #
+ # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
+ "A String",
+ ],
+ },
+ ],
+ "iamOwned": True or False,
+}
+
+
+Returns:
+ An object of the form:
+
+ { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
+ #
+ #
+ #
+ # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.
+ #
+ # **Example**
+ #
+ # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
+ #
+ # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
+ "auditConfigs": [ # Specifies audit logging configs for "data access". "data access": generally refers to data reads/writes and admin reads. "admin activity": generally refers to admin writes.
+ #
+ # Note: `AuditConfig` doesn't apply to "admin activity", which always enables audit logging.
+ { # Enables "data access" audit logging for a service and specifies a list of members that are log-exempted.
+ "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit logging for the `service` specified above. Follows the same format of Binding.members.
+ "A String",
+ ],
+ "service": "A String", # Specifies a service that will be enabled for "data access" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
+ },
+ ],
+ "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
+ { # A rule to be applied in a Policy.
+ "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
+ { # Specifies what kind of log the caller must write
+ "counter": { # Options for counters # Counter options.
+ "field": "A String", # The field value to attribute.
+ "metric": "A String", # The metric to update.
+ },
+ },
+ ],
+ "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
+ "A String",
+ ],
+ "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
+ "A String",
+ ],
+ "action": "A String", # Required
+ "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
+ "A String",
+ ],
+ "conditions": [ # Additional restrictions that must be met
+ { # A condition to be met.
+ "iam": "A String", # Trusted attributes supplied by the IAM system.
+ "svc": "A String", # Trusted attributes discharged by the service.
+ "value": "A String", # DEPRECATED. Use 'values' instead.
+ "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
+ "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
+ "A String",
+ ],
+ "op": "A String", # An operator to apply the subject with.
+ },
+ ],
+ "description": "A String", # Human-readable description of the rule.
+ },
+ ],
+ "version": 42, # Version of the `Policy`. The default version is 0.
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
+ #
+ # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
+ "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
+ { # Associates `members` with a `role`.
+ "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
+ #
+ # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
+ #
+ # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
+ #
+ # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.
+ #
+ # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
+ #
+ # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
+ #
+ # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
+ "A String",
+ ],
+ },
+ ],
+ "iamOwned": True or False,
+ }</pre>
+</div>
+
+<div class="method">
<code class="details" id="stop">stop(project, deployment, body)</code>
<pre>Stops an ongoing operation. This does not roll back any work that has already been completed, but prevents any new work from being started.
@@ -811,6 +1096,33 @@
</div>
<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+<div class="method">
<code class="details" id="update">update(project, deployment, body, deletePolicy=None, createPolicy=None, preview=None)</code>
<pre>Updates a deployment and all of the resources described by the deployment manifest.
diff --git a/docs/dyn/deploymentmanager_v2.resources.html b/docs/dyn/deploymentmanager_v2.resources.html
index 50ad2f0..ad8b911 100644
--- a/docs/dyn/deploymentmanager_v2.resources.html
+++ b/docs/dyn/deploymentmanager_v2.resources.html
@@ -97,8 +97,11 @@
An object of the form:
{
+ "accessControl": { # The access controls set on the resource. # The Access Control Policy set on this resource.
+ "gcpIamPolicy": "A String", # The GCP IAM Policy to set on the resource.
+ },
"finalProperties": "A String", # [Output Only] The evaluated properties of the resource with references expanded. Returned as serialized YAML.
- "updateTime": "A String", # [Output Only] Timestamp when the resource was updated, in RFC3339 text format .
+ "properties": "A String", # [Output Only] The current properties of the resource before any references have been filled in. Returned as serialized YAML.
"name": "A String", # [Output Only] The name of the resource as it appears in the YAML config.
"warnings": [ # [Output Only] If warning messages are generated during processing of this resource, this field will be populated.
{
@@ -115,6 +118,9 @@
],
"url": "A String", # [Output Only] The URL of the actual resource.
"update": { # [Output Only] If Deployment Manager is currently updating or previewing an update to this resource, the updated configuration appears here.
+ "accessControl": { # The access controls set on the resource. # The Access Control Policy to set on this resource after updating the resource itself.
+ "gcpIamPolicy": "A String", # The GCP IAM Policy to set on the resource.
+ },
"finalProperties": "A String", # [Output Only] The expanded properties of the resource with reference values expanded. Returned as serialized YAML.
"warnings": [ # [Output Only] If warning messages are generated during processing of this resource, this field will be populated.
{
@@ -143,11 +149,11 @@
},
"properties": "A String", # [Output Only] The set of updated properties for this resource, before references are expanded. Returned as serialized YAML.
},
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "insertTime": "A String", # [Output Only] Timestamp when the resource was created or acquired, in RFC3339 text format .
+ "updateTime": "A String", # [Output Only] Timestamp when the resource was updated, in RFC3339 text format .
"manifest": "A String", # [Output Only] URL of the manifest representing the current configuration of this resource.
+ "insertTime": "A String", # [Output Only] Timestamp when the resource was created or acquired, in RFC3339 text format .
"type": "A String", # [Output Only] The type of the resource, for example compute.v1.instance, or cloudfunctions.v1beta1.function.
- "properties": "A String", # [Output Only] The current properties of the resource before any references have been filled in. Returned as serialized YAML.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
}</pre>
</div>
@@ -177,8 +183,11 @@
"nextPageToken": "A String", # A token used to continue a truncated list request.
"resources": [ # Resources contained in this list response.
{
+ "accessControl": { # The access controls set on the resource. # The Access Control Policy set on this resource.
+ "gcpIamPolicy": "A String", # The GCP IAM Policy to set on the resource.
+ },
"finalProperties": "A String", # [Output Only] The evaluated properties of the resource with references expanded. Returned as serialized YAML.
- "updateTime": "A String", # [Output Only] Timestamp when the resource was updated, in RFC3339 text format .
+ "properties": "A String", # [Output Only] The current properties of the resource before any references have been filled in. Returned as serialized YAML.
"name": "A String", # [Output Only] The name of the resource as it appears in the YAML config.
"warnings": [ # [Output Only] If warning messages are generated during processing of this resource, this field will be populated.
{
@@ -195,6 +204,9 @@
],
"url": "A String", # [Output Only] The URL of the actual resource.
"update": { # [Output Only] If Deployment Manager is currently updating or previewing an update to this resource, the updated configuration appears here.
+ "accessControl": { # The access controls set on the resource. # The Access Control Policy to set on this resource after updating the resource itself.
+ "gcpIamPolicy": "A String", # The GCP IAM Policy to set on the resource.
+ },
"finalProperties": "A String", # [Output Only] The expanded properties of the resource with reference values expanded. Returned as serialized YAML.
"warnings": [ # [Output Only] If warning messages are generated during processing of this resource, this field will be populated.
{
@@ -223,11 +235,11 @@
},
"properties": "A String", # [Output Only] The set of updated properties for this resource, before references are expanded. Returned as serialized YAML.
},
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "insertTime": "A String", # [Output Only] Timestamp when the resource was created or acquired, in RFC3339 text format .
+ "updateTime": "A String", # [Output Only] Timestamp when the resource was updated, in RFC3339 text format .
"manifest": "A String", # [Output Only] URL of the manifest representing the current configuration of this resource.
+ "insertTime": "A String", # [Output Only] Timestamp when the resource was created or acquired, in RFC3339 text format .
"type": "A String", # [Output Only] The type of the resource, for example compute.v1.instance, or cloudfunctions.v1beta1.function.
- "properties": "A String", # [Output Only] The current properties of the resource before any references have been filled in. Returned as serialized YAML.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
},
],
}</pre>
diff --git a/docs/dyn/doubleclickbidmanager_v1.html b/docs/dyn/doubleclickbidmanager_v1.html
index 2ab1781..0bc014c 100644
--- a/docs/dyn/doubleclickbidmanager_v1.html
+++ b/docs/dyn/doubleclickbidmanager_v1.html
@@ -90,9 +90,9 @@
<p class="firstline">Returns the reports Resource.</p>
<p class="toc_element">
- <code><a href="doubleclickbidmanager_v1.rubicon.html">rubicon()</a></code>
+ <code><a href="doubleclickbidmanager_v1.sdf.html">sdf()</a></code>
</p>
-<p class="firstline">Returns the rubicon Resource.</p>
+<p class="firstline">Returns the sdf Resource.</p>
<p class="toc_element">
<code><a href="#new_batch_http_request">new_batch_http_request()</a></code></p>
diff --git a/docs/dyn/doubleclickbidmanager_v1.sdf.html b/docs/dyn/doubleclickbidmanager_v1.sdf.html
new file mode 100644
index 0000000..ca4f7bd
--- /dev/null
+++ b/docs/dyn/doubleclickbidmanager_v1.sdf.html
@@ -0,0 +1,112 @@
+<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="doubleclickbidmanager_v1.html">DoubleClick Bid Manager API</a> . <a href="doubleclickbidmanager_v1.sdf.html">sdf</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#download">download(body)</a></code></p>
+<p class="firstline">Retrieves entities in SDF format.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="download">download(body)</code>
+ <pre>Retrieves entities in SDF format.
+
+Args:
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Request to fetch stored insertion orders, line items, TrueView ad groups and ads.
+ "filterType": "A String", # Filter type used to filter line items to fetch.
+ "version": "A String", # SDF Version (column names, types, order) in which the entities will be returned. Default to 3.
+ "fileTypes": [ # File types that will be returned.
+ "A String",
+ ],
+ "filterIds": [ # The IDs of the specified filter type. This is used to filter entities to fetch. At least one ID must be specified. Only one ID is allowed for the ADVERTISER_ID filter type. For INSERTION_ORDER_ID or LINE_ITEM_ID filter types all IDs must be from the same Advertiser.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # Download response.
+ "lineItems": "A String", # Retrieved line items in SDF format.
+ "insertionOrders": "A String", # Retrieved insertion orders in SDF format.
+ "ads": "A String", # Retrieved ads in SDF format.
+ "adGroups": "A String", # Retrieved ad groups in SDF format.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/drive_v3.about.html b/docs/dyn/drive_v3.about.html
index 18c382e..f570fea 100644
--- a/docs/dyn/drive_v3.about.html
+++ b/docs/dyn/drive_v3.about.html
@@ -88,7 +88,7 @@
An object of the form:
{ # Information about the user, the user's Drive, and system capabilities.
- "kind": "drive#about", # This is always drive#about.
+ "kind": "drive#about", # Identifies what kind of resource this is. Value: the fixed string "drive#about".
"maxUploadSize": "A String", # The maximum upload size in bytes.
"maxImportSizes": { # A map of maximum import sizes by MIME type, in bytes.
"a_key": "A String",
@@ -115,7 +115,7 @@
},
"user": { # Information about a Drive user. # The authenticated user.
"me": True or False, # Whether this user is the requesting user.
- "kind": "drive#user", # This is always drive#user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
diff --git a/docs/dyn/drive_v3.changes.html b/docs/dyn/drive_v3.changes.html
index 0638c5b..68dc542 100644
--- a/docs/dyn/drive_v3.changes.html
+++ b/docs/dyn/drive_v3.changes.html
@@ -97,7 +97,7 @@
An object of the form:
{
- "kind": "drive#startPageToken", # This is always drive#startPageToken.
+ "kind": "drive#startPageToken", # Identifies what kind of resource this is. Value: the fixed string "drive#startPageToken".
"startPageToken": "A String", # The starting page token for listing changes.
}</pre>
</div>
@@ -118,10 +118,10 @@
{ # A list of changes for a user.
"nextPageToken": "A String", # The page token for the next page of changes. This will be absent if the end of the current changes list has been reached.
- "kind": "drive#changeList", # This is always drive#changeList.
+ "kind": "drive#changeList", # Identifies what kind of resource this is. Value: the fixed string "drive#changeList".
"changes": [ # The page of changes.
{ # A change to a file.
- "kind": "drive#change", # This is always drive#change.
+ "kind": "drive#change", # Identifies what kind of resource this is. Value: the fixed string "drive#change".
"removed": True or False, # Whether the file has been removed from the view of the changes list, for example by deletion or lost access.
"time": "A String", # The time of this change (RFC 3339 date-time).
"file": { # The metadata for a file. # The updated state of the file. Present if the file has not been removed.
@@ -138,7 +138,7 @@
"id": "A String", # The ID of the file.
"sharingUser": { # Information about a Drive user. # The user who shared the file with the requesting user, if applicable.
"me": True or False, # Whether this user is the requesting user.
- "kind": "drive#user", # This is always drive#user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
@@ -152,7 +152,7 @@
},
"lastModifyingUser": { # Information about a Drive user. # The last user to modify the file.
"me": True or False, # Whether this user is the requesting user.
- "kind": "drive#user", # This is always drive#user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
@@ -184,7 +184,7 @@
"domain": "A String", # The domain to which this permission refers.
"displayName": "A String", # A displayable name for users, groups or domains.
"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
- "kind": "drive#permission", # This is always drive#permission.
+ "kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"photoLink": "A String", # A link to the user's profile photo, if available.
"role": "A String", # The role granted by this permission. Valid values are:
@@ -212,7 +212,7 @@
"owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner.
{ # Information about a Drive user.
"me": True or False, # Whether this user is the requesting user.
- "kind": "drive#user", # This is always drive#user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
@@ -254,7 +254,7 @@
"whiteBalance": "A String", # The white balance mode used to create the photo.
"cameraModel": "A String", # The model of the camera used to create the photo.
},
- "kind": "drive#file", # This is always drive#file.
+ "kind": "drive#file", # Identifies what kind of resource this is. Value: the fixed string "drive#file".
"name": "A String", # The name of the file. This is not necessarily unique within a folder.
"webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Drive.
"spaces": [ # The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
diff --git a/docs/dyn/drive_v3.comments.html b/docs/dyn/drive_v3.comments.html
index 628410e..a39c587 100644
--- a/docs/dyn/drive_v3.comments.html
+++ b/docs/dyn/drive_v3.comments.html
@@ -104,11 +104,11 @@
{ # A comment on a file.
"resolved": True or False, # Whether the comment has been resolved by one of its replies.
- "kind": "drive#comment", # This is always drive#comment.
+ "kind": "drive#comment", # Identifies what kind of resource this is. Value: the fixed string "drive#comment".
"modifiedTime": "A String", # The last time the comment or any of its replies was modified (RFC 3339 date-time).
"author": { # Information about a Drive user. # The user who created the comment.
"me": True or False, # Whether this user is the requesting user.
- "kind": "drive#user", # This is always drive#user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
@@ -124,11 +124,11 @@
"content": "A String", # The plain text content of the comment. This field is used for setting the content, while htmlContent should be displayed.
"replies": [ # The full list of replies to the comment in chronological order.
{ # A reply to a comment on a file.
- "kind": "drive#reply", # This is always drive#reply.
+ "kind": "drive#reply", # Identifies what kind of resource this is. Value: the fixed string "drive#reply".
"modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
"author": { # Information about a Drive user. # The user who created the reply.
"me": True or False, # Whether this user is the requesting user.
- "kind": "drive#user", # This is always drive#user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
@@ -154,11 +154,11 @@
{ # A comment on a file.
"resolved": True or False, # Whether the comment has been resolved by one of its replies.
- "kind": "drive#comment", # This is always drive#comment.
+ "kind": "drive#comment", # Identifies what kind of resource this is. Value: the fixed string "drive#comment".
"modifiedTime": "A String", # The last time the comment or any of its replies was modified (RFC 3339 date-time).
"author": { # Information about a Drive user. # The user who created the comment.
"me": True or False, # Whether this user is the requesting user.
- "kind": "drive#user", # This is always drive#user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
@@ -174,11 +174,11 @@
"content": "A String", # The plain text content of the comment. This field is used for setting the content, while htmlContent should be displayed.
"replies": [ # The full list of replies to the comment in chronological order.
{ # A reply to a comment on a file.
- "kind": "drive#reply", # This is always drive#reply.
+ "kind": "drive#reply", # Identifies what kind of resource this is. Value: the fixed string "drive#reply".
"modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
"author": { # Information about a Drive user. # The user who created the reply.
"me": True or False, # Whether this user is the requesting user.
- "kind": "drive#user", # This is always drive#user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
@@ -223,11 +223,11 @@
{ # A comment on a file.
"resolved": True or False, # Whether the comment has been resolved by one of its replies.
- "kind": "drive#comment", # This is always drive#comment.
+ "kind": "drive#comment", # Identifies what kind of resource this is. Value: the fixed string "drive#comment".
"modifiedTime": "A String", # The last time the comment or any of its replies was modified (RFC 3339 date-time).
"author": { # Information about a Drive user. # The user who created the comment.
"me": True or False, # Whether this user is the requesting user.
- "kind": "drive#user", # This is always drive#user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
@@ -243,11 +243,11 @@
"content": "A String", # The plain text content of the comment. This field is used for setting the content, while htmlContent should be displayed.
"replies": [ # The full list of replies to the comment in chronological order.
{ # A reply to a comment on a file.
- "kind": "drive#reply", # This is always drive#reply.
+ "kind": "drive#reply", # Identifies what kind of resource this is. Value: the fixed string "drive#reply".
"modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
"author": { # Information about a Drive user. # The user who created the reply.
"me": True or False, # Whether this user is the requesting user.
- "kind": "drive#user", # This is always drive#user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
@@ -284,15 +284,15 @@
{ # A list of comments on a file.
"nextPageToken": "A String", # The page token for the next page of comments. This will be absent if the end of the comments list has been reached.
- "kind": "drive#commentList", # This is always drive#commentList.
+ "kind": "drive#commentList", # Identifies what kind of resource this is. Value: the fixed string "drive#commentList".
"comments": [ # The page of comments.
{ # A comment on a file.
"resolved": True or False, # Whether the comment has been resolved by one of its replies.
- "kind": "drive#comment", # This is always drive#comment.
+ "kind": "drive#comment", # Identifies what kind of resource this is. Value: the fixed string "drive#comment".
"modifiedTime": "A String", # The last time the comment or any of its replies was modified (RFC 3339 date-time).
"author": { # Information about a Drive user. # The user who created the comment.
"me": True or False, # Whether this user is the requesting user.
- "kind": "drive#user", # This is always drive#user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
@@ -308,11 +308,11 @@
"content": "A String", # The plain text content of the comment. This field is used for setting the content, while htmlContent should be displayed.
"replies": [ # The full list of replies to the comment in chronological order.
{ # A reply to a comment on a file.
- "kind": "drive#reply", # This is always drive#reply.
+ "kind": "drive#reply", # Identifies what kind of resource this is. Value: the fixed string "drive#reply".
"modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
"author": { # Information about a Drive user. # The user who created the reply.
"me": True or False, # Whether this user is the requesting user.
- "kind": "drive#user", # This is always drive#user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
@@ -361,11 +361,11 @@
{ # A comment on a file.
"resolved": True or False, # Whether the comment has been resolved by one of its replies.
- "kind": "drive#comment", # This is always drive#comment.
+ "kind": "drive#comment", # Identifies what kind of resource this is. Value: the fixed string "drive#comment".
"modifiedTime": "A String", # The last time the comment or any of its replies was modified (RFC 3339 date-time).
"author": { # Information about a Drive user. # The user who created the comment.
"me": True or False, # Whether this user is the requesting user.
- "kind": "drive#user", # This is always drive#user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
@@ -381,11 +381,11 @@
"content": "A String", # The plain text content of the comment. This field is used for setting the content, while htmlContent should be displayed.
"replies": [ # The full list of replies to the comment in chronological order.
{ # A reply to a comment on a file.
- "kind": "drive#reply", # This is always drive#reply.
+ "kind": "drive#reply", # Identifies what kind of resource this is. Value: the fixed string "drive#reply".
"modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
"author": { # Information about a Drive user. # The user who created the reply.
"me": True or False, # Whether this user is the requesting user.
- "kind": "drive#user", # This is always drive#user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
@@ -411,11 +411,11 @@
{ # A comment on a file.
"resolved": True or False, # Whether the comment has been resolved by one of its replies.
- "kind": "drive#comment", # This is always drive#comment.
+ "kind": "drive#comment", # Identifies what kind of resource this is. Value: the fixed string "drive#comment".
"modifiedTime": "A String", # The last time the comment or any of its replies was modified (RFC 3339 date-time).
"author": { # Information about a Drive user. # The user who created the comment.
"me": True or False, # Whether this user is the requesting user.
- "kind": "drive#user", # This is always drive#user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
@@ -431,11 +431,11 @@
"content": "A String", # The plain text content of the comment. This field is used for setting the content, while htmlContent should be displayed.
"replies": [ # The full list of replies to the comment in chronological order.
{ # A reply to a comment on a file.
- "kind": "drive#reply", # This is always drive#reply.
+ "kind": "drive#reply", # Identifies what kind of resource this is. Value: the fixed string "drive#reply".
"modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
"author": { # Information about a Drive user. # The user who created the reply.
"me": True or False, # Whether this user is the requesting user.
- "kind": "drive#user", # This is always drive#user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
diff --git a/docs/dyn/drive_v3.files.html b/docs/dyn/drive_v3.files.html
index b0b5d02..84dc17c 100644
--- a/docs/dyn/drive_v3.files.html
+++ b/docs/dyn/drive_v3.files.html
@@ -140,7 +140,7 @@
"id": "A String", # The ID of the file.
"sharingUser": { # Information about a Drive user. # The user who shared the file with the requesting user, if applicable.
"me": True or False, # Whether this user is the requesting user.
- "kind": "drive#user", # This is always drive#user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
@@ -154,7 +154,7 @@
},
"lastModifyingUser": { # Information about a Drive user. # The last user to modify the file.
"me": True or False, # Whether this user is the requesting user.
- "kind": "drive#user", # This is always drive#user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
@@ -186,7 +186,7 @@
"domain": "A String", # The domain to which this permission refers.
"displayName": "A String", # A displayable name for users, groups or domains.
"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
- "kind": "drive#permission", # This is always drive#permission.
+ "kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"photoLink": "A String", # A link to the user's profile photo, if available.
"role": "A String", # The role granted by this permission. Valid values are:
@@ -214,7 +214,7 @@
"owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner.
{ # Information about a Drive user.
"me": True or False, # Whether this user is the requesting user.
- "kind": "drive#user", # This is always drive#user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
@@ -256,7 +256,7 @@
"whiteBalance": "A String", # The white balance mode used to create the photo.
"cameraModel": "A String", # The model of the camera used to create the photo.
},
- "kind": "drive#file", # This is always drive#file.
+ "kind": "drive#file", # Identifies what kind of resource this is. Value: the fixed string "drive#file".
"name": "A String", # The name of the file. This is not necessarily unique within a folder.
"webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Drive.
"spaces": [ # The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
@@ -296,7 +296,7 @@
"id": "A String", # The ID of the file.
"sharingUser": { # Information about a Drive user. # The user who shared the file with the requesting user, if applicable.
"me": True or False, # Whether this user is the requesting user.
- "kind": "drive#user", # This is always drive#user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
@@ -310,7 +310,7 @@
},
"lastModifyingUser": { # Information about a Drive user. # The last user to modify the file.
"me": True or False, # Whether this user is the requesting user.
- "kind": "drive#user", # This is always drive#user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
@@ -342,7 +342,7 @@
"domain": "A String", # The domain to which this permission refers.
"displayName": "A String", # A displayable name for users, groups or domains.
"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
- "kind": "drive#permission", # This is always drive#permission.
+ "kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"photoLink": "A String", # A link to the user's profile photo, if available.
"role": "A String", # The role granted by this permission. Valid values are:
@@ -370,7 +370,7 @@
"owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner.
{ # Information about a Drive user.
"me": True or False, # Whether this user is the requesting user.
- "kind": "drive#user", # This is always drive#user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
@@ -412,7 +412,7 @@
"whiteBalance": "A String", # The white balance mode used to create the photo.
"cameraModel": "A String", # The model of the camera used to create the photo.
},
- "kind": "drive#file", # This is always drive#file.
+ "kind": "drive#file", # Identifies what kind of resource this is. Value: the fixed string "drive#file".
"name": "A String", # The name of the file. This is not necessarily unique within a folder.
"webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Drive.
"spaces": [ # The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
@@ -454,7 +454,7 @@
"id": "A String", # The ID of the file.
"sharingUser": { # Information about a Drive user. # The user who shared the file with the requesting user, if applicable.
"me": True or False, # Whether this user is the requesting user.
- "kind": "drive#user", # This is always drive#user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
@@ -468,7 +468,7 @@
},
"lastModifyingUser": { # Information about a Drive user. # The last user to modify the file.
"me": True or False, # Whether this user is the requesting user.
- "kind": "drive#user", # This is always drive#user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
@@ -500,7 +500,7 @@
"domain": "A String", # The domain to which this permission refers.
"displayName": "A String", # A displayable name for users, groups or domains.
"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
- "kind": "drive#permission", # This is always drive#permission.
+ "kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"photoLink": "A String", # A link to the user's profile photo, if available.
"role": "A String", # The role granted by this permission. Valid values are:
@@ -528,7 +528,7 @@
"owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner.
{ # Information about a Drive user.
"me": True or False, # Whether this user is the requesting user.
- "kind": "drive#user", # This is always drive#user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
@@ -570,7 +570,7 @@
"whiteBalance": "A String", # The white balance mode used to create the photo.
"cameraModel": "A String", # The model of the camera used to create the photo.
},
- "kind": "drive#file", # This is always drive#file.
+ "kind": "drive#file", # Identifies what kind of resource this is. Value: the fixed string "drive#file".
"name": "A String", # The name of the file. This is not necessarily unique within a folder.
"webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Drive.
"spaces": [ # The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
@@ -612,7 +612,7 @@
"id": "A String", # The ID of the file.
"sharingUser": { # Information about a Drive user. # The user who shared the file with the requesting user, if applicable.
"me": True or False, # Whether this user is the requesting user.
- "kind": "drive#user", # This is always drive#user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
@@ -626,7 +626,7 @@
},
"lastModifyingUser": { # Information about a Drive user. # The last user to modify the file.
"me": True or False, # Whether this user is the requesting user.
- "kind": "drive#user", # This is always drive#user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
@@ -658,7 +658,7 @@
"domain": "A String", # The domain to which this permission refers.
"displayName": "A String", # A displayable name for users, groups or domains.
"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
- "kind": "drive#permission", # This is always drive#permission.
+ "kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"photoLink": "A String", # A link to the user's profile photo, if available.
"role": "A String", # The role granted by this permission. Valid values are:
@@ -686,7 +686,7 @@
"owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner.
{ # Information about a Drive user.
"me": True or False, # Whether this user is the requesting user.
- "kind": "drive#user", # This is always drive#user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
@@ -728,7 +728,7 @@
"whiteBalance": "A String", # The white balance mode used to create the photo.
"cameraModel": "A String", # The model of the camera used to create the photo.
},
- "kind": "drive#file", # This is always drive#file.
+ "kind": "drive#file", # Identifies what kind of resource this is. Value: the fixed string "drive#file".
"name": "A String", # The name of the file. This is not necessarily unique within a folder.
"webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Drive.
"spaces": [ # The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
@@ -797,7 +797,7 @@
An object of the form:
{ # A list of generated file IDs which can be provided in create requests.
- "kind": "drive#generatedIds", # This is always drive#generatedIds
+ "kind": "drive#generatedIds", # Identifies what kind of resource this is. Value: the fixed string "drive#generatedIds".
"ids": [ # The IDs generated for the requesting user in the specified space.
"A String",
],
@@ -830,7 +830,7 @@
"id": "A String", # The ID of the file.
"sharingUser": { # Information about a Drive user. # The user who shared the file with the requesting user, if applicable.
"me": True or False, # Whether this user is the requesting user.
- "kind": "drive#user", # This is always drive#user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
@@ -844,7 +844,7 @@
},
"lastModifyingUser": { # Information about a Drive user. # The last user to modify the file.
"me": True or False, # Whether this user is the requesting user.
- "kind": "drive#user", # This is always drive#user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
@@ -876,7 +876,7 @@
"domain": "A String", # The domain to which this permission refers.
"displayName": "A String", # A displayable name for users, groups or domains.
"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
- "kind": "drive#permission", # This is always drive#permission.
+ "kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"photoLink": "A String", # A link to the user's profile photo, if available.
"role": "A String", # The role granted by this permission. Valid values are:
@@ -904,7 +904,7 @@
"owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner.
{ # Information about a Drive user.
"me": True or False, # Whether this user is the requesting user.
- "kind": "drive#user", # This is always drive#user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
@@ -946,7 +946,7 @@
"whiteBalance": "A String", # The white balance mode used to create the photo.
"cameraModel": "A String", # The model of the camera used to create the photo.
},
- "kind": "drive#file", # This is always drive#file.
+ "kind": "drive#file", # Identifies what kind of resource this is. Value: the fixed string "drive#file".
"name": "A String", # The name of the file. This is not necessarily unique within a folder.
"webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Drive.
"spaces": [ # The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
@@ -1014,7 +1014,7 @@
"id": "A String", # The ID of the file.
"sharingUser": { # Information about a Drive user. # The user who shared the file with the requesting user, if applicable.
"me": True or False, # Whether this user is the requesting user.
- "kind": "drive#user", # This is always drive#user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
@@ -1028,7 +1028,7 @@
},
"lastModifyingUser": { # Information about a Drive user. # The last user to modify the file.
"me": True or False, # Whether this user is the requesting user.
- "kind": "drive#user", # This is always drive#user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
@@ -1060,7 +1060,7 @@
"domain": "A String", # The domain to which this permission refers.
"displayName": "A String", # A displayable name for users, groups or domains.
"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
- "kind": "drive#permission", # This is always drive#permission.
+ "kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"photoLink": "A String", # A link to the user's profile photo, if available.
"role": "A String", # The role granted by this permission. Valid values are:
@@ -1088,7 +1088,7 @@
"owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner.
{ # Information about a Drive user.
"me": True or False, # Whether this user is the requesting user.
- "kind": "drive#user", # This is always drive#user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
@@ -1130,7 +1130,7 @@
"whiteBalance": "A String", # The white balance mode used to create the photo.
"cameraModel": "A String", # The model of the camera used to create the photo.
},
- "kind": "drive#file", # This is always drive#file.
+ "kind": "drive#file", # Identifies what kind of resource this is. Value: the fixed string "drive#file".
"name": "A String", # The name of the file. This is not necessarily unique within a folder.
"webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Drive.
"spaces": [ # The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
@@ -1150,7 +1150,7 @@
},
],
"nextPageToken": "A String", # The page token for the next page of files. This will be absent if the end of the files list has been reached.
- "kind": "drive#fileList", # This is always drive#fileList.
+ "kind": "drive#fileList", # Identifies what kind of resource this is. Value: the fixed string "drive#fileList".
}</pre>
</div>
@@ -1191,7 +1191,7 @@
"id": "A String", # The ID of the file.
"sharingUser": { # Information about a Drive user. # The user who shared the file with the requesting user, if applicable.
"me": True or False, # Whether this user is the requesting user.
- "kind": "drive#user", # This is always drive#user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
@@ -1205,7 +1205,7 @@
},
"lastModifyingUser": { # Information about a Drive user. # The last user to modify the file.
"me": True or False, # Whether this user is the requesting user.
- "kind": "drive#user", # This is always drive#user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
@@ -1237,7 +1237,7 @@
"domain": "A String", # The domain to which this permission refers.
"displayName": "A String", # A displayable name for users, groups or domains.
"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
- "kind": "drive#permission", # This is always drive#permission.
+ "kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"photoLink": "A String", # A link to the user's profile photo, if available.
"role": "A String", # The role granted by this permission. Valid values are:
@@ -1265,7 +1265,7 @@
"owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner.
{ # Information about a Drive user.
"me": True or False, # Whether this user is the requesting user.
- "kind": "drive#user", # This is always drive#user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
@@ -1307,7 +1307,7 @@
"whiteBalance": "A String", # The white balance mode used to create the photo.
"cameraModel": "A String", # The model of the camera used to create the photo.
},
- "kind": "drive#file", # This is always drive#file.
+ "kind": "drive#file", # Identifies what kind of resource this is. Value: the fixed string "drive#file".
"name": "A String", # The name of the file. This is not necessarily unique within a folder.
"webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Drive.
"spaces": [ # The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
@@ -1350,7 +1350,7 @@
"id": "A String", # The ID of the file.
"sharingUser": { # Information about a Drive user. # The user who shared the file with the requesting user, if applicable.
"me": True or False, # Whether this user is the requesting user.
- "kind": "drive#user", # This is always drive#user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
@@ -1364,7 +1364,7 @@
},
"lastModifyingUser": { # Information about a Drive user. # The last user to modify the file.
"me": True or False, # Whether this user is the requesting user.
- "kind": "drive#user", # This is always drive#user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
@@ -1396,7 +1396,7 @@
"domain": "A String", # The domain to which this permission refers.
"displayName": "A String", # A displayable name for users, groups or domains.
"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
- "kind": "drive#permission", # This is always drive#permission.
+ "kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"photoLink": "A String", # A link to the user's profile photo, if available.
"role": "A String", # The role granted by this permission. Valid values are:
@@ -1424,7 +1424,7 @@
"owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner.
{ # Information about a Drive user.
"me": True or False, # Whether this user is the requesting user.
- "kind": "drive#user", # This is always drive#user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
@@ -1466,7 +1466,7 @@
"whiteBalance": "A String", # The white balance mode used to create the photo.
"cameraModel": "A String", # The model of the camera used to create the photo.
},
- "kind": "drive#file", # This is always drive#file.
+ "kind": "drive#file", # Identifies what kind of resource this is. Value: the fixed string "drive#file".
"name": "A String", # The name of the file. This is not necessarily unique within a folder.
"webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Drive.
"spaces": [ # The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
diff --git a/docs/dyn/drive_v3.permissions.html b/docs/dyn/drive_v3.permissions.html
index 160e6d5..d7ca2e1 100644
--- a/docs/dyn/drive_v3.permissions.html
+++ b/docs/dyn/drive_v3.permissions.html
@@ -103,7 +103,7 @@
"domain": "A String", # The domain to which this permission refers.
"displayName": "A String", # A displayable name for users, groups or domains.
"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
- "kind": "drive#permission", # This is always drive#permission.
+ "kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"photoLink": "A String", # A link to the user's profile photo, if available.
"role": "A String", # The role granted by this permission. Valid values are:
@@ -131,7 +131,7 @@
"domain": "A String", # The domain to which this permission refers.
"displayName": "A String", # A displayable name for users, groups or domains.
"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
- "kind": "drive#permission", # This is always drive#permission.
+ "kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"photoLink": "A String", # A link to the user's profile photo, if available.
"role": "A String", # The role granted by this permission. Valid values are:
@@ -174,7 +174,7 @@
"domain": "A String", # The domain to which this permission refers.
"displayName": "A String", # A displayable name for users, groups or domains.
"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
- "kind": "drive#permission", # This is always drive#permission.
+ "kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"photoLink": "A String", # A link to the user's profile photo, if available.
"role": "A String", # The role granted by this permission. Valid values are:
@@ -203,13 +203,13 @@
An object of the form:
{ # A list of permissions for a file.
- "kind": "drive#permissionList", # This is always drive#permissionList.
+ "kind": "drive#permissionList", # Identifies what kind of resource this is. Value: the fixed string "drive#permissionList".
"permissions": [ # The full list of permissions.
{ # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
"domain": "A String", # The domain to which this permission refers.
"displayName": "A String", # A displayable name for users, groups or domains.
"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
- "kind": "drive#permission", # This is always drive#permission.
+ "kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"photoLink": "A String", # A link to the user's profile photo, if available.
"role": "A String", # The role granted by this permission. Valid values are:
@@ -243,7 +243,7 @@
"domain": "A String", # The domain to which this permission refers.
"displayName": "A String", # A displayable name for users, groups or domains.
"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
- "kind": "drive#permission", # This is always drive#permission.
+ "kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"photoLink": "A String", # A link to the user's profile photo, if available.
"role": "A String", # The role granted by this permission. Valid values are:
@@ -270,7 +270,7 @@
"domain": "A String", # The domain to which this permission refers.
"displayName": "A String", # A displayable name for users, groups or domains.
"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
- "kind": "drive#permission", # This is always drive#permission.
+ "kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"photoLink": "A String", # A link to the user's profile photo, if available.
"role": "A String", # The role granted by this permission. Valid values are:
diff --git a/docs/dyn/drive_v3.replies.html b/docs/dyn/drive_v3.replies.html
index 4a0bd89..5f925fa 100644
--- a/docs/dyn/drive_v3.replies.html
+++ b/docs/dyn/drive_v3.replies.html
@@ -104,11 +104,11 @@
The object takes the form of:
{ # A reply to a comment on a file.
- "kind": "drive#reply", # This is always drive#reply.
+ "kind": "drive#reply", # Identifies what kind of resource this is. Value: the fixed string "drive#reply".
"modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
"author": { # Information about a Drive user. # The user who created the reply.
"me": True or False, # Whether this user is the requesting user.
- "kind": "drive#user", # This is always drive#user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
@@ -129,11 +129,11 @@
An object of the form:
{ # A reply to a comment on a file.
- "kind": "drive#reply", # This is always drive#reply.
+ "kind": "drive#reply", # Identifies what kind of resource this is. Value: the fixed string "drive#reply".
"modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
"author": { # Information about a Drive user. # The user who created the reply.
"me": True or False, # Whether this user is the requesting user.
- "kind": "drive#user", # This is always drive#user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
@@ -175,11 +175,11 @@
An object of the form:
{ # A reply to a comment on a file.
- "kind": "drive#reply", # This is always drive#reply.
+ "kind": "drive#reply", # Identifies what kind of resource this is. Value: the fixed string "drive#reply".
"modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
"author": { # Information about a Drive user. # The user who created the reply.
"me": True or False, # Whether this user is the requesting user.
- "kind": "drive#user", # This is always drive#user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
@@ -212,14 +212,14 @@
{ # A list of replies to a comment on a file.
"nextPageToken": "A String", # The page token for the next page of replies. This will be absent if the end of the replies list has been reached.
- "kind": "drive#replyList", # This is always drive#replyList.
+ "kind": "drive#replyList", # Identifies what kind of resource this is. Value: the fixed string "drive#replyList".
"replies": [ # The page of replies.
{ # A reply to a comment on a file.
- "kind": "drive#reply", # This is always drive#reply.
+ "kind": "drive#reply", # Identifies what kind of resource this is. Value: the fixed string "drive#reply".
"modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
"author": { # Information about a Drive user. # The user who created the reply.
"me": True or False, # Whether this user is the requesting user.
- "kind": "drive#user", # This is always drive#user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
@@ -264,11 +264,11 @@
The object takes the form of:
{ # A reply to a comment on a file.
- "kind": "drive#reply", # This is always drive#reply.
+ "kind": "drive#reply", # Identifies what kind of resource this is. Value: the fixed string "drive#reply".
"modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
"author": { # Information about a Drive user. # The user who created the reply.
"me": True or False, # Whether this user is the requesting user.
- "kind": "drive#user", # This is always drive#user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
@@ -289,11 +289,11 @@
An object of the form:
{ # A reply to a comment on a file.
- "kind": "drive#reply", # This is always drive#reply.
+ "kind": "drive#reply", # Identifies what kind of resource this is. Value: the fixed string "drive#reply".
"modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
"author": { # Information about a Drive user. # The user who created the reply.
"me": True or False, # Whether this user is the requesting user.
- "kind": "drive#user", # This is always drive#user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
diff --git a/docs/dyn/drive_v3.revisions.html b/docs/dyn/drive_v3.revisions.html
index 798e329..2c86689 100644
--- a/docs/dyn/drive_v3.revisions.html
+++ b/docs/dyn/drive_v3.revisions.html
@@ -84,9 +84,12 @@
<code><a href="#get_media">get_media(fileId, revisionId, acknowledgeAbuse=None)</a></code></p>
<p class="firstline">Gets a revision's metadata or content by ID.</p>
<p class="toc_element">
- <code><a href="#list">list(fileId)</a></code></p>
+ <code><a href="#list">list(fileId, pageToken=None, pageSize=None)</a></code></p>
<p class="firstline">Lists a file's revisions.</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>
+<p class="toc_element">
<code><a href="#update">update(fileId, revisionId, body)</a></code></p>
<p class="firstline">Updates a revision with patch semantics.</p>
<h3>Method Details</h3>
@@ -114,11 +117,11 @@
{ # The metadata for a revision to a file.
"mimeType": "A String", # The MIME type of the revision.
- "kind": "drive#revision", # This is always drive#revision.
+ "kind": "drive#revision", # Identifies what kind of resource this is. Value: the fixed string "drive#revision".
"modifiedTime": "A String", # The last time the revision was modified (RFC 3339 date-time).
"lastModifyingUser": { # Information about a Drive user. # The last user to modify this revision.
"me": True or False, # Whether this user is the requesting user.
- "kind": "drive#user", # This is always drive#user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
@@ -152,25 +155,28 @@
</div>
<div class="method">
- <code class="details" id="list">list(fileId)</code>
+ <code class="details" id="list">list(fileId, pageToken=None, pageSize=None)</code>
<pre>Lists a file's revisions.
Args:
fileId: string, The ID of the file. (required)
+ pageToken: string, The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.
+ pageSize: integer, The maximum number of revisions to return per page.
Returns:
An object of the form:
{ # A list of revisions of a file.
- "kind": "drive#revisionList", # This is always drive#revisionList.
+ "nextPageToken": "A String", # The page token for the next page of revisions. This will be absent if the end of the revisions list has been reached.
+ "kind": "drive#revisionList", # Identifies what kind of resource this is. Value: the fixed string "drive#revisionList".
"revisions": [ # The full list of revisions.
{ # The metadata for a revision to a file.
"mimeType": "A String", # The MIME type of the revision.
- "kind": "drive#revision", # This is always drive#revision.
+ "kind": "drive#revision", # Identifies what kind of resource this is. Value: the fixed string "drive#revision".
"modifiedTime": "A String", # The last time the revision was modified (RFC 3339 date-time).
"lastModifyingUser": { # Information about a Drive user. # The last user to modify this revision.
"me": True or False, # Whether this user is the requesting user.
- "kind": "drive#user", # This is always drive#user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
@@ -191,6 +197,20 @@
</div>
<div class="method">
+ <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
+ <pre>Retrieves the next page of results.
+
+Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+Returns:
+ A request object that you can call 'execute()' on to request the next
+ page. Returns None if there are no more items in the collection.
+ </pre>
+</div>
+
+<div class="method">
<code class="details" id="update">update(fileId, revisionId, body)</code>
<pre>Updates a revision with patch semantics.
@@ -202,11 +222,11 @@
{ # The metadata for a revision to a file.
"mimeType": "A String", # The MIME type of the revision.
- "kind": "drive#revision", # This is always drive#revision.
+ "kind": "drive#revision", # Identifies what kind of resource this is. Value: the fixed string "drive#revision".
"modifiedTime": "A String", # The last time the revision was modified (RFC 3339 date-time).
"lastModifyingUser": { # Information about a Drive user. # The last user to modify this revision.
"me": True or False, # Whether this user is the requesting user.
- "kind": "drive#user", # This is always drive#user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
@@ -229,11 +249,11 @@
{ # The metadata for a revision to a file.
"mimeType": "A String", # The MIME type of the revision.
- "kind": "drive#revision", # This is always drive#revision.
+ "kind": "drive#revision", # Identifies what kind of resource this is. Value: the fixed string "drive#revision".
"modifiedTime": "A String", # The last time the revision was modified (RFC 3339 date-time).
"lastModifyingUser": { # Information about a Drive user. # The last user to modify this revision.
"me": True or False, # Whether this user is the requesting user.
- "kind": "drive#user", # This is always drive#user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
diff --git a/docs/dyn/firebasedynamiclinks_v1.html b/docs/dyn/firebasedynamiclinks_v1.html
new file mode 100644
index 0000000..94a4172
--- /dev/null
+++ b/docs/dyn/firebasedynamiclinks_v1.html
@@ -0,0 +1,103 @@
+<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="firebasedynamiclinks_v1.html">Firebase Dynamic Links API</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="firebasedynamiclinks_v1.shortLinks.html">shortLinks()</a></code>
+</p>
+<p class="firstline">Returns the shortLinks Resource.</p>
+
+<p class="toc_element">
+ <code><a href="#new_batch_http_request">new_batch_http_request()</a></code></p>
+<p class="firstline">Create a BatchHttpRequest object based on the discovery document.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="new_batch_http_request">new_batch_http_request()</code>
+ <pre>Create a BatchHttpRequest object based on the discovery document.
+
+ Args:
+ callback: callable, A callback to be called for each response, of the
+ form callback(id, response, exception). The first parameter is the
+ request id, and the second is the deserialized response object. The
+ third is an apiclient.errors.HttpError exception object if an HTTP
+ error occurred while processing the request, or None if no error
+ occurred.
+
+ Returns:
+ A BatchHttpRequest object based on the discovery document.
+ </pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/firebasedynamiclinks_v1.shortLinks.html b/docs/dyn/firebasedynamiclinks_v1.shortLinks.html
new file mode 100644
index 0000000..ca5bcab
--- /dev/null
+++ b/docs/dyn/firebasedynamiclinks_v1.shortLinks.html
@@ -0,0 +1,195 @@
+<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="firebasedynamiclinks_v1.html">Firebase Dynamic Links API</a> . <a href="firebasedynamiclinks_v1.shortLinks.html">shortLinks</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#create">create(body, x__xgafv=None)</a></code></p>
+<p class="firstline">Creates a short Dynamic Link given either a valid long Dynamic Link or</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="create">create(body, x__xgafv=None)</code>
+ <pre>Creates a short Dynamic Link given either a valid long Dynamic Link or
+details such as Dynamic Link domain, Android and iOS app information.
+The created short Dynamic Link will not expire.
+
+Repeated calls with the same long Dynamic Link or Dynamic Link information
+will produce the same short Dynamic Link.
+
+The Dynamic Link domain in the request must be owned by requester's
+Firebase project.
+
+Args:
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Request to create a short Dynamic Link.
+ "dynamicLinkInfo": { # Information about a Dynamic Link. # Information about the Dynamic Link to be shortened.
+ # [Learn more](https://firebase.google.com/docs/dynamic-links/android#create-a-dynamic-link-programmatically).
+ "analyticsInfo": { # Tracking parameters supported by Dynamic Link. # Parameters used for tracking. See all tracking parameters in the
+ # [documentation](https://firebase.google.com/docs/dynamic-links/android#create-a-dynamic-link-programmatically).
+ "googlePlayAnalytics": { # Parameters for Google Play Campaign Measurements. # Google Play Campaign Measurements.
+ # [Learn more](https://developers.google.com/analytics/devguides/collection/android/v4/campaigns#campaign-params)
+ "utmMedium": "A String", # Campaign medium; used to identify a medium such as email or cost-per-click.
+ "utmSource": "A String", # Campaign source; used to identify a search engine, newsletter, or other
+ # source.
+ "gclid": "A String", # [AdWords autotagging parameter](https://support.google.com/analytics/answer/1033981?hl=en);
+ # used to measure Google AdWords ads. This value is generated dynamically
+ # and should never be modified.
+ "utmTerm": "A String", # Campaign term; used with paid search to supply the keywords for ads.
+ "utmContent": "A String", # Campaign content; used for A/B testing and content-targeted ads to
+ # differentiate ads or links that point to the same URL.
+ "utmCampaign": "A String", # Campaign name; used for keyword analysis to identify a specific product
+ # promotion or strategic campaign.
+ },
+ "itunesConnectAnalytics": { # Parameters for iTunes Connect App Analytics. # iTunes Connect App Analytics.
+ "mt": "A String", # iTune media types, including music, podcasts, audiobooks and so on.
+ "at": "A String", # Affiliate token used to create affiliate-coded links.
+ "pt": "A String", # Provider token that enables analytics for Dynamic Links from within iTunes
+ # Connect.
+ "ct": "A String", # Campaign text that developers can optionally add to any link in order to
+ # track sales from a specific marketing campaign.
+ },
+ },
+ "isAd": True or False, # Declares that the Dynamic Link is used in an advertisement.
+ # See the 'ad' parameter in the
+ # [documentation](https://firebase.google.com/docs/dynamic-links/android#create-a-dynamic-link-programmatically).
+ "iosInfo": { # iOS related attributes to the Dynamic Link.. # iOS related information. See iOS related parameters in the
+ # [documentation](https://firebase.google.com/docs/dynamic-links/ios#create-a-dynamic-link-programmatically).
+ "iosCustomScheme": "A String", # Custom (destination) scheme to use for iOS. By default, we’ll use the
+ # bundle ID as the custom scheme. Developer can override this behavior using
+ # this param.
+ "iosFallbackLink": "A String", # Link to open on iOS if the app is not installed.
+ "iosBundleId": "A String", # iOS bundle ID of the app.
+ "iosIpadBundleId": "A String", # iPad bundle ID of the app.
+ "iosAppStoreId": "A String", # iOS App Store ID.
+ "iosIpadFallbackLink": "A String", # If specified, this overrides the ios_fallback_link value on iPads.
+ },
+ "androidInfo": { # Android related attributes to the Dynamic Link. # Android related information. See Android related parameters in the
+ # [documentation](https://firebase.google.com/docs/dynamic-links/android#create-a-dynamic-link-programmatically).
+ "androidFallbackLink": "A String", # Link to open on Android if the app is not installed.
+ "androidPackageName": "A String", # Android package name of the app.
+ "androidLink": "A String", # If specified, this overrides the ‘link’ parameter on Android.
+ "androidMinPackageVersionCode": "A String", # Minimum version code for the Android app. If the installed app’s version
+ # code is lower, then the user is taken to the Play Store.
+ },
+ "socialMetaTagInfo": { # Parameters for social meta tag params. # Parameters for social meta tag params.
+ # Used to set meta tag data for link previews on social sites.
+ # Used to set meta tag data for link previews on social sites.
+ "socialTitle": "A String", # Title to be displayed. Optional.
+ "socialDescription": "A String", # A short description of the link. Optional.
+ "socialImageLink": "A String", # An image url string. Optional.
+ },
+ "link": "A String", # The link your app will open, You can specify any URL your app can handle.
+ # This link must be a well-formatted URL, be properly URL-encoded, and use
+ # the HTTP or HTTPS scheme. See 'link' parameters in the
+ # [documentation](https://firebase.google.com/docs/dynamic-links/android#create-a-dynamic-link-programmatically).
+ #
+ # Required.
+ "dynamicLinkDomain": "A String", # Dynamic Links domain that the project owns, e.g. abcd.app.goo.gl
+ # [Learn more](https://firebase.google.com/docs/dynamic-links/android#set-up-firebase-and-the-dynamic-links-sdk)
+ # on how to set up Dynamic Link domain associated with your Firebase project.
+ #
+ # Required.
+ },
+ "longDynamicLink": "A String", # Full long Dynamic Link URL with desired query parameters specified.
+ # For example,
+ # "https://sample.app.goo.gl/?link=http://www.google.com&apn=com.sample",
+ # [Learn more](https://firebase.google.com/docs/dynamic-links/android#create-a-dynamic-link-programmatically).
+ "suffix": { # Short Dynamic Link suffix. # Short Dynamic Link suffix. Optional.
+ "option": "A String", # Suffix option.
+ },
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response to create a short Dynamic Link.
+ "shortLink": "A String", # Short Dynamic Link value. e.g. https://abcd.app.goo.gl/wxyz
+ "warning": [ # Information about potential warnings on link creation.
+ { # Dynamic Links warning messages.
+ "warningCode": "A String", # The warning code.
+ "warningMessage": "A String", # The warning message to help developers improve their requests.
+ },
+ ],
+ "previewLink": "A String", # Preivew link to show the link flow chart.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/fitness_v1.users.dataset.html b/docs/dyn/fitness_v1.users.dataset.html
index 516222d..5eb1e41 100644
--- a/docs/dyn/fitness_v1.users.dataset.html
+++ b/docs/dyn/fitness_v1.users.dataset.html
@@ -87,7 +87,7 @@
body: object, The request body. (required)
The object takes the form of:
-{
+{ # Next id: 10
"aggregateBy": [ # The specification of data to be aggregated. At least one aggregateBy spec must be provided. All data that is specified will be aggregated using the same bucketing criteria. There will be one dataset in the response for every aggregateBy spec.
{ # The specification of which data to aggregate.
"dataSourceId": "A String", # A data source ID to aggregate. Mutually exclusive of dataTypeName. Only data from the specified data source ID will be included in the aggregation. The dataset in the response will have the same data source ID.
diff --git a/docs/dyn/fitness_v1.users.sessions.html b/docs/dyn/fitness_v1.users.sessions.html
index a4d73ad..5e7712b 100644
--- a/docs/dyn/fitness_v1.users.sessions.html
+++ b/docs/dyn/fitness_v1.users.sessions.html
@@ -113,6 +113,7 @@
An object of the form:
{
+ "hasMoreData": True or False, # Flag to indicate server has more data to transfer
"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.
"deletedSession": [ # If includeDeleted is set to true in the request, this list will contain sessions deleted with original end times that are within the startTime and endTime frame.
{ # Sessions contain metadata, such as a user-friendly name and time interval information.
diff --git a/docs/dyn/genomics_v1.datasets.html b/docs/dyn/genomics_v1.datasets.html
index 8380209..319259d 100644
--- a/docs/dyn/genomics_v1.datasets.html
+++ b/docs/dyn/genomics_v1.datasets.html
@@ -114,7 +114,7 @@
The object takes the form of:
{ # A Dataset is a collection of genomic data. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
- "projectId": "A String", # The Google Developers Console project ID that this dataset belongs to.
+ "projectId": "A String", # The Google Cloud project ID that this dataset belongs to.
"id": "A String", # The server-generated dataset ID, unique across all datasets.
"createTime": "A String", # The time this dataset was created, in seconds from the epoch.
"name": "A String", # The dataset name.
@@ -126,7 +126,7 @@
An object of the form:
{ # A Dataset is a collection of genomic data. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
- "projectId": "A String", # The Google Developers Console project ID that this dataset belongs to.
+ "projectId": "A String", # The Google Cloud project ID that this dataset belongs to.
"id": "A String", # The server-generated dataset ID, unique across all datasets.
"createTime": "A String", # The time this dataset was created, in seconds from the epoch.
"name": "A String", # The dataset name.
@@ -160,7 +160,7 @@
An object of the form:
{ # A Dataset is a collection of genomic data. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
- "projectId": "A String", # The Google Developers Console project ID that this dataset belongs to.
+ "projectId": "A String", # The Google Cloud project ID that this dataset belongs to.
"id": "A String", # The server-generated dataset ID, unique across all datasets.
"createTime": "A String", # The time this dataset was created, in seconds from the epoch.
"name": "A String", # The dataset name.
@@ -204,7 +204,7 @@
Args:
pageSize: integer, The maximum number of results to return in a single page. If unspecified, defaults to 50. The maximum value is 1024.
- projectId: string, Required. The project to list datasets for.
+ projectId: string, Required. The Google Cloud project ID to list datasets for.
pageToken: string, The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of `nextPageToken` from the previous response.
x__xgafv: string, V1 error format.
@@ -215,7 +215,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.
"datasets": [ # The list of matching Datasets.
{ # A Dataset is a collection of genomic data. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
- "projectId": "A String", # The Google Developers Console project ID that this dataset belongs to.
+ "projectId": "A String", # The Google Cloud project ID that this dataset belongs to.
"id": "A String", # The server-generated dataset ID, unique across all datasets.
"createTime": "A String", # The time this dataset was created, in seconds from the epoch.
"name": "A String", # The dataset name.
@@ -248,7 +248,7 @@
The object takes the form of:
{ # A Dataset is a collection of genomic data. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
- "projectId": "A String", # The Google Developers Console project ID that this dataset belongs to.
+ "projectId": "A String", # The Google Cloud project ID that this dataset belongs to.
"id": "A String", # The server-generated dataset ID, unique across all datasets.
"createTime": "A String", # The time this dataset was created, in seconds from the epoch.
"name": "A String", # The dataset name.
@@ -261,7 +261,7 @@
An object of the form:
{ # A Dataset is a collection of genomic data. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
- "projectId": "A String", # The Google Developers Console project ID that this dataset belongs to.
+ "projectId": "A String", # The Google Cloud project ID that this dataset belongs to.
"id": "A String", # The server-generated dataset ID, unique across all datasets.
"createTime": "A String", # The time this dataset was created, in seconds from the epoch.
"name": "A String", # The dataset name.
@@ -356,7 +356,7 @@
An object of the form:
{ # A Dataset is a collection of genomic data. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
- "projectId": "A String", # The Google Developers Console project ID that this dataset belongs to.
+ "projectId": "A String", # The Google Cloud project ID that this dataset belongs to.
"id": "A String", # The server-generated dataset ID, unique across all datasets.
"createTime": "A String", # The time this dataset was created, in seconds from the epoch.
"name": "A String", # The dataset name.
diff --git a/docs/dyn/genomics_v1.operations.html b/docs/dyn/genomics_v1.operations.html
index 160759f..b4684a9 100644
--- a/docs/dyn/genomics_v1.operations.html
+++ b/docs/dyn/genomics_v1.operations.html
@@ -123,7 +123,7 @@
"response": { # If importing ReadGroupSets, an ImportReadGroupSetsResponse is returned. If importing Variants, an ImportVariantsResponse is returned. For exports, an empty response is returned.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure or cancellation.
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
@@ -160,7 +160,7 @@
"response": { # If importing ReadGroupSets, an ImportReadGroupSetsResponse is returned. If importing Variants, an ImportVariantsResponse is returned. For exports, an empty response is returned.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure or cancellation.
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
diff --git a/docs/dyn/genomics_v1.readgroupsets.html b/docs/dyn/genomics_v1.readgroupsets.html
index b7a0a90..f56b3d3 100644
--- a/docs/dyn/genomics_v1.readgroupsets.html
+++ b/docs/dyn/genomics_v1.readgroupsets.html
@@ -123,7 +123,7 @@
The object takes the form of:
{ # The read group set export request.
- "projectId": "A String", # Required. The Google Developers Console project ID that owns this export. The caller must have WRITE access to this project.
+ "projectId": "A String", # Required. The Google Cloud project ID that owns this export. The caller must have WRITE access to this project.
"referenceNames": [ # The reference names to export. If this is not specified, all reference sequences, including unmapped reads, are exported. Use `*` to export only unmapped reads.
"A String",
],
@@ -139,7 +139,7 @@
"response": { # If importing ReadGroupSets, an ImportReadGroupSetsResponse is returned. If importing Variants, an ImportVariantsResponse is returned. For exports, an empty response is returned.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure or cancellation.
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
@@ -238,7 +238,7 @@
"response": { # If importing ReadGroupSets, an ImportReadGroupSetsResponse is returned. If importing Variants, an ImportVariantsResponse is returned. For exports, an empty response is returned.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure or cancellation.
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
diff --git a/docs/dyn/genomics_v1.reads.html b/docs/dyn/genomics_v1.reads.html
index 5ec52a7..024e859 100644
--- a/docs/dyn/genomics_v1.reads.html
+++ b/docs/dyn/genomics_v1.reads.html
@@ -170,7 +170,7 @@
"end": "A String", # The end position of the range on the reference, 0-based exclusive. If specified, `referenceName` must also be specified.
"totalShards": 42, # Specifying `totalShards` causes a disjoint subset of the normal response payload to be returned for each query with a unique `shard` parameter specified. A best effort is made to yield equally sized shards. Sharding can be used to distribute processing amongst workers, where each worker is assigned a unique `shard` number and all workers specify the same `totalShards` number. The union of reads returned for all sharded queries `[0, totalShards)` is equal to those returned by a single unsharded query. Queries for different values of `totalShards` with common divisors will share shard boundaries. For example, streaming `shard` 2 of 5 `totalShards` yields the same results as streaming `shard`s 4 and 5 of 10 `totalShards`. This property can be leveraged for adaptive retries.
"readGroupSetId": "A String", # The ID of the read group set from which to stream reads.
- "projectId": "A String", # The Google Developers Console project ID or number which will be billed for this access. The caller must have WRITE access to this project. Required.
+ "projectId": "A String", # The Google Cloud project ID which will be billed for this access. The caller must have WRITE access to this project. Required.
"shard": 42, # Restricts results to a shard containing approximately `1/totalShards` of the normal response payload for this query. Results from a sharded request are disjoint from those returned by all queries which differ only in their shard parameter. A shard may yield 0 results; this is especially likely for large values of `totalShards`. Valid values are `[0, totalShards)`.
"start": "A String", # The start position of the range on the reference, 0-based inclusive. If specified, `referenceName` must also be specified.
"referenceName": "A String", # The reference sequence name, for example `chr1`, `1`, or `chrX`. If set to *, only unmapped reads are returned.
diff --git a/docs/dyn/genomics_v1.variants.html b/docs/dyn/genomics_v1.variants.html
index bbf19a9..a6a10e9 100644
--- a/docs/dyn/genomics_v1.variants.html
+++ b/docs/dyn/genomics_v1.variants.html
@@ -298,7 +298,7 @@
"response": { # If importing ReadGroupSets, an ImportReadGroupSetsResponse is returned. If importing Variants, an ImportVariantsResponse is returned. For exports, an empty response is returned.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure or cancellation.
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
@@ -574,7 +574,7 @@
{ # The stream variants request.
"variantSetId": "A String", # The variant set ID from which to stream variants.
"end": "A String", # The end of the window (0-based, exclusive) for which overlapping variants should be returned.
- "projectId": "A String", # The Google Developers Console project ID or number which will be billed for this access. The caller must have WRITE access to this project. Required.
+ "projectId": "A String", # The Google Cloud project ID which will be billed for this access. The caller must have WRITE access to this project. Required.
"start": "A String", # The beginning of the window (0-based, inclusive) for which overlapping variants should be returned.
"callSetIds": [ # Only return variant calls which belong to call sets with these IDs. Leaving this blank returns all variant calls.
"A String",
diff --git a/docs/dyn/genomics_v1.variantsets.html b/docs/dyn/genomics_v1.variantsets.html
index a8220e1..456049c 100644
--- a/docs/dyn/genomics_v1.variantsets.html
+++ b/docs/dyn/genomics_v1.variantsets.html
@@ -208,7 +208,7 @@
"response": { # If importing ReadGroupSets, an ImportReadGroupSetsResponse is returned. If importing Variants, an ImportVariantsResponse is returned. For exports, an empty response is returned.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure or cancellation.
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
diff --git a/docs/dyn/iam_v1.html b/docs/dyn/iam_v1.html
index 6b60ba4..b945fd3 100644
--- a/docs/dyn/iam_v1.html
+++ b/docs/dyn/iam_v1.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="iam_v1.html">Google Identity and Access Management API</a></h1>
+<h1><a href="iam_v1.html">Google Identity and Access Management (IAM) API</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="iam_v1.projects.html">projects()</a></code>
@@ -80,6 +80,11 @@
<p class="firstline">Returns the projects Resource.</p>
<p class="toc_element">
+ <code><a href="iam_v1.roles.html">roles()</a></code>
+</p>
+<p class="firstline">Returns the roles Resource.</p>
+
+<p class="toc_element">
<code><a href="#new_batch_http_request">new_batch_http_request()</a></code></p>
<p class="firstline">Create a BatchHttpRequest object based on the discovery document.</p>
<h3>Method Details</h3>
diff --git a/docs/dyn/iam_v1.projects.html b/docs/dyn/iam_v1.projects.html
index 77e1a4e..853c20f 100644
--- a/docs/dyn/iam_v1.projects.html
+++ b/docs/dyn/iam_v1.projects.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="iam_v1.html">Google Identity and Access Management API</a> . <a href="iam_v1.projects.html">projects</a></h1>
+<h1><a href="iam_v1.html">Google Identity and Access Management (IAM) API</a> . <a href="iam_v1.projects.html">projects</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="iam_v1.projects.serviceAccounts.html">serviceAccounts()</a></code>
diff --git a/docs/dyn/iam_v1.projects.serviceAccounts.html b/docs/dyn/iam_v1.projects.serviceAccounts.html
index 44e6d67..98cd27d 100644
--- a/docs/dyn/iam_v1.projects.serviceAccounts.html
+++ b/docs/dyn/iam_v1.projects.serviceAccounts.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="iam_v1.html">Google Identity and Access Management API</a> . <a href="iam_v1.projects.html">projects</a> . <a href="iam_v1.projects.serviceAccounts.html">serviceAccounts</a></h1>
+<h1><a href="iam_v1.html">Google Identity and Access Management (IAM) API</a> . <a href="iam_v1.projects.html">projects</a> . <a href="iam_v1.projects.serviceAccounts.html">serviceAccounts</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="iam_v1.projects.serviceAccounts.keys.html">keys()</a></code>
@@ -81,55 +81,55 @@
<p class="toc_element">
<code><a href="#create">create(name, body, x__xgafv=None)</a></code></p>
-<p class="firstline">Creates a service account and returns it.</p>
+<p class="firstline">Creates a ServiceAccount and returns it.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
-<p class="firstline">Deletes a service acount.</p>
+<p class="firstline">Deletes a ServiceAccount.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
-<p class="firstline">Gets a ServiceAccount</p>
+<p class="firstline">Gets a ServiceAccount.</p>
<p class="toc_element">
<code><a href="#getIamPolicy">getIamPolicy(resource, x__xgafv=None)</a></code></p>
-<p class="firstline">Returns the IAM access control policy for specified IAM resource.</p>
+<p class="firstline">Returns the IAM access control policy for a ServiceAccount.</p>
<p class="toc_element">
<code><a href="#list">list(name, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
-<p class="firstline">Lists service accounts for a project.</p>
+<p class="firstline">Lists ServiceAccounts for a project.</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>
<p class="toc_element">
<code><a href="#setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</a></code></p>
-<p class="firstline">Sets the IAM access control policy for the specified IAM resource.</p>
+<p class="firstline">Sets the IAM access control policy for a ServiceAccount.</p>
<p class="toc_element">
<code><a href="#signBlob">signBlob(name, body, x__xgafv=None)</a></code></p>
-<p class="firstline">Signs a blob using a service account.</p>
+<p class="firstline">Signs a blob using a service account's system-managed private key.</p>
<p class="toc_element">
<code><a href="#testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</a></code></p>
-<p class="firstline">Tests the specified permissions against the IAM access control policy for the specified IAM resource.</p>
+<p class="firstline">Tests the specified permissions against the IAM access control policy for a ServiceAccount.</p>
<p class="toc_element">
<code><a href="#update">update(name, body, x__xgafv=None)</a></code></p>
-<p class="firstline">Updates a service account. Currently, only the following fields are updatable: 'display_name' . The 'etag' is mandatory.</p>
+<p class="firstline">Updates a ServiceAccount. Currently, only the following fields are updatable: `display_name` . The `etag` is mandatory.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(name, body, x__xgafv=None)</code>
- <pre>Creates a service account and returns it.
+ <pre>Creates a ServiceAccount and returns it.
Args:
- name: string, Required. The resource name of the project associated with the service accounts, such as "projects/123" (required)
+ name: string, Required. The resource name of the project associated with the service accounts, such as `projects/my-project-123`. (required)
body: object, The request body. (required)
The object takes the form of:
{ # The service account create request.
- "serviceAccount": { # A service account in the Identity and Access Management API. To create a service account, you specify the project_id and account_id for the account. The account_id is unique within the project, and used to generate the service account email address and a stable unique id. All other methods can identify accounts using the format "projects/{project}/serviceAccounts/{account}". Using '-' as a wildcard for the project, will infer the project from the account. The account value can be the email address or the unique_id of the service account. # The ServiceAccount resource to create. Currently, only the following values are user assignable: display_name .
+ "serviceAccount": { # A service account in the Identity and Access Management API. To create a service account, specify the `project_id` and the `account_id` for the account. The `account_id` is unique within the project, and is used to generate the service account email address and a stable `unique_id`. If the account already exists, the account's resource name is returned in util::Status's ResourceInfo.resource_name in the format of projects/{project}/serviceAccounts/{email}. The caller can use the name in other methods to access the account. All other methods can identify the service account using the format `projects/{project}/serviceAccounts/{account}`. Using `-` as a wildcard for the project will infer the project from the account. The `account` value can be the `email` address or the `unique_id` of the service account. # The ServiceAccount resource to create. Currently, only the following values are user assignable: `display_name` .
"oauth2ClientId": "A String", # @OutputOnly. The OAuth2 client id for the service account. This is used in conjunction with the OAuth2 clientconfig API to make three legged OAuth2 (3LO) flows to access the data of Google users.
"displayName": "A String", # Optional. A user-specified description of the service account. Must be fewer than 100 UTF-8 bytes.
- "name": "A String", # The resource name of the service account in the format "projects/{project}/serviceAccounts/{account}". In requests using '-' as a wildcard for the project, will infer the project from the account and the account value can be the email address or the unique_id of the service account. In responses the resource name will always be in the format "projects/{project}/serviceAccounts/{email}".
+ "name": "A String", # The resource name of the service account in the following format: `projects/{project}/serviceAccounts/{account}`. Requests using `-` as a wildcard for the project will infer the project from the `account` and the `account` value can be the `email` address or the `unique_id` of the service account. In responses the resource name will always be in the format `projects/{project}/serviceAccounts/{email}`.
"projectId": "A String", # @OutputOnly The id of the project that owns the service account.
"etag": "A String", # Used to perform a consistent read-modify-write.
- "uniqueId": "A String", # @OutputOnly unique and stable id of the service account.
- "email": "A String", # @OutputOnly Email address of the service account.
+ "uniqueId": "A String", # @OutputOnly The unique and stable id of the service account.
+ "email": "A String", # @OutputOnly The email address of the service account.
},
- "accountId": "A String", # Required. The account id that is used to generate the service account email address and a stable unique id. It is unique within a project, must be 1-63 characters long, and match the regular expression [a-z]([-a-z0-9]*[a-z0-9]) to comply with RFC1035.
+ "accountId": "A String", # Required. The account id that is used to generate the service account email address and a stable unique id. It is unique within a project, must be 6-30 characters long, and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])` to comply with RFC1035.
}
x__xgafv: string, V1 error format.
@@ -137,23 +137,23 @@
Returns:
An object of the form:
- { # A service account in the Identity and Access Management API. To create a service account, you specify the project_id and account_id for the account. The account_id is unique within the project, and used to generate the service account email address and a stable unique id. All other methods can identify accounts using the format "projects/{project}/serviceAccounts/{account}". Using '-' as a wildcard for the project, will infer the project from the account. The account value can be the email address or the unique_id of the service account.
+ { # A service account in the Identity and Access Management API. To create a service account, specify the `project_id` and the `account_id` for the account. The `account_id` is unique within the project, and is used to generate the service account email address and a stable `unique_id`. If the account already exists, the account's resource name is returned in util::Status's ResourceInfo.resource_name in the format of projects/{project}/serviceAccounts/{email}. The caller can use the name in other methods to access the account. All other methods can identify the service account using the format `projects/{project}/serviceAccounts/{account}`. Using `-` as a wildcard for the project will infer the project from the account. The `account` value can be the `email` address or the `unique_id` of the service account.
"oauth2ClientId": "A String", # @OutputOnly. The OAuth2 client id for the service account. This is used in conjunction with the OAuth2 clientconfig API to make three legged OAuth2 (3LO) flows to access the data of Google users.
"displayName": "A String", # Optional. A user-specified description of the service account. Must be fewer than 100 UTF-8 bytes.
- "name": "A String", # The resource name of the service account in the format "projects/{project}/serviceAccounts/{account}". In requests using '-' as a wildcard for the project, will infer the project from the account and the account value can be the email address or the unique_id of the service account. In responses the resource name will always be in the format "projects/{project}/serviceAccounts/{email}".
+ "name": "A String", # The resource name of the service account in the following format: `projects/{project}/serviceAccounts/{account}`. Requests using `-` as a wildcard for the project will infer the project from the `account` and the `account` value can be the `email` address or the `unique_id` of the service account. In responses the resource name will always be in the format `projects/{project}/serviceAccounts/{email}`.
"projectId": "A String", # @OutputOnly The id of the project that owns the service account.
"etag": "A String", # Used to perform a consistent read-modify-write.
- "uniqueId": "A String", # @OutputOnly unique and stable id of the service account.
- "email": "A String", # @OutputOnly Email address of the service account.
+ "uniqueId": "A String", # @OutputOnly The unique and stable id of the service account.
+ "email": "A String", # @OutputOnly The email address of the service account.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
- <pre>Deletes a service acount.
+ <pre>Deletes a ServiceAccount.
Args:
- name: string, The resource name of the service account in the format "projects/{project}/serviceAccounts/{account}". Using '-' as a wildcard for the project, will infer the project from the account. The account value can be the email address or the unique_id of the service account. (required)
+ name: string, The resource name of the service account in the following format: `projects/{project}/serviceAccounts/{account}`. Using `-` as a wildcard for the project will infer the project from the account. The `account` value can be the `email` address or the `unique_id` of the service account. (required)
x__xgafv: string, V1 error format.
Returns:
@@ -165,77 +165,38 @@
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
- <pre>Gets a ServiceAccount
+ <pre>Gets a ServiceAccount.
Args:
- name: string, The resource name of the service account in the format "projects/{project}/serviceAccounts/{account}". Using '-' as a wildcard for the project, will infer the project from the account. The account value can be the email address or the unique_id of the service account. (required)
+ name: string, The resource name of the service account in the following format: `projects/{project}/serviceAccounts/{account}`. Using `-` as a wildcard for the project will infer the project from the account. The `account` value can be the `email` address or the `unique_id` of the service account. (required)
x__xgafv: string, V1 error format.
Returns:
An object of the form:
- { # A service account in the Identity and Access Management API. To create a service account, you specify the project_id and account_id for the account. The account_id is unique within the project, and used to generate the service account email address and a stable unique id. All other methods can identify accounts using the format "projects/{project}/serviceAccounts/{account}". Using '-' as a wildcard for the project, will infer the project from the account. The account value can be the email address or the unique_id of the service account.
+ { # A service account in the Identity and Access Management API. To create a service account, specify the `project_id` and the `account_id` for the account. The `account_id` is unique within the project, and is used to generate the service account email address and a stable `unique_id`. If the account already exists, the account's resource name is returned in util::Status's ResourceInfo.resource_name in the format of projects/{project}/serviceAccounts/{email}. The caller can use the name in other methods to access the account. All other methods can identify the service account using the format `projects/{project}/serviceAccounts/{account}`. Using `-` as a wildcard for the project will infer the project from the account. The `account` value can be the `email` address or the `unique_id` of the service account.
"oauth2ClientId": "A String", # @OutputOnly. The OAuth2 client id for the service account. This is used in conjunction with the OAuth2 clientconfig API to make three legged OAuth2 (3LO) flows to access the data of Google users.
"displayName": "A String", # Optional. A user-specified description of the service account. Must be fewer than 100 UTF-8 bytes.
- "name": "A String", # The resource name of the service account in the format "projects/{project}/serviceAccounts/{account}". In requests using '-' as a wildcard for the project, will infer the project from the account and the account value can be the email address or the unique_id of the service account. In responses the resource name will always be in the format "projects/{project}/serviceAccounts/{email}".
+ "name": "A String", # The resource name of the service account in the following format: `projects/{project}/serviceAccounts/{account}`. Requests using `-` as a wildcard for the project will infer the project from the `account` and the `account` value can be the `email` address or the `unique_id` of the service account. In responses the resource name will always be in the format `projects/{project}/serviceAccounts/{email}`.
"projectId": "A String", # @OutputOnly The id of the project that owns the service account.
"etag": "A String", # Used to perform a consistent read-modify-write.
- "uniqueId": "A String", # @OutputOnly unique and stable id of the service account.
- "email": "A String", # @OutputOnly Email address of the service account.
+ "uniqueId": "A String", # @OutputOnly The unique and stable id of the service account.
+ "email": "A String", # @OutputOnly The email address of the service account.
}</pre>
</div>
<div class="method">
<code class="details" id="getIamPolicy">getIamPolicy(resource, x__xgafv=None)</code>
- <pre>Returns the IAM access control policy for specified IAM resource.
+ <pre>Returns the IAM access control policy for a ServiceAccount.
Args:
- resource: string, REQUIRED: The resource for which the policy is being requested. `resource` is usually specified as a path, such as `projects/*project*/zones/*zone*/disks/*disk*`. The format for the path specified in this value is resource specific and is specified in the `getIamPolicy` documentation. (required)
+ resource: string, REQUIRED: The resource for which the policy is being requested. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
x__xgafv: string, V1 error format.
Returns:
An object of the form:
- { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com"] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
- "rules": [
- { # A rule to be applied in a Policy.
- "notIn": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is not in this set of entries. The format for in and not_in entries is the same as for members in a Binding (see google/iam/v1/policy.proto).
- "A String",
- ],
- "description": "A String", # Human-readable description of the rule.
- "in": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in this set of entries.
- "A String",
- ],
- "action": "A String", # Required
- "conditions": [ # Additional restrictions that must be met
- { # A condition to be met.
- "iam": "A String", # Trusted attributes supplied by the IAM system.
- "svc": "A String", # Trusted attributes discharged by the service.
- "value": "A String", # The object of the condition. Exactly one of these must be set.
- "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
- "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
- "A String",
- ],
- "op": "A String", # An operator to apply the subject with.
- },
- ],
- "logConfig": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
- { # Specifies what kind of log the caller must write Increment a streamz counter with the specified metric and field names. Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. Field names correspond to IAM request parameters and field values are their respective values. At present only "iam_principal", corresponding to IAMContext.principal, is supported. Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/backend_debug_access_count {iam_principal=[value of IAMContext.principal]} At this time we do not support: * multiple field names (though this may be supported in the future) * decrementing the counter * incrementing it by anything other than 1
- "counter": { # Options for counters # Counter options.
- "field": "A String", # The field value to attribute.
- "metric": "A String", # The metric to update.
- },
- "dataAccess": { # Write a Data Access (Gin) log # Data access options.
- },
- "cloudAudit": { # Write a Cloud Audit log # Cloud audit options.
- },
- },
- ],
- "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
- "A String",
- ],
- },
- ],
+ { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
"bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
{ # Associates `members` with a `role`.
"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
@@ -251,28 +212,28 @@
<div class="method">
<code class="details" id="list">list(name, pageToken=None, x__xgafv=None, pageSize=None)</code>
- <pre>Lists service accounts for a project.
+ <pre>Lists ServiceAccounts for a project.
Args:
- name: string, Required. The resource name of the project associated with the service accounts, such as "projects/123" (required)
- pageToken: string, Optional pagination token returned in an earlier [ListServiceAccountsResponse.next_page_token].
+ name: string, Required. The resource name of the project associated with the service accounts, such as `projects/my-project-123`. (required)
+ pageToken: string, Optional pagination token returned in an earlier ListServiceAccountsResponse.next_page_token.
x__xgafv: string, V1 error format.
- pageSize: integer, Optional limit on the number of service accounts to include in the response. Further accounts can subsequently be obtained by including the [ListServiceAccountsResponse.next_page_token] in a subsequent request.
+ pageSize: integer, Optional limit on the number of service accounts to include in the response. Further accounts can subsequently be obtained by including the ListServiceAccountsResponse.next_page_token in a subsequent request.
Returns:
An object of the form:
{ # The service account list response.
- "nextPageToken": "A String", # To retrieve the next page of results, set [ListServiceAccountsRequest.page_token] to this value.
+ "nextPageToken": "A String", # To retrieve the next page of results, set ListServiceAccountsRequest.page_token to this value.
"accounts": [ # The list of matching service accounts.
- { # A service account in the Identity and Access Management API. To create a service account, you specify the project_id and account_id for the account. The account_id is unique within the project, and used to generate the service account email address and a stable unique id. All other methods can identify accounts using the format "projects/{project}/serviceAccounts/{account}". Using '-' as a wildcard for the project, will infer the project from the account. The account value can be the email address or the unique_id of the service account.
+ { # A service account in the Identity and Access Management API. To create a service account, specify the `project_id` and the `account_id` for the account. The `account_id` is unique within the project, and is used to generate the service account email address and a stable `unique_id`. If the account already exists, the account's resource name is returned in util::Status's ResourceInfo.resource_name in the format of projects/{project}/serviceAccounts/{email}. The caller can use the name in other methods to access the account. All other methods can identify the service account using the format `projects/{project}/serviceAccounts/{account}`. Using `-` as a wildcard for the project will infer the project from the account. The `account` value can be the `email` address or the `unique_id` of the service account.
"oauth2ClientId": "A String", # @OutputOnly. The OAuth2 client id for the service account. This is used in conjunction with the OAuth2 clientconfig API to make three legged OAuth2 (3LO) flows to access the data of Google users.
"displayName": "A String", # Optional. A user-specified description of the service account. Must be fewer than 100 UTF-8 bytes.
- "name": "A String", # The resource name of the service account in the format "projects/{project}/serviceAccounts/{account}". In requests using '-' as a wildcard for the project, will infer the project from the account and the account value can be the email address or the unique_id of the service account. In responses the resource name will always be in the format "projects/{project}/serviceAccounts/{email}".
+ "name": "A String", # The resource name of the service account in the following format: `projects/{project}/serviceAccounts/{account}`. Requests using `-` as a wildcard for the project will infer the project from the `account` and the `account` value can be the `email` address or the `unique_id` of the service account. In responses the resource name will always be in the format `projects/{project}/serviceAccounts/{email}`.
"projectId": "A String", # @OutputOnly The id of the project that owns the service account.
"etag": "A String", # Used to perform a consistent read-modify-write.
- "uniqueId": "A String", # @OutputOnly unique and stable id of the service account.
- "email": "A String", # @OutputOnly Email address of the service account.
+ "uniqueId": "A String", # @OutputOnly The unique and stable id of the service account.
+ "email": "A String", # @OutputOnly The email address of the service account.
},
],
}</pre>
@@ -294,54 +255,15 @@
<div class="method">
<code class="details" id="setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</code>
- <pre>Sets the IAM access control policy for the specified IAM resource.
+ <pre>Sets the IAM access control policy for a ServiceAccount.
Args:
- resource: string, REQUIRED: The resource for which the policy is being specified. `resource` is usually specified as a path, such as `projects/*project*/zones/*zone*/disks/*disk*`. The format for the path specified in this value is resource specific and is specified in the `setIamPolicy` documentation. (required)
+ resource: string, REQUIRED: The resource for which the policy is being specified. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Request message for `SetIamPolicy` method.
- "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com"] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
- "rules": [
- { # A rule to be applied in a Policy.
- "notIn": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is not in this set of entries. The format for in and not_in entries is the same as for members in a Binding (see google/iam/v1/policy.proto).
- "A String",
- ],
- "description": "A String", # Human-readable description of the rule.
- "in": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in this set of entries.
- "A String",
- ],
- "action": "A String", # Required
- "conditions": [ # Additional restrictions that must be met
- { # A condition to be met.
- "iam": "A String", # Trusted attributes supplied by the IAM system.
- "svc": "A String", # Trusted attributes discharged by the service.
- "value": "A String", # The object of the condition. Exactly one of these must be set.
- "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
- "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
- "A String",
- ],
- "op": "A String", # An operator to apply the subject with.
- },
- ],
- "logConfig": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
- { # Specifies what kind of log the caller must write Increment a streamz counter with the specified metric and field names. Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. Field names correspond to IAM request parameters and field values are their respective values. At present only "iam_principal", corresponding to IAMContext.principal, is supported. Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/backend_debug_access_count {iam_principal=[value of IAMContext.principal]} At this time we do not support: * multiple field names (though this may be supported in the future) * decrementing the counter * incrementing it by anything other than 1
- "counter": { # Options for counters # Counter options.
- "field": "A String", # The field value to attribute.
- "metric": "A String", # The metric to update.
- },
- "dataAccess": { # Write a Data Access (Gin) log # Data access options.
- },
- "cloudAudit": { # Write a Cloud Audit log # Cloud audit options.
- },
- },
- ],
- "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
- "A String",
- ],
- },
- ],
+ "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
"bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
{ # Associates `members` with a `role`.
"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
@@ -360,46 +282,7 @@
Returns:
An object of the form:
- { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com"] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
- "rules": [
- { # A rule to be applied in a Policy.
- "notIn": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is not in this set of entries. The format for in and not_in entries is the same as for members in a Binding (see google/iam/v1/policy.proto).
- "A String",
- ],
- "description": "A String", # Human-readable description of the rule.
- "in": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in this set of entries.
- "A String",
- ],
- "action": "A String", # Required
- "conditions": [ # Additional restrictions that must be met
- { # A condition to be met.
- "iam": "A String", # Trusted attributes supplied by the IAM system.
- "svc": "A String", # Trusted attributes discharged by the service.
- "value": "A String", # The object of the condition. Exactly one of these must be set.
- "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
- "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
- "A String",
- ],
- "op": "A String", # An operator to apply the subject with.
- },
- ],
- "logConfig": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
- { # Specifies what kind of log the caller must write Increment a streamz counter with the specified metric and field names. Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. Field names correspond to IAM request parameters and field values are their respective values. At present only "iam_principal", corresponding to IAMContext.principal, is supported. Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/backend_debug_access_count {iam_principal=[value of IAMContext.principal]} At this time we do not support: * multiple field names (though this may be supported in the future) * decrementing the counter * incrementing it by anything other than 1
- "counter": { # Options for counters # Counter options.
- "field": "A String", # The field value to attribute.
- "metric": "A String", # The metric to update.
- },
- "dataAccess": { # Write a Data Access (Gin) log # Data access options.
- },
- "cloudAudit": { # Write a Cloud Audit log # Cloud audit options.
- },
- },
- ],
- "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
- "A String",
- ],
- },
- ],
+ { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
"bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
{ # Associates `members` with a `role`.
"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
@@ -415,15 +298,15 @@
<div class="method">
<code class="details" id="signBlob">signBlob(name, body, x__xgafv=None)</code>
- <pre>Signs a blob using a service account.
+ <pre>Signs a blob using a service account's system-managed private key.
Args:
- name: string, The resource name of the service account in the format "projects/{project}/serviceAccounts/{account}". Using '-' as a wildcard for the project, will infer the project from the account. The account value can be the email address or the unique_id of the service account. (required)
+ name: string, The resource name of the service account in the following format: `projects/{project}/serviceAccounts/{account}`. Using `-` as a wildcard for the project will infer the project from the account. The `account` value can be the `email` address or the `unique_id` of the service account. (required)
body: object, The request body. (required)
The object takes the form of:
{ # The service account sign blob request.
- "bytesToSign": "A String", # The bytes to sign
+ "bytesToSign": "A String", # The bytes to sign.
}
x__xgafv: string, V1 error format.
@@ -439,15 +322,15 @@
<div class="method">
<code class="details" id="testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</code>
- <pre>Tests the specified permissions against the IAM access control policy for the specified IAM resource.
+ <pre>Tests the specified permissions against the IAM access control policy for a ServiceAccount.
Args:
- resource: string, REQUIRED: The resource for which the policy detail is being requested. `resource` is usually specified as a path, such as `projects/*project*/zones/*zone*/disks/*disk*`. The format for the path specified in this value is resource specific and is specified in the `testIamPermissions` documentation. (required)
+ resource: string, REQUIRED: The resource for which the policy detail is being requested. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Request message for `TestIamPermissions` method.
- "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see IAM Overview.
+ "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
"A String",
],
}
@@ -466,21 +349,21 @@
<div class="method">
<code class="details" id="update">update(name, body, x__xgafv=None)</code>
- <pre>Updates a service account. Currently, only the following fields are updatable: 'display_name' . The 'etag' is mandatory.
+ <pre>Updates a ServiceAccount. Currently, only the following fields are updatable: `display_name` . The `etag` is mandatory.
Args:
- name: string, The resource name of the service account in the format "projects/{project}/serviceAccounts/{account}". In requests using '-' as a wildcard for the project, will infer the project from the account and the account value can be the email address or the unique_id of the service account. In responses the resource name will always be in the format "projects/{project}/serviceAccounts/{email}". (required)
+ name: string, The resource name of the service account in the following format: `projects/{project}/serviceAccounts/{account}`. Requests using `-` as a wildcard for the project will infer the project from the `account` and the `account` value can be the `email` address or the `unique_id` of the service account. In responses the resource name will always be in the format `projects/{project}/serviceAccounts/{email}`. (required)
body: object, The request body. (required)
The object takes the form of:
-{ # A service account in the Identity and Access Management API. To create a service account, you specify the project_id and account_id for the account. The account_id is unique within the project, and used to generate the service account email address and a stable unique id. All other methods can identify accounts using the format "projects/{project}/serviceAccounts/{account}". Using '-' as a wildcard for the project, will infer the project from the account. The account value can be the email address or the unique_id of the service account.
+{ # A service account in the Identity and Access Management API. To create a service account, specify the `project_id` and the `account_id` for the account. The `account_id` is unique within the project, and is used to generate the service account email address and a stable `unique_id`. If the account already exists, the account's resource name is returned in util::Status's ResourceInfo.resource_name in the format of projects/{project}/serviceAccounts/{email}. The caller can use the name in other methods to access the account. All other methods can identify the service account using the format `projects/{project}/serviceAccounts/{account}`. Using `-` as a wildcard for the project will infer the project from the account. The `account` value can be the `email` address or the `unique_id` of the service account.
"oauth2ClientId": "A String", # @OutputOnly. The OAuth2 client id for the service account. This is used in conjunction with the OAuth2 clientconfig API to make three legged OAuth2 (3LO) flows to access the data of Google users.
"displayName": "A String", # Optional. A user-specified description of the service account. Must be fewer than 100 UTF-8 bytes.
- "name": "A String", # The resource name of the service account in the format "projects/{project}/serviceAccounts/{account}". In requests using '-' as a wildcard for the project, will infer the project from the account and the account value can be the email address or the unique_id of the service account. In responses the resource name will always be in the format "projects/{project}/serviceAccounts/{email}".
+ "name": "A String", # The resource name of the service account in the following format: `projects/{project}/serviceAccounts/{account}`. Requests using `-` as a wildcard for the project will infer the project from the `account` and the `account` value can be the `email` address or the `unique_id` of the service account. In responses the resource name will always be in the format `projects/{project}/serviceAccounts/{email}`.
"projectId": "A String", # @OutputOnly The id of the project that owns the service account.
"etag": "A String", # Used to perform a consistent read-modify-write.
- "uniqueId": "A String", # @OutputOnly unique and stable id of the service account.
- "email": "A String", # @OutputOnly Email address of the service account.
+ "uniqueId": "A String", # @OutputOnly The unique and stable id of the service account.
+ "email": "A String", # @OutputOnly The email address of the service account.
}
x__xgafv: string, V1 error format.
@@ -488,14 +371,14 @@
Returns:
An object of the form:
- { # A service account in the Identity and Access Management API. To create a service account, you specify the project_id and account_id for the account. The account_id is unique within the project, and used to generate the service account email address and a stable unique id. All other methods can identify accounts using the format "projects/{project}/serviceAccounts/{account}". Using '-' as a wildcard for the project, will infer the project from the account. The account value can be the email address or the unique_id of the service account.
+ { # A service account in the Identity and Access Management API. To create a service account, specify the `project_id` and the `account_id` for the account. The `account_id` is unique within the project, and is used to generate the service account email address and a stable `unique_id`. If the account already exists, the account's resource name is returned in util::Status's ResourceInfo.resource_name in the format of projects/{project}/serviceAccounts/{email}. The caller can use the name in other methods to access the account. All other methods can identify the service account using the format `projects/{project}/serviceAccounts/{account}`. Using `-` as a wildcard for the project will infer the project from the account. The `account` value can be the `email` address or the `unique_id` of the service account.
"oauth2ClientId": "A String", # @OutputOnly. The OAuth2 client id for the service account. This is used in conjunction with the OAuth2 clientconfig API to make three legged OAuth2 (3LO) flows to access the data of Google users.
"displayName": "A String", # Optional. A user-specified description of the service account. Must be fewer than 100 UTF-8 bytes.
- "name": "A String", # The resource name of the service account in the format "projects/{project}/serviceAccounts/{account}". In requests using '-' as a wildcard for the project, will infer the project from the account and the account value can be the email address or the unique_id of the service account. In responses the resource name will always be in the format "projects/{project}/serviceAccounts/{email}".
+ "name": "A String", # The resource name of the service account in the following format: `projects/{project}/serviceAccounts/{account}`. Requests using `-` as a wildcard for the project will infer the project from the `account` and the `account` value can be the `email` address or the `unique_id` of the service account. In responses the resource name will always be in the format `projects/{project}/serviceAccounts/{email}`.
"projectId": "A String", # @OutputOnly The id of the project that owns the service account.
"etag": "A String", # Used to perform a consistent read-modify-write.
- "uniqueId": "A String", # @OutputOnly unique and stable id of the service account.
- "email": "A String", # @OutputOnly Email address of the service account.
+ "uniqueId": "A String", # @OutputOnly The unique and stable id of the service account.
+ "email": "A String", # @OutputOnly The email address of the service account.
}</pre>
</div>
diff --git a/docs/dyn/iam_v1.projects.serviceAccounts.keys.html b/docs/dyn/iam_v1.projects.serviceAccounts.keys.html
index 56b7b2d..8532552 100644
--- a/docs/dyn/iam_v1.projects.serviceAccounts.keys.html
+++ b/docs/dyn/iam_v1.projects.serviceAccounts.keys.html
@@ -72,32 +72,33 @@
</style>
-<h1><a href="iam_v1.html">Google Identity and Access Management API</a> . <a href="iam_v1.projects.html">projects</a> . <a href="iam_v1.projects.serviceAccounts.html">serviceAccounts</a> . <a href="iam_v1.projects.serviceAccounts.keys.html">keys</a></h1>
+<h1><a href="iam_v1.html">Google Identity and Access Management (IAM) API</a> . <a href="iam_v1.projects.html">projects</a> . <a href="iam_v1.projects.serviceAccounts.html">serviceAccounts</a> . <a href="iam_v1.projects.serviceAccounts.keys.html">keys</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#create">create(name, body, x__xgafv=None)</a></code></p>
-<p class="firstline">Creates a service account key and returns it.</p>
+<p class="firstline">Creates a ServiceAccountKey and returns it.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
-<p class="firstline">Deletes a service account key.</p>
+<p class="firstline">Deletes a ServiceAccountKey.</p>
<p class="toc_element">
- <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
+ <code><a href="#get">get(name, publicKeyType=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the ServiceAccountKey by key id.</p>
<p class="toc_element">
<code><a href="#list">list(name, keyTypes=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Lists service account keys</p>
+<p class="firstline">Lists ServiceAccountKeys.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(name, body, x__xgafv=None)</code>
- <pre>Creates a service account key and returns it.
+ <pre>Creates a ServiceAccountKey and returns it.
Args:
- name: string, The resource name of the service account in the format "projects/{project}/serviceAccounts/{account}". Using '-' as a wildcard for the project, will infer the project from the account. The account value can be the email address or the unique_id of the service account. (required)
+ name: string, The resource name of the service account in the following format: `projects/{project}/serviceAccounts/{account}`. Using `-` as a wildcard for the project will infer the project from the account. The `account` value can be the `email` address or the `unique_id` of the service account. (required)
body: object, The request body. (required)
The object takes the form of:
{ # The service account key create request.
- "privateKeyType": "A String", # The type of the key requested. GOOGLE_CREDENTIALS is the default key type.
+ "privateKeyType": "A String", # The output format of the private key. `GOOGLE_CREDENTIALS_FILE` is the default output format.
+ "keyAlgorithm": "A String", # Which type of key and algorithm to use for the key. The default is currently a 4K RSA key. However this may change in the future.
}
x__xgafv: string, V1 error format.
@@ -105,21 +106,23 @@
Returns:
An object of the form:
- { # Represents a service account key. A service account can have 0 or more key pairs. The private keys for these are not stored by Google. ServiceAccountKeys are immutable.
- "privateKeyType": "A String", # The type of the private key.
- "privateKeyData": "A String", # The key data.
- "validBeforeTime": "A String", # The key can be used before this timestamp.
- "name": "A String", # The resource name of the service account key in the format "projects/{project}/serviceAccounts/{email}/keys/{key}".
+ { # Represents a service account key. A service account has two sets of key-pairs: user-managed, and system-managed. User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key. System-managed key-pairs are managed automatically by Google, and rotated daily without user intervention. The private key never leaves Google's servers to maximize security. Public keys for all service accounts are also published at the OAuth2 Service Account API.
+ "privateKeyData": "A String", # The private key data. Only provided in `CreateServiceAccountKey` responses.
"validAfterTime": "A String", # The key can be used after this timestamp.
+ "validBeforeTime": "A String", # The key can be used before this timestamp.
+ "keyAlgorithm": "A String", # Specifies the algorithm (and possibly key size) for the key.
+ "privateKeyType": "A String", # The output format for the private key. Only provided in `CreateServiceAccountKey` responses, not in `GetServiceAccountKey` or `ListServiceAccountKey` responses. Google never exposes system-managed private keys, and never retains user-managed private keys.
+ "publicKeyData": "A String", # The public key data. Only provided in `GetServiceAccountKey` responses.
+ "name": "A String", # The resource name of the service account key in the following format `projects/{project}/serviceAccounts/{account}/keys/{key}`.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
- <pre>Deletes a service account key.
+ <pre>Deletes a ServiceAccountKey.
Args:
- name: string, The resource name of the service account key in the format "projects/{project}/serviceAccounts/{account}/keys/{key}". Using '-' as a wildcard for the project will infer the project from the account. The account value can be the email address or the unique_id of the service account. (required)
+ name: string, The resource name of the service account key in the following format: `projects/{project}/serviceAccounts/{account}/keys/{key}`. Using `-` as a wildcard for the project will infer the project from the account. The `account` value can be the `email` address or the `unique_id` of the service account. (required)
x__xgafv: string, V1 error format.
Returns:
@@ -130,32 +133,35 @@
</div>
<div class="method">
- <code class="details" id="get">get(name, x__xgafv=None)</code>
+ <code class="details" id="get">get(name, publicKeyType=None, x__xgafv=None)</code>
<pre>Gets the ServiceAccountKey by key id.
Args:
- name: string, The resource name of the service account key in the format "projects/{project}/serviceAccounts/{account}/keys/{key}". Using '-' as a wildcard for the project will infer the project from the account. The account value can be the email address or the unique_id of the service account. (required)
+ name: string, The resource name of the service account key in the following format: `projects/{project}/serviceAccounts/{account}/keys/{key}`. Using `-` as a wildcard for the project will infer the project from the account. The `account` value can be the `email` address or the `unique_id` of the service account. (required)
+ publicKeyType: string, The output format of the public key requested. X509_PEM is the default output format.
x__xgafv: string, V1 error format.
Returns:
An object of the form:
- { # Represents a service account key. A service account can have 0 or more key pairs. The private keys for these are not stored by Google. ServiceAccountKeys are immutable.
- "privateKeyType": "A String", # The type of the private key.
- "privateKeyData": "A String", # The key data.
- "validBeforeTime": "A String", # The key can be used before this timestamp.
- "name": "A String", # The resource name of the service account key in the format "projects/{project}/serviceAccounts/{email}/keys/{key}".
+ { # Represents a service account key. A service account has two sets of key-pairs: user-managed, and system-managed. User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key. System-managed key-pairs are managed automatically by Google, and rotated daily without user intervention. The private key never leaves Google's servers to maximize security. Public keys for all service accounts are also published at the OAuth2 Service Account API.
+ "privateKeyData": "A String", # The private key data. Only provided in `CreateServiceAccountKey` responses.
"validAfterTime": "A String", # The key can be used after this timestamp.
+ "validBeforeTime": "A String", # The key can be used before this timestamp.
+ "keyAlgorithm": "A String", # Specifies the algorithm (and possibly key size) for the key.
+ "privateKeyType": "A String", # The output format for the private key. Only provided in `CreateServiceAccountKey` responses, not in `GetServiceAccountKey` or `ListServiceAccountKey` responses. Google never exposes system-managed private keys, and never retains user-managed private keys.
+ "publicKeyData": "A String", # The public key data. Only provided in `GetServiceAccountKey` responses.
+ "name": "A String", # The resource name of the service account key in the following format `projects/{project}/serviceAccounts/{account}/keys/{key}`.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(name, keyTypes=None, x__xgafv=None)</code>
- <pre>Lists service account keys
+ <pre>Lists ServiceAccountKeys.
Args:
- name: string, The resource name of the service account in the format "projects/{project}/serviceAccounts/{account}". Using '-' as a wildcard for the project, will infer the project from the account. The account value can be the email address or the unique_id of the service account. (required)
- keyTypes: string, The type of keys the user wants to list. If empty, all key types are included in the response. Duplicate key types are not allowed. (repeated)
+ name: string, The resource name of the service account in the following format: `projects/{project}/serviceAccounts/{account}`. Using `-` as a wildcard for the project, will infer the project from the account. The `account` value can be the `email` address or the `unique_id` of the service account. (required)
+ keyTypes: string, Filters the types of keys the user wants to include in the list response. Duplicate key types are not allowed. If no key type is provided, all keys are returned. (repeated)
x__xgafv: string, V1 error format.
Returns:
@@ -163,12 +169,14 @@
{ # The service account keys list response.
"keys": [ # The public keys for the service account.
- { # Represents a service account key. A service account can have 0 or more key pairs. The private keys for these are not stored by Google. ServiceAccountKeys are immutable.
- "privateKeyType": "A String", # The type of the private key.
- "privateKeyData": "A String", # The key data.
- "validBeforeTime": "A String", # The key can be used before this timestamp.
- "name": "A String", # The resource name of the service account key in the format "projects/{project}/serviceAccounts/{email}/keys/{key}".
+ { # Represents a service account key. A service account has two sets of key-pairs: user-managed, and system-managed. User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key. System-managed key-pairs are managed automatically by Google, and rotated daily without user intervention. The private key never leaves Google's servers to maximize security. Public keys for all service accounts are also published at the OAuth2 Service Account API.
+ "privateKeyData": "A String", # The private key data. Only provided in `CreateServiceAccountKey` responses.
"validAfterTime": "A String", # The key can be used after this timestamp.
+ "validBeforeTime": "A String", # The key can be used before this timestamp.
+ "keyAlgorithm": "A String", # Specifies the algorithm (and possibly key size) for the key.
+ "privateKeyType": "A String", # The output format for the private key. Only provided in `CreateServiceAccountKey` responses, not in `GetServiceAccountKey` or `ListServiceAccountKey` responses. Google never exposes system-managed private keys, and never retains user-managed private keys.
+ "publicKeyData": "A String", # The public key data. Only provided in `GetServiceAccountKey` responses.
+ "name": "A String", # The resource name of the service account key in the following format `projects/{project}/serviceAccounts/{account}/keys/{key}`.
},
],
}</pre>
diff --git a/docs/dyn/iam_v1.roles.html b/docs/dyn/iam_v1.roles.html
new file mode 100644
index 0000000..f40c785
--- /dev/null
+++ b/docs/dyn/iam_v1.roles.html
@@ -0,0 +1,109 @@
+<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="iam_v1.html">Google Identity and Access Management (IAM) API</a> . <a href="iam_v1.roles.html">roles</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#queryGrantableRoles">queryGrantableRoles(body, x__xgafv=None)</a></code></p>
+<p class="firstline">Queries roles that can be granted on a particular resource. A role is grantable if it can be used as the role in a binding for a policy for that resource.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="queryGrantableRoles">queryGrantableRoles(body, x__xgafv=None)</code>
+ <pre>Queries roles that can be granted on a particular resource. A role is grantable if it can be used as the role in a binding for a policy for that resource.
+
+Args:
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The grantable role query request.
+ "fullResourceName": "A String", # Required. The full resource name to query from the list of grantable roles. The name follows the Google Cloud Platform resource format. For example, a Cloud Platform project with id `my-project` will be named `//cloudresourcemanager.googleapis.com/projects/my-project`.
+ }
+
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # The grantable role query response.
+ "roles": [ # The list of matching roles.
+ { # A role in the Identity and Access Management API.
+ "description": "A String", # Optional. A human-readable description for the role.
+ "name": "A String", # The name of the role. When Role is used in CreateRole, the role name must not be set. When Role is used in output and other input such as UpdateRole, the role name is the complete path, e.g., roles/logging.viewer for curated roles and organizations/{organization-id}/roles/logging.viewer for custom roles.
+ "title": "A String", # Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes.
+ },
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/identitytoolkit_v3.relyingparty.html b/docs/dyn/identitytoolkit_v3.relyingparty.html
index bf6a581..6a678a6 100644
--- a/docs/dyn/identitytoolkit_v3.relyingparty.html
+++ b/docs/dyn/identitytoolkit_v3.relyingparty.html
@@ -147,6 +147,9 @@
"context": "A String", # The opaque value used by the client to maintain context info between the authentication request and the IDP callback.
"appId": "A String", # The app ID of the mobile app, base64(CERT_SHA1):PACKAGE_NAME for Android, BUNDLE_ID for iOS.
"continueUri": "A String", # The URI to which the IDP redirects the user after the federated login flow.
+ "customParameter": { # The query parameter that client can customize by themselves in auth url. The following parameters are reserved for server so that they cannot be customized by clients: client_id, response_type, scope, redirect_uri, state.
+ "a_key": "A String", # The customized query parameter.
+ },
"identifier": "A String", # The email or federated ID of the user.
}
@@ -221,6 +224,7 @@
"photoUrl": "A String", # The URL of the user profile photo.
"emailVerified": True or False, # Whether the email has been verified.
"lastLoginAt": "A String", # last login timestamp.
+ "customAuth": True or False, # Whether the user is authenticated by the developer.
"disabled": True or False, # Whether the user is disabled.
"version": 42, # Version of the user's password.
"providerUserInfo": [ # The IDP of the user.
@@ -232,14 +236,14 @@
"providerId": "A String", # The IdP ID. For white listed IdPs it's a short domain name, e.g., google.com, aol.com, live.net and yahoo.com. For other OpenID IdPs it's the OP identifier.
"rawId": "A String", # User's raw identifier directly returned from IDP.
"email": "A String", # User's email at IDP.
- "screenName": "A String", # User's screen name at Twitter.
+ "screenName": "A String", # User's screen name at Twitter or login name at Github.
},
],
"passwordUpdatedAt": 3.14, # The timestamp when the password was last updated.
"salt": "A String", # The user's password salt.
"email": "A String", # The email of the user.
"createdAt": "A String", # User creation timestamp.
- "screenName": "A String", # User's screen name at Twitter.
+ "screenName": "A String", # User's screen name at Twitter or login name at Github.
},
],
}</pre>
@@ -279,6 +283,7 @@
"photoUrl": "A String", # The URL of the user profile photo.
"emailVerified": True or False, # Whether the email has been verified.
"lastLoginAt": "A String", # last login timestamp.
+ "customAuth": True or False, # Whether the user is authenticated by the developer.
"disabled": True or False, # Whether the user is disabled.
"version": 42, # Version of the user's password.
"providerUserInfo": [ # The IDP of the user.
@@ -290,14 +295,14 @@
"providerId": "A String", # The IdP ID. For white listed IdPs it's a short domain name, e.g., google.com, aol.com, live.net and yahoo.com. For other OpenID IdPs it's the OP identifier.
"rawId": "A String", # User's raw identifier directly returned from IDP.
"email": "A String", # User's email at IDP.
- "screenName": "A String", # User's screen name at Twitter.
+ "screenName": "A String", # User's screen name at Twitter or login name at Github.
},
],
"passwordUpdatedAt": 3.14, # The timestamp when the password was last updated.
"salt": "A String", # The user's password salt.
"email": "A String", # The email of the user.
"createdAt": "A String", # User creation timestamp.
- "screenName": "A String", # User's screen name at Twitter.
+ "screenName": "A String", # User's screen name at Twitter or login name at Github.
},
],
}</pre>
@@ -450,8 +455,10 @@
An object of the form:
{ # Response of resetting the password.
+ "requestType": "A String", # The request type.
"kind": "identitytoolkit#ResetPasswordResponse", # The fixed string "identitytoolkit#ResetPasswordResponse".
- "email": "A String", # The user's email.
+ "email": "A String", # The user's email. If the out-of-band code is for email recovery, the user's original email.
+ "newEmail": "A String", # If the out-of-band code is for email recovery, the user's new email.
}</pre>
</div>
@@ -666,6 +673,7 @@
"photoUrl": "A String", # The URL of the user profile photo.
"emailVerified": True or False, # Whether the email has been verified.
"lastLoginAt": "A String", # last login timestamp.
+ "customAuth": True or False, # Whether the user is authenticated by the developer.
"disabled": True or False, # Whether the user is disabled.
"version": 42, # Version of the user's password.
"providerUserInfo": [ # The IDP of the user.
@@ -677,16 +685,17 @@
"providerId": "A String", # The IdP ID. For white listed IdPs it's a short domain name, e.g., google.com, aol.com, live.net and yahoo.com. For other OpenID IdPs it's the OP identifier.
"rawId": "A String", # User's raw identifier directly returned from IDP.
"email": "A String", # User's email at IDP.
- "screenName": "A String", # User's screen name at Twitter.
+ "screenName": "A String", # User's screen name at Twitter or login name at Github.
},
],
"passwordUpdatedAt": 3.14, # The timestamp when the password was last updated.
"salt": "A String", # The user's password salt.
"email": "A String", # The email of the user.
"createdAt": "A String", # User creation timestamp.
- "screenName": "A String", # User's screen name at Twitter.
+ "screenName": "A String", # User's screen name at Twitter or login name at Github.
},
],
+ "sanityCheck": True or False, # If true, backend will do sanity check(including duplicate email and federated id) when uploading account.
"signerKey": "A String", # The key for to hash the password.
"memoryCost": 42, # Memory cost for hash calculation. Used by scrypt similar algorithms.
"saltSeparator": "A String", # The salt separator.
@@ -750,7 +759,7 @@
"oauthAccessToken": "A String", # The OAuth2 access token.
"emailRecycled": True or False, # It's true if the email is recycled.
"email": "A String", # The email returned by the IdP. NOTE: The federated login user may not own the email.
- "screenName": "A String", # The screen_name of a Twitter user.
+ "screenName": "A String", # The screen_name of a Twitter user or the login name at Github.
"nickName": "A String", # The nick name of the user.
"errorMessage": "A String", # Client error code.
"oauthTokenSecret": "A String", # The OAuth1 access token secret.
diff --git a/docs/dyn/language_v1beta1.documents.html b/docs/dyn/language_v1beta1.documents.html
index 4df363c..8e6da6b 100644
--- a/docs/dyn/language_v1beta1.documents.html
+++ b/docs/dyn/language_v1beta1.documents.html
@@ -82,7 +82,7 @@
<p class="firstline">Analyzes the sentiment of the provided text.</p>
<p class="toc_element">
<code><a href="#annotateText">annotateText(body, x__xgafv=None)</a></code></p>
-<p class="firstline">Advanced API that analyzes the document and provides a full set of text</p>
+<p class="firstline">A convenience method that provides all the features that analyzeSentiment,</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="analyzeEntities">analyzeEntities(body, x__xgafv=None)</code>
@@ -158,6 +158,7 @@
],
"language": "A String", # The language of the text, which will be the same as the language specified
# in the request or, if not specified, the automatically-detected language.
+ # See Document.language field for more details.
}</pre>
</div>
@@ -216,17 +217,15 @@
<div class="method">
<code class="details" id="annotateText">annotateText(body, x__xgafv=None)</code>
- <pre>Advanced API that analyzes the document and provides a full set of text
-annotations, including semantic, syntactic, and sentiment information. This
-API is intended for users who are familiar with machine learning and need
-in-depth text features to build upon.
+ <pre>A convenience method that provides all the features that analyzeSentiment,
+analyzeEntities, and analyzeSyntax provide in one call.
Args:
body: object, The request body. (required)
The object takes the form of:
-{ # The request message for the advanced text annotation API, which performs all
- # the above plus syntactic analysis.
+{ # The request message for the text annotation API, which can perform multiple
+ # analysis types (sentiment, entities, and syntax) in one call.
"document": { # ################################################################ # # Input document.
#
# Represents the input to API methods.
@@ -332,6 +331,7 @@
},
"language": "A String", # The language of the text, which will be the same as the language specified
# in the request or, if not specified, the automatically-detected language.
+ # See Document.language field for more details.
"sentences": [ # Sentences in the input document. Populated if the user enables
# AnnotateTextRequest.Features.extract_syntax.
{ # Represents a sentence in the input document.
diff --git a/docs/dyn/logging_v2beta1.billingAccounts.html b/docs/dyn/logging_v2beta1.billingAccounts.html
new file mode 100644
index 0000000..9a95420
--- /dev/null
+++ b/docs/dyn/logging_v2beta1.billingAccounts.html
@@ -0,0 +1,82 @@
+<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="logging_v2beta1.html">Stackdriver Logging API</a> . <a href="logging_v2beta1.billingAccounts.html">billingAccounts</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="logging_v2beta1.billingAccounts.logs.html">logs()</a></code>
+</p>
+<p class="firstline">Returns the logs Resource.</p>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/logging_v2beta1.billingAccounts.logs.html b/docs/dyn/logging_v2beta1.billingAccounts.logs.html
new file mode 100644
index 0000000..9b2dc71
--- /dev/null
+++ b/docs/dyn/logging_v2beta1.billingAccounts.logs.html
@@ -0,0 +1,109 @@
+<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="logging_v2beta1.html">Stackdriver Logging API</a> . <a href="logging_v2beta1.billingAccounts.html">billingAccounts</a> . <a href="logging_v2beta1.billingAccounts.logs.html">logs</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(logName=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Deletes a log and all its log entries.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(logName=None, x__xgafv=None)</code>
+ <pre>Deletes a log and all its log entries.
+The log will reappear if it receives new entries.
+
+Args:
+ logName: string, Required. The resource name of the log to delete. Example:
+`"projects/my-project/logs/syslog"`. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated
+ # empty messages in your APIs. A typical example is to use it as the request
+ # or the response type of an API method. For instance:
+ #
+ # service Foo {
+ # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
+ # }
+ #
+ # The JSON representation for `Empty` is empty JSON object `{}`.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/logging_v2beta1.entries.html b/docs/dyn/logging_v2beta1.entries.html
index 0dd8eba..76f5428 100644
--- a/docs/dyn/logging_v2beta1.entries.html
+++ b/docs/dyn/logging_v2beta1.entries.html
@@ -72,93 +72,171 @@
</style>
-<h1><a href="logging_v2beta1.html">Google Cloud Logging API</a> . <a href="logging_v2beta1.entries.html">entries</a></h1>
+<h1><a href="logging_v2beta1.html">Stackdriver Logging API</a> . <a href="logging_v2beta1.entries.html">entries</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#list">list(body, x__xgafv=None)</a></code></p>
-<p class="firstline">Lists log entries. Use this method to retrieve log entries from Cloud Logging. For ways to export log entries, see [Exporting Logs](/logging/docs/export).</p>
+<p class="firstline">Lists log entries. Use this method to retrieve log entries from Cloud</p>
<p class="toc_element">
<code><a href="#write">write(body, x__xgafv=None)</a></code></p>
-<p class="firstline">Writes log entries to Cloud Logging. All log entries in Cloud Logging are written by this method.</p>
+<p class="firstline">Writes log entries to Stackdriver Logging. All log entries are</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="list">list(body, x__xgafv=None)</code>
- <pre>Lists log entries. Use this method to retrieve log entries from Cloud Logging. For ways to export log entries, see [Exporting Logs](/logging/docs/export).
+ <pre>Lists log entries. Use this method to retrieve log entries from Cloud
+Logging. For ways to export log entries, see
+[Exporting Logs](/logging/docs/export).
Args:
body: object, The request body. (required)
The object takes the form of:
{ # The parameters to `ListLogEntries`.
- "orderBy": "A String", # Optional. How the results should be sorted. Presently, the only permitted values are `"timestamp asc"` (default) and `"timestamp desc"`. The first option returns entries in order of increasing values of `LogEntry.timestamp` (oldest first), and the second option returns entries in order of decreasing timestamps (newest first). Entries with equal timestamps are returned in order of `LogEntry.insertId`.
- "pageSize": 42, # Optional. The maximum number of results to return from this request. You must check for presence of `nextPageToken` to determine if additional results are available, which you can retrieve by passing the `nextPageToken` value as the `pageToken` parameter in the next request.
- "partialSuccess": True or False, # Optional. If true, read access to all projects is not required and results will be returned for the subset of projects for which read access is permitted (empty subset is permitted).
- "filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters). The filter is compared against all log entries in the projects specified by `projectIds`. Only entries that match the filter are retrieved. An empty filter matches all log entries.
- "pageToken": "A String", # Optional. If the `pageToken` parameter is supplied, then the next page of results is retrieved. The `pageToken` parameter must be set to the value of the `nextPageToken` from the previous response. The values of `projectIds`, `filter`, and `orderBy` must be the same as in the previous request.
- "projectIds": [ # Required. One or more project IDs or project numbers from which to retrieve log entries. Examples of a project ID: `"my-project-1A"`, `"1234567890"`.
+ "orderBy": "A String", # Optional. How the results should be sorted. Presently, the only permitted
+ # values are `"timestamp asc"` (default) and `"timestamp desc"`. The first
+ # option returns entries in order of increasing values of
+ # `LogEntry.timestamp` (oldest first), and the second option returns entries
+ # in order of decreasing timestamps (newest first). Entries with equal
+ # timestamps are returned in order of `LogEntry.insertId`.
+ "resourceNames": [ # Optional. One or more cloud resources from which to retrieve log entries.
+ # Example: `"projects/my-project-1A"`, `"projects/1234567890"`. Projects
+ # listed in `projectIds` are added to this list.
+ "A String",
+ ],
+ "pageSize": 42, # Optional. The maximum number of results to return from this request.
+ # Non-positive values are ignored. The presence of `nextPageToken` in the
+ # response indicates that more results might be available.
+ "filter": "A String", # Optional. A filter that chooses which log entries to return. See [Advanced
+ # Logs Filters](/logging/docs/view/advanced_filters). Only log entries that
+ # match the filter are returned. An empty filter matches all log entries.
+ "pageToken": "A String", # Optional. If present, then retrieve the next batch of results from the
+ # preceding call to this method. `pageToken` must be the value of
+ # `nextPageToken` from the previous response. The values of other method
+ # parameters should be identical to those in the previous call.
+ "projectIds": [ # Deprecated. One or more project identifiers or project numbers from which
+ # to retrieve log entries. Examples: `"my-project-1A"`, `"1234567890"`. If
+ # present, these project identifiers are converted to resource format and
+ # added to the list of resources in `resourceNames`. Callers should use
+ # `resourceNames` rather than this parameter.
"A String",
],
}
x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
{ # Result returned from `ListLogEntries`.
- "nextPageToken": "A String", # If there are more results than were returned, then `nextPageToken` is included in the response. To get the next set of results, call this method again using the value of `nextPageToken` as `pageToken`.
- "projectIdErrors": { # If partial_success is true, contains the project ids that had errors and the associated errors.
- "a_key": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons.
- "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
- },
- ],
- },
- },
+ "nextPageToken": "A String", # If there might be more results than appear in this response, then
+ # `nextPageToken` is included. To get the next set of results, call this
+ # method again using the value of `nextPageToken` as `pageToken`.
"entries": [ # A list of log entries.
{ # An individual entry in a log.
- "httpRequest": { # A common proto for logging HTTP requests. # Optional. Information about the HTTP request associated with this log entry, if applicable.
- "status": 42, # The response code indicating the status of response. Examples: 200, 404.
- "cacheValidatedWithOriginServer": True or False, # Whether or not the response was validated with the origin server before being served from cache. This field is only meaningful if `cache_hit` is True.
- "cacheHit": True or False, # Whether or not an entity was served from cache (with or without validation).
- "cacheFillBytes": "A String", # The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted.
- "requestUrl": "A String", # The scheme (http, https), the host name, the path and the query portion of the URL that was requested. Example: `"http://example.com/some/info?color=red"`.
- "cacheLookup": True or False, # Whether or not a cache lookup was attempted.
+ "httpRequest": { # A common proto for logging HTTP requests. Only contains semantics # Optional. Information about the HTTP request associated with this
+ # log entry, if applicable.
+ # defined by the HTTP specification. Product-specific logging
+ # information MUST be defined in a separate message.
+ "status": 42, # The response code indicating the status of response.
+ # Examples: 200, 404.
+ "cacheValidatedWithOriginServer": True or False, # Whether or not the response was validated with the origin server before
+ # being served from cache. This field is only meaningful if `cache_hit` is
+ # True.
"requestMethod": "A String", # The request method. Examples: `"GET"`, `"HEAD"`, `"PUT"`, `"POST"`.
- "referer": "A String", # The referer URL of the request, as defined in [HTTP/1.1 Header Field Definitions](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).
- "remoteIp": "A String", # The IP address (IPv4 or IPv6) of the client that issued the HTTP request. Examples: `"192.168.1.1"`, `"FE80::0202:B3FF:FE1E:8329"`.
- "userAgent": "A String", # The user agent sent by the client. Example: `"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)"`.
- "requestSize": "A String", # The size of the HTTP request message in bytes, including the request headers and the request body.
- "responseSize": "A String", # The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.
+ "latency": "A String", # The request processing latency on the server, from the time the request was
+ # received until the response was sent.
+ "cacheFillBytes": "A String", # The number of HTTP response bytes inserted into cache. Set only when a
+ # cache fill was attempted.
+ "requestUrl": "A String", # The scheme (http, https), the host name, the path and the query
+ # portion of the URL that was requested.
+ # Example: `"http://example.com/some/info?color=red"`.
+ "serverIp": "A String", # The IP address (IPv4 or IPv6) of the origin server that the request was
+ # sent to.
+ "cacheLookup": True or False, # Whether or not a cache lookup was attempted.
+ "cacheHit": True or False, # Whether or not an entity was served from cache
+ # (with or without validation).
+ "referer": "A String", # The referer URL of the request, as defined in
+ # [HTTP/1.1 Header Field Definitions](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).
+ "remoteIp": "A String", # The IP address (IPv4 or IPv6) of the client that issued the HTTP
+ # request. Examples: `"192.168.1.1"`, `"FE80::0202:B3FF:FE1E:8329"`.
+ "userAgent": "A String", # The user agent sent by the client. Example:
+ # `"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)"`.
+ "requestSize": "A String", # The size of the HTTP request message in bytes, including the request
+ # headers and the request body.
+ "responseSize": "A String", # The size of the HTTP response message sent back to the client, in bytes,
+ # including the response headers and the response body.
},
- "resource": { # An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The `type` field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the `labels` field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for `"gce_instance"` has labels `"instance_id"` and `"zone"`: { "type": "gce_instance", "labels": { "instance_id": "my-instance", "zone": "us-central1-a" }} # Required. The monitored resource associated with this log entry. Example: a log entry that reports a database error would be associated with the monitored resource designating the particular database that reported the error.
- "labels": { # Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Cloud SQL databases use the labels `"database_id"` and `"zone"`.
+ "resource": { # An object representing a resource that can be used for monitoring, logging, # Required. The monitored resource associated with this log entry.
+ # Example: a log entry that reports a database error would be
+ # associated with the monitored resource designating the particular
+ # database that reported the error.
+ # billing, or other purposes. Examples include virtual machine instances,
+ # databases, and storage devices such as disks. The `type` field identifies a
+ # MonitoredResourceDescriptor object that describes the resource's
+ # schema. Information in the `labels` field identifies the actual resource and
+ # its attributes according to the schema. For example, a particular Compute
+ # Engine VM instance could be represented by the following object, because the
+ # MonitoredResourceDescriptor for `"gce_instance"` has labels
+ # `"instance_id"` and `"zone"`:
+ #
+ # { "type": "gce_instance",
+ # "labels": { "instance_id": "12345678901234",
+ # "zone": "us-central1-a" }}
+ "labels": { # Required. Values for all of the labels listed in the associated monitored
+ # resource descriptor. For example, Cloud SQL databases use the labels
+ # `"database_id"` and `"zone"`.
"a_key": "A String",
},
- "type": "A String", # Required. The monitored resource type. This field must match the `type` field of a MonitoredResourceDescriptor object. For example, the type of a Cloud SQL database is `"cloudsql_database"`.
+ "type": "A String", # Required. The monitored resource type. This field must match
+ # the `type` field of a MonitoredResourceDescriptor object. For
+ # example, the type of a Cloud SQL database is `"cloudsql_database"`.
},
- "severity": "A String", # Optional. The severity of the log entry. The default value is `LogSeverity.DEFAULT`.
+ "severity": "A String", # Optional. The severity of the log entry. The default value is
+ # `LogSeverity.DEFAULT`.
"textPayload": "A String", # The log entry payload, represented as a Unicode string (UTF-8).
- "timestamp": "A String", # Optional. The time the event described by the log entry occurred. If omitted, Cloud Logging will use the time the log entry is written.
- "labels": { # Optional. A set of user-defined (key, value) data that provides additional information about the log entry.
+ "timestamp": "A String", # Optional. The time the event described by the log entry occurred. If
+ # omitted, Stackdriver Logging will use the time the log entry is received.
+ "labels": { # Optional. A set of user-defined (key, value) data that provides additional
+ # information about the log entry.
"a_key": "A String",
},
- "insertId": "A String", # Optional. A unique ID for the log entry. If you provide this field, the logging service considers other log entries in the same log with the same ID as duplicates which can be removed. If omitted, Cloud Logging will generate a unique ID for this log entry.
- "jsonPayload": { # The log entry payload, represented as a structure that is expressed as a JSON object.
+ "insertId": "A String", # Optional. A unique ID for the log entry. If you provide this
+ # field, the logging service considers other log entries in the
+ # same project with the same ID as duplicates which can be removed. If
+ # omitted, Stackdriver Logging will generate a unique ID for this
+ # log entry.
+ "jsonPayload": { # The log entry payload, represented as a structure that
+ # is expressed as a JSON object.
"a_key": "", # Properties of the object.
},
- "logName": "A String", # Required. The resource name of the log to which this log entry belongs. The format of the name is `"projects/
- # /logs/"`. Examples: `"projects/my-projectid/logs/syslog"`, `"projects/1234567890/logs/library.googleapis.com%2Fbook_log"`. The log ID part of resource name must be less than 512 characters long and can only include the following characters: upper and lower case alphanumeric characters: [A-Za-z0-9]; and punctuation characters: forward-slash, underscore, hyphen, and period. Forward-slash (`/`) characters in the log ID must be URL-encoded.
- "protoPayload": { # The log entry payload, represented as a protocol buffer. You can only use `protoPayload` values that belong to a set of approved types.
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ "logName": "A String", # Required. The resource name of the log to which this log entry
+ # belongs. The format of the name is
+ # `"projects/<project-id>/logs/<log-id>"`. Examples:
+ # `"projects/my-projectid/logs/syslog"`,
+ # `"projects/my-projectid/logs/library.googleapis.com%2Fbook_log"`.
+ #
+ # The log ID part of resource name must be less than 512 characters
+ # long and can only include the following characters: upper and
+ # lower case alphanumeric characters: [A-Za-z0-9]; and punctuation
+ # characters: forward-slash, underscore, hyphen, and period.
+ # Forward-slash (`/`) characters in the log ID must be URL-encoded.
+ "protoPayload": { # The log entry payload, represented as a protocol buffer. Some
+ # Google Cloud Platform services use this field for their log
+ # entry payloads.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "operation": { # Additional information about a potentially long-running operation with which a log entry is associated. # Optional. Information about an operation associated with the log entry, if applicable.
+ "operation": { # Additional information about a potentially long-running operation with which # Optional. Information about an operation associated with the log entry, if
+ # applicable.
+ # a log entry is associated.
"last": True or False, # Optional. Set this to True if this is the last log entry in the operation.
- "id": "A String", # Required. An arbitrary operation identifier. Log entries with the same identifier are assumed to be part of the same operation.
- "producer": "A String", # Required. An arbitrary producer identifier. The combination of `id` and `producer` must be globally unique. Examples for `producer`: `"MyDivision.MyBigCompany.com"`, "github.com/MyProject/MyApplication"`.
+ "id": "A String", # Optional. An arbitrary operation identifier. Log entries with the
+ # same identifier are assumed to be part of the same operation.
+ "producer": "A String", # Optional. An arbitrary producer identifier. The combination of
+ # `id` and `producer` must be globally unique. Examples for `producer`:
+ # `"MyDivision.MyBigCompany.com"`, `"github.com/MyProject/MyApplication"`.
"first": True or False, # Optional. Set this to True if this is the first log entry in the operation.
},
},
@@ -168,65 +246,169 @@
<div class="method">
<code class="details" id="write">write(body, x__xgafv=None)</code>
- <pre>Writes log entries to Cloud Logging. All log entries in Cloud Logging are written by this method.
+ <pre>Writes log entries to Stackdriver Logging. All log entries are
+written by this method.
Args:
body: object, The request body. (required)
The object takes the form of:
{ # The parameters to WriteLogEntries.
- "resource": { # An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The `type` field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the `labels` field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for `"gce_instance"` has labels `"instance_id"` and `"zone"`: { "type": "gce_instance", "labels": { "instance_id": "my-instance", "zone": "us-central1-a" }} # Optional. A default monitored resource for those log entries in `entries` that do not specify their own `resource`.
- "labels": { # Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Cloud SQL databases use the labels `"database_id"` and `"zone"`.
+ "resource": { # An object representing a resource that can be used for monitoring, logging, # Optional. A default monitored resource object that is assigned to all log
+ # entries in `entries` that do not specify a value for `resource`. Example:
+ #
+ # { "type": "gce_instance",
+ # "labels": {
+ # "zone": "us-central1-a", "instance_id": "00000000000000000000" }}
+ #
+ # See LogEntry.
+ # billing, or other purposes. Examples include virtual machine instances,
+ # databases, and storage devices such as disks. The `type` field identifies a
+ # MonitoredResourceDescriptor object that describes the resource's
+ # schema. Information in the `labels` field identifies the actual resource and
+ # its attributes according to the schema. For example, a particular Compute
+ # Engine VM instance could be represented by the following object, because the
+ # MonitoredResourceDescriptor for `"gce_instance"` has labels
+ # `"instance_id"` and `"zone"`:
+ #
+ # { "type": "gce_instance",
+ # "labels": { "instance_id": "12345678901234",
+ # "zone": "us-central1-a" }}
+ "labels": { # Required. Values for all of the labels listed in the associated monitored
+ # resource descriptor. For example, Cloud SQL databases use the labels
+ # `"database_id"` and `"zone"`.
"a_key": "A String",
},
- "type": "A String", # Required. The monitored resource type. This field must match the `type` field of a MonitoredResourceDescriptor object. For example, the type of a Cloud SQL database is `"cloudsql_database"`.
+ "type": "A String", # Required. The monitored resource type. This field must match
+ # the `type` field of a MonitoredResourceDescriptor object. For
+ # example, the type of a Cloud SQL database is `"cloudsql_database"`.
},
- "partialSuccess": True or False, # Optional. Whether valid entries should be written even if some other entries fail due to INVALID_ARGUMENT or PERMISSION_DENIED errors. If any entry is not written, the response status will be the error associated with one of the failed entries and include error details in the form of WriteLogEntriesPartialErrors.
- "labels": { # Optional. User-defined `key:value` items that are added to the `labels` field of each log entry in `entries`, except when a log entry specifies its own `key:value` item with the same key. Example: `{ "size": "large", "color":"red" }`
+ "partialSuccess": True or False, # Optional. Whether valid entries should be written even if some other
+ # entries fail due to INVALID_ARGUMENT or PERMISSION_DENIED errors. If any
+ # entry is not written, the response status will be the error associated
+ # with one of the failed entries and include error details in the form of
+ # WriteLogEntriesPartialErrors.
+ "labels": { # Optional. Default labels that are added to the `labels` field of all log
+ # entries in `entries`. If a log entry already has a label with the same key
+ # as a label in this parameter, then the log entry's label is not changed.
+ # See LogEntry.
"a_key": "A String",
},
- "logName": "A String", # Optional. A default log resource name for those log entries in `entries` that do not specify their own `logName`. Example: `"projects/my-project/logs/syslog"`. See LogEntry.
- "entries": [ # Required. The log entries to write. The log entries must have values for all required fields.
+ "logName": "A String", # Optional. A default log resource name that is assigned to all log entries
+ # in `entries` that do not specify a value for `log_name`. Example:
+ # `"projects/my-project/logs/syslog"`. See
+ # LogEntry.
+ "entries": [ # Required. The log entries to write. Values supplied for the fields
+ # `log_name`, `resource`, and `labels` in this `entries.write` request are
+ # added to those log entries that do not provide their own values for the
+ # fields.
+ #
+ # To improve throughput and to avoid exceeding the
+ # [quota limit](/logging/quota-policy) for calls to `entries.write`,
+ # you should write multiple log entries at once rather than
+ # calling this method for each individual log entry.
{ # An individual entry in a log.
- "httpRequest": { # A common proto for logging HTTP requests. # Optional. Information about the HTTP request associated with this log entry, if applicable.
- "status": 42, # The response code indicating the status of response. Examples: 200, 404.
- "cacheValidatedWithOriginServer": True or False, # Whether or not the response was validated with the origin server before being served from cache. This field is only meaningful if `cache_hit` is True.
- "cacheHit": True or False, # Whether or not an entity was served from cache (with or without validation).
- "cacheFillBytes": "A String", # The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted.
- "requestUrl": "A String", # The scheme (http, https), the host name, the path and the query portion of the URL that was requested. Example: `"http://example.com/some/info?color=red"`.
- "cacheLookup": True or False, # Whether or not a cache lookup was attempted.
+ "httpRequest": { # A common proto for logging HTTP requests. Only contains semantics # Optional. Information about the HTTP request associated with this
+ # log entry, if applicable.
+ # defined by the HTTP specification. Product-specific logging
+ # information MUST be defined in a separate message.
+ "status": 42, # The response code indicating the status of response.
+ # Examples: 200, 404.
+ "cacheValidatedWithOriginServer": True or False, # Whether or not the response was validated with the origin server before
+ # being served from cache. This field is only meaningful if `cache_hit` is
+ # True.
"requestMethod": "A String", # The request method. Examples: `"GET"`, `"HEAD"`, `"PUT"`, `"POST"`.
- "referer": "A String", # The referer URL of the request, as defined in [HTTP/1.1 Header Field Definitions](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).
- "remoteIp": "A String", # The IP address (IPv4 or IPv6) of the client that issued the HTTP request. Examples: `"192.168.1.1"`, `"FE80::0202:B3FF:FE1E:8329"`.
- "userAgent": "A String", # The user agent sent by the client. Example: `"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)"`.
- "requestSize": "A String", # The size of the HTTP request message in bytes, including the request headers and the request body.
- "responseSize": "A String", # The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.
+ "latency": "A String", # The request processing latency on the server, from the time the request was
+ # received until the response was sent.
+ "cacheFillBytes": "A String", # The number of HTTP response bytes inserted into cache. Set only when a
+ # cache fill was attempted.
+ "requestUrl": "A String", # The scheme (http, https), the host name, the path and the query
+ # portion of the URL that was requested.
+ # Example: `"http://example.com/some/info?color=red"`.
+ "serverIp": "A String", # The IP address (IPv4 or IPv6) of the origin server that the request was
+ # sent to.
+ "cacheLookup": True or False, # Whether or not a cache lookup was attempted.
+ "cacheHit": True or False, # Whether or not an entity was served from cache
+ # (with or without validation).
+ "referer": "A String", # The referer URL of the request, as defined in
+ # [HTTP/1.1 Header Field Definitions](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).
+ "remoteIp": "A String", # The IP address (IPv4 or IPv6) of the client that issued the HTTP
+ # request. Examples: `"192.168.1.1"`, `"FE80::0202:B3FF:FE1E:8329"`.
+ "userAgent": "A String", # The user agent sent by the client. Example:
+ # `"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)"`.
+ "requestSize": "A String", # The size of the HTTP request message in bytes, including the request
+ # headers and the request body.
+ "responseSize": "A String", # The size of the HTTP response message sent back to the client, in bytes,
+ # including the response headers and the response body.
},
- "resource": { # An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The `type` field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the `labels` field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for `"gce_instance"` has labels `"instance_id"` and `"zone"`: { "type": "gce_instance", "labels": { "instance_id": "my-instance", "zone": "us-central1-a" }} # Required. The monitored resource associated with this log entry. Example: a log entry that reports a database error would be associated with the monitored resource designating the particular database that reported the error.
- "labels": { # Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Cloud SQL databases use the labels `"database_id"` and `"zone"`.
+ "resource": { # An object representing a resource that can be used for monitoring, logging, # Required. The monitored resource associated with this log entry.
+ # Example: a log entry that reports a database error would be
+ # associated with the monitored resource designating the particular
+ # database that reported the error.
+ # billing, or other purposes. Examples include virtual machine instances,
+ # databases, and storage devices such as disks. The `type` field identifies a
+ # MonitoredResourceDescriptor object that describes the resource's
+ # schema. Information in the `labels` field identifies the actual resource and
+ # its attributes according to the schema. For example, a particular Compute
+ # Engine VM instance could be represented by the following object, because the
+ # MonitoredResourceDescriptor for `"gce_instance"` has labels
+ # `"instance_id"` and `"zone"`:
+ #
+ # { "type": "gce_instance",
+ # "labels": { "instance_id": "12345678901234",
+ # "zone": "us-central1-a" }}
+ "labels": { # Required. Values for all of the labels listed in the associated monitored
+ # resource descriptor. For example, Cloud SQL databases use the labels
+ # `"database_id"` and `"zone"`.
"a_key": "A String",
},
- "type": "A String", # Required. The monitored resource type. This field must match the `type` field of a MonitoredResourceDescriptor object. For example, the type of a Cloud SQL database is `"cloudsql_database"`.
+ "type": "A String", # Required. The monitored resource type. This field must match
+ # the `type` field of a MonitoredResourceDescriptor object. For
+ # example, the type of a Cloud SQL database is `"cloudsql_database"`.
},
- "severity": "A String", # Optional. The severity of the log entry. The default value is `LogSeverity.DEFAULT`.
+ "severity": "A String", # Optional. The severity of the log entry. The default value is
+ # `LogSeverity.DEFAULT`.
"textPayload": "A String", # The log entry payload, represented as a Unicode string (UTF-8).
- "timestamp": "A String", # Optional. The time the event described by the log entry occurred. If omitted, Cloud Logging will use the time the log entry is written.
- "labels": { # Optional. A set of user-defined (key, value) data that provides additional information about the log entry.
+ "timestamp": "A String", # Optional. The time the event described by the log entry occurred. If
+ # omitted, Stackdriver Logging will use the time the log entry is received.
+ "labels": { # Optional. A set of user-defined (key, value) data that provides additional
+ # information about the log entry.
"a_key": "A String",
},
- "insertId": "A String", # Optional. A unique ID for the log entry. If you provide this field, the logging service considers other log entries in the same log with the same ID as duplicates which can be removed. If omitted, Cloud Logging will generate a unique ID for this log entry.
- "jsonPayload": { # The log entry payload, represented as a structure that is expressed as a JSON object.
+ "insertId": "A String", # Optional. A unique ID for the log entry. If you provide this
+ # field, the logging service considers other log entries in the
+ # same project with the same ID as duplicates which can be removed. If
+ # omitted, Stackdriver Logging will generate a unique ID for this
+ # log entry.
+ "jsonPayload": { # The log entry payload, represented as a structure that
+ # is expressed as a JSON object.
"a_key": "", # Properties of the object.
},
- "logName": "A String", # Required. The resource name of the log to which this log entry belongs. The format of the name is `"projects/
- # /logs/"`. Examples: `"projects/my-projectid/logs/syslog"`, `"projects/1234567890/logs/library.googleapis.com%2Fbook_log"`. The log ID part of resource name must be less than 512 characters long and can only include the following characters: upper and lower case alphanumeric characters: [A-Za-z0-9]; and punctuation characters: forward-slash, underscore, hyphen, and period. Forward-slash (`/`) characters in the log ID must be URL-encoded.
- "protoPayload": { # The log entry payload, represented as a protocol buffer. You can only use `protoPayload` values that belong to a set of approved types.
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ "logName": "A String", # Required. The resource name of the log to which this log entry
+ # belongs. The format of the name is
+ # `"projects/<project-id>/logs/<log-id>"`. Examples:
+ # `"projects/my-projectid/logs/syslog"`,
+ # `"projects/my-projectid/logs/library.googleapis.com%2Fbook_log"`.
+ #
+ # The log ID part of resource name must be less than 512 characters
+ # long and can only include the following characters: upper and
+ # lower case alphanumeric characters: [A-Za-z0-9]; and punctuation
+ # characters: forward-slash, underscore, hyphen, and period.
+ # Forward-slash (`/`) characters in the log ID must be URL-encoded.
+ "protoPayload": { # The log entry payload, represented as a protocol buffer. Some
+ # Google Cloud Platform services use this field for their log
+ # entry payloads.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "operation": { # Additional information about a potentially long-running operation with which a log entry is associated. # Optional. Information about an operation associated with the log entry, if applicable.
+ "operation": { # Additional information about a potentially long-running operation with which # Optional. Information about an operation associated with the log entry, if
+ # applicable.
+ # a log entry is associated.
"last": True or False, # Optional. Set this to True if this is the last log entry in the operation.
- "id": "A String", # Required. An arbitrary operation identifier. Log entries with the same identifier are assumed to be part of the same operation.
- "producer": "A String", # Required. An arbitrary producer identifier. The combination of `id` and `producer` must be globally unique. Examples for `producer`: `"MyDivision.MyBigCompany.com"`, "github.com/MyProject/MyApplication"`.
+ "id": "A String", # Optional. An arbitrary operation identifier. Log entries with the
+ # same identifier are assumed to be part of the same operation.
+ "producer": "A String", # Optional. An arbitrary producer identifier. The combination of
+ # `id` and `producer` must be globally unique. Examples for `producer`:
+ # `"MyDivision.MyBigCompany.com"`, `"github.com/MyProject/MyApplication"`.
"first": True or False, # Optional. Set this to True if this is the first log entry in the operation.
},
},
@@ -234,11 +416,15 @@
}
x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
- { # Result returned from WriteLogEntries. empty
+ { # Result returned from WriteLogEntries.
+ # empty
}</pre>
</div>
diff --git a/docs/dyn/logging_v2beta1.html b/docs/dyn/logging_v2beta1.html
index d836020..c79ec47 100644
--- a/docs/dyn/logging_v2beta1.html
+++ b/docs/dyn/logging_v2beta1.html
@@ -72,9 +72,14 @@
</style>
-<h1><a href="logging_v2beta1.html">Google Cloud Logging API</a></h1>
+<h1><a href="logging_v2beta1.html">Stackdriver Logging API</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
+ <code><a href="logging_v2beta1.billingAccounts.html">billingAccounts()</a></code>
+</p>
+<p class="firstline">Returns the billingAccounts Resource.</p>
+
+<p class="toc_element">
<code><a href="logging_v2beta1.entries.html">entries()</a></code>
</p>
<p class="firstline">Returns the entries Resource.</p>
@@ -85,6 +90,11 @@
<p class="firstline">Returns the monitoredResourceDescriptors Resource.</p>
<p class="toc_element">
+ <code><a href="logging_v2beta1.organizations.html">organizations()</a></code>
+</p>
+<p class="firstline">Returns the organizations Resource.</p>
+
+<p class="toc_element">
<code><a href="logging_v2beta1.projects.html">projects()</a></code>
</p>
<p class="firstline">Returns the projects Resource.</p>
diff --git a/docs/dyn/logging_v2beta1.monitoredResourceDescriptors.html b/docs/dyn/logging_v2beta1.monitoredResourceDescriptors.html
index 82e9750..5ed2731 100644
--- a/docs/dyn/logging_v2beta1.monitoredResourceDescriptors.html
+++ b/docs/dyn/logging_v2beta1.monitoredResourceDescriptors.html
@@ -72,42 +72,73 @@
</style>
-<h1><a href="logging_v2beta1.html">Google Cloud Logging API</a> . <a href="logging_v2beta1.monitoredResourceDescriptors.html">monitoredResourceDescriptors</a></h1>
+<h1><a href="logging_v2beta1.html">Stackdriver Logging API</a> . <a href="logging_v2beta1.monitoredResourceDescriptors.html">monitoredResourceDescriptors</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#list">list(pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Lists monitored resource descriptors that are used by Cloud Logging.</p>
+<p class="firstline">Lists the monitored resource descriptors used by Stackdriver Logging.</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>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="list">list(pageSize=None, pageToken=None, x__xgafv=None)</code>
- <pre>Lists monitored resource descriptors that are used by Cloud Logging.
+ <pre>Lists the monitored resource descriptors used by Stackdriver Logging.
Args:
- pageSize: integer, Optional. The maximum number of results to return from this request. You must check for presence of `nextPageToken` to determine if additional results are available, which you can retrieve by passing the `nextPageToken` value as the `pageToken` parameter in the next request.
- pageToken: string, Optional. If the `pageToken` parameter is supplied, then the next page of results is retrieved. The `pageToken` parameter must be set to the value of the `nextPageToken` from the previous response.
+ pageSize: integer, Optional. The maximum number of results to return from this request.
+Non-positive values are ignored. The presence of `nextPageToken` in the
+response indicates that more results might be available.
+ pageToken: string, Optional. If present, then retrieve the next batch of results from the
+preceding call to this method. `pageToken` must be the value of
+`nextPageToken` from the previous response. The values of other method
+parameters should be identical to those in the previous call.
x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
{ # Result returned from ListMonitoredResourceDescriptors.
- "nextPageToken": "A String", # If there are more results than were returned, then `nextPageToken` is included in the response. To get the next set of results, call this method again using the value of `nextPageToken` as `pageToken`.
+ "nextPageToken": "A String", # If there might be more results than appear in this response, then
+ # `nextPageToken` is included. To get the next set of results, call this
+ # method again using the value of `nextPageToken` as `pageToken`.
"resourceDescriptors": [ # A list of resource descriptors.
- { # An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of `"gce_instance"` and specifies the use of the labels `"instance_id"` and `"zone"` to identify particular VM instances. Different APIs can support different monitored resource types. APIs generally provide a `list` method that returns the monitored resource descriptors used by the API.
- "displayName": "A String", # Optional. A concise name for the monitored resource type that might be displayed in user interfaces. For example, `"Google Cloud SQL Database"`.
- "labels": [ # Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels `"database_id"` and `"zone"`.
+ { # An object that describes the schema of a MonitoredResource object using a
+ # type name and a set of labels. For example, the monitored resource
+ # descriptor for Google Compute Engine VM instances has a type of
+ # `"gce_instance"` and specifies the use of the labels `"instance_id"` and
+ # `"zone"` to identify particular VM instances.
+ #
+ # Different APIs can support different monitored resource types. APIs generally
+ # provide a `list` method that returns the monitored resource descriptors used
+ # by the API.
+ "type": "A String", # Required. The monitored resource type. For example, the type
+ # `"cloudsql_database"` represents databases in Google Cloud SQL.
+ # The maximum length of this value is 256 characters.
+ "labels": [ # Required. A set of labels used to describe instances of this monitored
+ # resource type. For example, an individual Google Cloud SQL database is
+ # identified by values for the labels `"database_id"` and `"zone"`.
{ # A description of a label.
"valueType": "A String", # The type of data that can be assigned to the label.
"description": "A String", # A human-readable description for the label.
"key": "A String", # The label key.
},
],
- "type": "A String", # Required. The monitored resource type. For example, the type `"cloudsql_database"` represents databases in Google Cloud SQL.
- "name": "A String", # Optional. The resource name of the monitored resource descriptor: `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where {type} is the value of the `type` field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format `"monitoredResourceDescriptors/{type}"`.
- "description": "A String", # Optional. A detailed description of the monitored resource type that might be used in documentation.
+ "displayName": "A String", # Optional. A concise name for the monitored resource type that might be
+ # displayed in user interfaces. It should be a Title Cased Noun Phrase,
+ # without any article or other determiners. For example,
+ # `"Google Cloud SQL Database"`.
+ "description": "A String", # Optional. A detailed description of the monitored resource type that might
+ # be used in documentation.
+ "name": "A String", # Optional. The resource name of the monitored resource descriptor:
+ # `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where
+ # {type} is the value of the `type` field in this object and
+ # {project_id} is a project ID that provides API-specific context for
+ # accessing the type. APIs that do not use project information can use the
+ # resource name format `"monitoredResourceDescriptors/{type}"`.
},
],
}</pre>
diff --git a/docs/dyn/logging_v2beta1.organizations.html b/docs/dyn/logging_v2beta1.organizations.html
new file mode 100644
index 0000000..3bb4061
--- /dev/null
+++ b/docs/dyn/logging_v2beta1.organizations.html
@@ -0,0 +1,82 @@
+<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="logging_v2beta1.html">Stackdriver Logging API</a> . <a href="logging_v2beta1.organizations.html">organizations</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="logging_v2beta1.organizations.logs.html">logs()</a></code>
+</p>
+<p class="firstline">Returns the logs Resource.</p>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/logging_v2beta1.organizations.logs.html b/docs/dyn/logging_v2beta1.organizations.logs.html
new file mode 100644
index 0000000..4ae14c5
--- /dev/null
+++ b/docs/dyn/logging_v2beta1.organizations.logs.html
@@ -0,0 +1,109 @@
+<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="logging_v2beta1.html">Stackdriver Logging API</a> . <a href="logging_v2beta1.organizations.html">organizations</a> . <a href="logging_v2beta1.organizations.logs.html">logs</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(logName=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Deletes a log and all its log entries.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(logName=None, x__xgafv=None)</code>
+ <pre>Deletes a log and all its log entries.
+The log will reappear if it receives new entries.
+
+Args:
+ logName: string, Required. The resource name of the log to delete. Example:
+`"projects/my-project/logs/syslog"`. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated
+ # empty messages in your APIs. A typical example is to use it as the request
+ # or the response type of an API method. For instance:
+ #
+ # service Foo {
+ # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
+ # }
+ #
+ # The JSON representation for `Empty` is empty JSON object `{}`.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/logging_v2beta1.projects.html b/docs/dyn/logging_v2beta1.projects.html
index 24241c7..80c3619 100644
--- a/docs/dyn/logging_v2beta1.projects.html
+++ b/docs/dyn/logging_v2beta1.projects.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="logging_v2beta1.html">Google Cloud Logging API</a> . <a href="logging_v2beta1.projects.html">projects</a></h1>
+<h1><a href="logging_v2beta1.html">Stackdriver Logging API</a> . <a href="logging_v2beta1.projects.html">projects</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="logging_v2beta1.projects.logs.html">logs()</a></code>
diff --git a/docs/dyn/logging_v2beta1.projects.logs.html b/docs/dyn/logging_v2beta1.projects.logs.html
index babc136..7894475 100644
--- a/docs/dyn/logging_v2beta1.projects.logs.html
+++ b/docs/dyn/logging_v2beta1.projects.logs.html
@@ -72,24 +72,37 @@
</style>
-<h1><a href="logging_v2beta1.html">Google Cloud Logging API</a> . <a href="logging_v2beta1.projects.html">projects</a> . <a href="logging_v2beta1.projects.logs.html">logs</a></h1>
+<h1><a href="logging_v2beta1.html">Stackdriver Logging API</a> . <a href="logging_v2beta1.projects.html">projects</a> . <a href="logging_v2beta1.projects.logs.html">logs</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#delete">delete(logName, x__xgafv=None)</a></code></p>
-<p class="firstline">Deletes a log and all its log entries. The log will reappear if it receives new entries.</p>
+ <code><a href="#delete">delete(logName=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Deletes a log and all its log entries.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="delete">delete(logName, x__xgafv=None)</code>
- <pre>Deletes a log and all its log entries. The log will reappear if it receives new entries.
+ <code class="details" id="delete">delete(logName=None, x__xgafv=None)</code>
+ <pre>Deletes a log and all its log entries.
+The log will reappear if it receives new entries.
Args:
- logName: string, Required. The resource name of the log to delete. Example: `"projects/my-project/logs/syslog"`. (required)
+ logName: string, Required. The resource name of the log to delete. Example:
+`"projects/my-project/logs/syslog"`. (required)
x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
- { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
+ { # A generic empty message that you can re-use to avoid defining duplicated
+ # empty messages in your APIs. A typical example is to use it as the request
+ # or the response type of an API method. For instance:
+ #
+ # service Foo {
+ # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
+ # }
+ #
+ # The JSON representation for `Empty` is empty JSON object `{}`.
}</pre>
</div>
diff --git a/docs/dyn/logging_v2beta1.projects.metrics.html b/docs/dyn/logging_v2beta1.projects.metrics.html
index 02c17b6..6b4ae6c 100644
--- a/docs/dyn/logging_v2beta1.projects.metrics.html
+++ b/docs/dyn/logging_v2beta1.projects.metrics.html
@@ -72,109 +72,190 @@
</style>
-<h1><a href="logging_v2beta1.html">Google Cloud Logging API</a> . <a href="logging_v2beta1.projects.html">projects</a> . <a href="logging_v2beta1.projects.metrics.html">metrics</a></h1>
+<h1><a href="logging_v2beta1.html">Stackdriver Logging API</a> . <a href="logging_v2beta1.projects.html">projects</a> . <a href="logging_v2beta1.projects.metrics.html">metrics</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#create">create(projectName, body, x__xgafv=None)</a></code></p>
+ <code><a href="#create">create(parent=None, body, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a logs-based metric.</p>
<p class="toc_element">
- <code><a href="#delete">delete(metricName, x__xgafv=None)</a></code></p>
+ <code><a href="#delete">delete(metricName=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a logs-based metric.</p>
<p class="toc_element">
- <code><a href="#get">get(metricName, x__xgafv=None)</a></code></p>
+ <code><a href="#get">get(metricName=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a logs-based metric.</p>
<p class="toc_element">
- <code><a href="#list">list(projectName, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
<p class="firstline">Lists logs-based metrics.</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>
<p class="toc_element">
- <code><a href="#update">update(metricName, body, x__xgafv=None)</a></code></p>
+ <code><a href="#update">update(metricName=None, body, x__xgafv=None)</a></code></p>
<p class="firstline">Creates or updates a logs-based metric.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="create">create(projectName, body, x__xgafv=None)</code>
+ <code class="details" id="create">create(parent=None, body, x__xgafv=None)</code>
<pre>Creates a logs-based metric.
Args:
- projectName: string, The resource name of the project in which to create the metric. Example: `"projects/my-project-id"`. The new metric must be provided in the request. (required)
+ parent: string, The resource name of the project in which to create the metric.
+Example: `"projects/my-project-id"`.
+
+The new metric must be provided in the request. (required)
body: object, The request body. (required)
The object takes the form of:
-{ # Describes a logs-based metric. The value of the metric is the number of log entries that match a logs filter.
- "filter": "A String", # An [advanced logs filter](/logging/docs/view/advanced_filters). Example: `"logName:syslog AND severity>=ERROR"`.
- "name": "A String", # Required. The client-assigned metric identifier. Example: `"severe_errors"`. Metric identifiers are limited to 1000 characters and can include only the following characters: `A-Z`, `a-z`, `0-9`, and the special characters `_-.,+!*',()%/\`. The forward-slash character (`/`) denotes a hierarchy of name pieces, and it cannot be the first character of the name.
- "description": "A String", # A description of this metric, which is used in documentation.
+{ # Describes a logs-based metric. The value of the metric is the
+ # number of log entries that match a logs filter.
+ "filter": "A String", # Required. An [advanced logs filter](/logging/docs/view/advanced_filters).
+ # Example: `"resource.type=gae_app AND severity>=ERROR"`.
+ "version": "A String", # Output only. The API version that created or updated this metric.
+ # The version also dictates the syntax of the filter expression. When a value
+ # for this field is missing, the default value of V2 should be assumed.
+ "description": "A String", # Optional. A description of this metric, which is used in documentation.
+ "name": "A String", # Required. The client-assigned metric identifier. Example:
+ # `"severe_errors"`. Metric identifiers are limited to 100
+ # characters and can include only the following characters: `A-Z`,
+ # `a-z`, `0-9`, and the special characters `_-.,+!*',()%/`. The
+ # forward-slash character (`/`) denotes a hierarchy of name pieces,
+ # and it cannot be the first character of the name. The '%' character
+ # is used to URL encode unsafe and reserved characters and must be
+ # followed by two hexadecimal digits according to RFC 1738.
}
x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
- { # Describes a logs-based metric. The value of the metric is the number of log entries that match a logs filter.
- "filter": "A String", # An [advanced logs filter](/logging/docs/view/advanced_filters). Example: `"logName:syslog AND severity>=ERROR"`.
- "name": "A String", # Required. The client-assigned metric identifier. Example: `"severe_errors"`. Metric identifiers are limited to 1000 characters and can include only the following characters: `A-Z`, `a-z`, `0-9`, and the special characters `_-.,+!*',()%/\`. The forward-slash character (`/`) denotes a hierarchy of name pieces, and it cannot be the first character of the name.
- "description": "A String", # A description of this metric, which is used in documentation.
+ { # Describes a logs-based metric. The value of the metric is the
+ # number of log entries that match a logs filter.
+ "filter": "A String", # Required. An [advanced logs filter](/logging/docs/view/advanced_filters).
+ # Example: `"resource.type=gae_app AND severity>=ERROR"`.
+ "version": "A String", # Output only. The API version that created or updated this metric.
+ # The version also dictates the syntax of the filter expression. When a value
+ # for this field is missing, the default value of V2 should be assumed.
+ "description": "A String", # Optional. A description of this metric, which is used in documentation.
+ "name": "A String", # Required. The client-assigned metric identifier. Example:
+ # `"severe_errors"`. Metric identifiers are limited to 100
+ # characters and can include only the following characters: `A-Z`,
+ # `a-z`, `0-9`, and the special characters `_-.,+!*',()%/`. The
+ # forward-slash character (`/`) denotes a hierarchy of name pieces,
+ # and it cannot be the first character of the name. The '%' character
+ # is used to URL encode unsafe and reserved characters and must be
+ # followed by two hexadecimal digits according to RFC 1738.
}</pre>
</div>
<div class="method">
- <code class="details" id="delete">delete(metricName, x__xgafv=None)</code>
+ <code class="details" id="delete">delete(metricName=None, x__xgafv=None)</code>
<pre>Deletes a logs-based metric.
Args:
- metricName: string, The resource name of the metric to delete. Example: `"projects/my-project-id/metrics/my-metric-id"`. (required)
+ metricName: string, The resource name of the metric to delete.
+Example: `"projects/my-project-id/metrics/my-metric-id"`. (required)
x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
- { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
+ { # A generic empty message that you can re-use to avoid defining duplicated
+ # empty messages in your APIs. A typical example is to use it as the request
+ # or the response type of an API method. For instance:
+ #
+ # service Foo {
+ # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
+ # }
+ #
+ # The JSON representation for `Empty` is empty JSON object `{}`.
}</pre>
</div>
<div class="method">
- <code class="details" id="get">get(metricName, x__xgafv=None)</code>
+ <code class="details" id="get">get(metricName=None, x__xgafv=None)</code>
<pre>Gets a logs-based metric.
Args:
- metricName: string, The resource name of the desired metric. Example: `"projects/my-project-id/metrics/my-metric-id"`. (required)
+ metricName: string, The resource name of the desired metric.
+Example: `"projects/my-project-id/metrics/my-metric-id"`. (required)
x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
- { # Describes a logs-based metric. The value of the metric is the number of log entries that match a logs filter.
- "filter": "A String", # An [advanced logs filter](/logging/docs/view/advanced_filters). Example: `"logName:syslog AND severity>=ERROR"`.
- "name": "A String", # Required. The client-assigned metric identifier. Example: `"severe_errors"`. Metric identifiers are limited to 1000 characters and can include only the following characters: `A-Z`, `a-z`, `0-9`, and the special characters `_-.,+!*',()%/\`. The forward-slash character (`/`) denotes a hierarchy of name pieces, and it cannot be the first character of the name.
- "description": "A String", # A description of this metric, which is used in documentation.
+ { # Describes a logs-based metric. The value of the metric is the
+ # number of log entries that match a logs filter.
+ "filter": "A String", # Required. An [advanced logs filter](/logging/docs/view/advanced_filters).
+ # Example: `"resource.type=gae_app AND severity>=ERROR"`.
+ "version": "A String", # Output only. The API version that created or updated this metric.
+ # The version also dictates the syntax of the filter expression. When a value
+ # for this field is missing, the default value of V2 should be assumed.
+ "description": "A String", # Optional. A description of this metric, which is used in documentation.
+ "name": "A String", # Required. The client-assigned metric identifier. Example:
+ # `"severe_errors"`. Metric identifiers are limited to 100
+ # characters and can include only the following characters: `A-Z`,
+ # `a-z`, `0-9`, and the special characters `_-.,+!*',()%/`. The
+ # forward-slash character (`/`) denotes a hierarchy of name pieces,
+ # and it cannot be the first character of the name. The '%' character
+ # is used to URL encode unsafe and reserved characters and must be
+ # followed by two hexadecimal digits according to RFC 1738.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(projectName, pageSize=None, pageToken=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</code>
<pre>Lists logs-based metrics.
Args:
- projectName: string, Required. The resource name of the project containing the metrics. Example: `"projects/my-project-id"`. (required)
- pageSize: integer, Optional. The maximum number of results to return from this request. You must check for presence of `nextPageToken` to determine if additional results are available, which you can retrieve by passing the `nextPageToken` value as the `pageToken` parameter in the next request.
- pageToken: string, Optional. If the `pageToken` parameter is supplied, then the next page of results is retrieved. The `pageToken` parameter must be set to the value of the `nextPageToken` from the previous response. The value of `projectName` must be the same as in the previous request.
+ parent: string, Required. The resource name containing the metrics.
+Example: `"projects/my-project-id"`. (required)
+ pageToken: string, Optional. If present, then retrieve the next batch of results from the
+preceding call to this method. `pageToken` must be the value of
+`nextPageToken` from the previous response. The values of other method
+parameters should be identical to those in the previous call.
x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+ pageSize: integer, Optional. The maximum number of results to return from this request.
+Non-positive values are ignored. The presence of `nextPageToken` in the
+response indicates that more results might be available.
Returns:
An object of the form:
{ # Result returned from ListLogMetrics.
"metrics": [ # A list of logs-based metrics.
- { # Describes a logs-based metric. The value of the metric is the number of log entries that match a logs filter.
- "filter": "A String", # An [advanced logs filter](/logging/docs/view/advanced_filters). Example: `"logName:syslog AND severity>=ERROR"`.
- "name": "A String", # Required. The client-assigned metric identifier. Example: `"severe_errors"`. Metric identifiers are limited to 1000 characters and can include only the following characters: `A-Z`, `a-z`, `0-9`, and the special characters `_-.,+!*',()%/\`. The forward-slash character (`/`) denotes a hierarchy of name pieces, and it cannot be the first character of the name.
- "description": "A String", # A description of this metric, which is used in documentation.
+ { # Describes a logs-based metric. The value of the metric is the
+ # number of log entries that match a logs filter.
+ "filter": "A String", # Required. An [advanced logs filter](/logging/docs/view/advanced_filters).
+ # Example: `"resource.type=gae_app AND severity>=ERROR"`.
+ "version": "A String", # Output only. The API version that created or updated this metric.
+ # The version also dictates the syntax of the filter expression. When a value
+ # for this field is missing, the default value of V2 should be assumed.
+ "description": "A String", # Optional. A description of this metric, which is used in documentation.
+ "name": "A String", # Required. The client-assigned metric identifier. Example:
+ # `"severe_errors"`. Metric identifiers are limited to 100
+ # characters and can include only the following characters: `A-Z`,
+ # `a-z`, `0-9`, and the special characters `_-.,+!*',()%/`. The
+ # forward-slash character (`/`) denotes a hierarchy of name pieces,
+ # and it cannot be the first character of the name. The '%' character
+ # is used to URL encode unsafe and reserved characters and must be
+ # followed by two hexadecimal digits according to RFC 1738.
},
],
- "nextPageToken": "A String", # If there are more results than were returned, then `nextPageToken` is included in the response. To get the next set of results, call this method again using the value of `nextPageToken` as `pageToken`.
+ "nextPageToken": "A String", # If there might be more results than appear in this response, then
+ # `nextPageToken` is included. To get the next set of results, call this
+ # method again using the value of `nextPageToken` as `pageToken`.
}</pre>
</div>
@@ -193,29 +274,61 @@
</div>
<div class="method">
- <code class="details" id="update">update(metricName, body, x__xgafv=None)</code>
+ <code class="details" id="update">update(metricName=None, body, x__xgafv=None)</code>
<pre>Creates or updates a logs-based metric.
Args:
- metricName: string, The resource name of the metric to update. Example: `"projects/my-project-id/metrics/my-metric-id"`. The updated metric must be provided in the request and have the same identifier that is specified in `metricName`. If the metric does not exist, it is created. (required)
+ metricName: string, The resource name of the metric to update.
+Example: `"projects/my-project-id/metrics/my-metric-id"`.
+
+The updated metric must be provided in the request and have the
+same identifier that is specified in `metricName`.
+If the metric does not exist, it is created. (required)
body: object, The request body. (required)
The object takes the form of:
-{ # Describes a logs-based metric. The value of the metric is the number of log entries that match a logs filter.
- "filter": "A String", # An [advanced logs filter](/logging/docs/view/advanced_filters). Example: `"logName:syslog AND severity>=ERROR"`.
- "name": "A String", # Required. The client-assigned metric identifier. Example: `"severe_errors"`. Metric identifiers are limited to 1000 characters and can include only the following characters: `A-Z`, `a-z`, `0-9`, and the special characters `_-.,+!*',()%/\`. The forward-slash character (`/`) denotes a hierarchy of name pieces, and it cannot be the first character of the name.
- "description": "A String", # A description of this metric, which is used in documentation.
+{ # Describes a logs-based metric. The value of the metric is the
+ # number of log entries that match a logs filter.
+ "filter": "A String", # Required. An [advanced logs filter](/logging/docs/view/advanced_filters).
+ # Example: `"resource.type=gae_app AND severity>=ERROR"`.
+ "version": "A String", # Output only. The API version that created or updated this metric.
+ # The version also dictates the syntax of the filter expression. When a value
+ # for this field is missing, the default value of V2 should be assumed.
+ "description": "A String", # Optional. A description of this metric, which is used in documentation.
+ "name": "A String", # Required. The client-assigned metric identifier. Example:
+ # `"severe_errors"`. Metric identifiers are limited to 100
+ # characters and can include only the following characters: `A-Z`,
+ # `a-z`, `0-9`, and the special characters `_-.,+!*',()%/`. The
+ # forward-slash character (`/`) denotes a hierarchy of name pieces,
+ # and it cannot be the first character of the name. The '%' character
+ # is used to URL encode unsafe and reserved characters and must be
+ # followed by two hexadecimal digits according to RFC 1738.
}
x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
- { # Describes a logs-based metric. The value of the metric is the number of log entries that match a logs filter.
- "filter": "A String", # An [advanced logs filter](/logging/docs/view/advanced_filters). Example: `"logName:syslog AND severity>=ERROR"`.
- "name": "A String", # Required. The client-assigned metric identifier. Example: `"severe_errors"`. Metric identifiers are limited to 1000 characters and can include only the following characters: `A-Z`, `a-z`, `0-9`, and the special characters `_-.,+!*',()%/\`. The forward-slash character (`/`) denotes a hierarchy of name pieces, and it cannot be the first character of the name.
- "description": "A String", # A description of this metric, which is used in documentation.
+ { # Describes a logs-based metric. The value of the metric is the
+ # number of log entries that match a logs filter.
+ "filter": "A String", # Required. An [advanced logs filter](/logging/docs/view/advanced_filters).
+ # Example: `"resource.type=gae_app AND severity>=ERROR"`.
+ "version": "A String", # Output only. The API version that created or updated this metric.
+ # The version also dictates the syntax of the filter expression. When a value
+ # for this field is missing, the default value of V2 should be assumed.
+ "description": "A String", # Optional. A description of this metric, which is used in documentation.
+ "name": "A String", # Required. The client-assigned metric identifier. Example:
+ # `"severe_errors"`. Metric identifiers are limited to 100
+ # characters and can include only the following characters: `A-Z`,
+ # `a-z`, `0-9`, and the special characters `_-.,+!*',()%/`. The
+ # forward-slash character (`/`) denotes a hierarchy of name pieces,
+ # and it cannot be the first character of the name. The '%' character
+ # is used to URL encode unsafe and reserved characters and must be
+ # followed by two hexadecimal digits according to RFC 1738.
}</pre>
</div>
diff --git a/docs/dyn/logging_v2beta1.projects.sinks.html b/docs/dyn/logging_v2beta1.projects.sinks.html
index 7b94b4f..2ff8f0e 100644
--- a/docs/dyn/logging_v2beta1.projects.sinks.html
+++ b/docs/dyn/logging_v2beta1.projects.sinks.html
@@ -72,111 +72,265 @@
</style>
-<h1><a href="logging_v2beta1.html">Google Cloud Logging API</a> . <a href="logging_v2beta1.projects.html">projects</a> . <a href="logging_v2beta1.projects.sinks.html">sinks</a></h1>
+<h1><a href="logging_v2beta1.html">Stackdriver Logging API</a> . <a href="logging_v2beta1.projects.html">projects</a> . <a href="logging_v2beta1.projects.sinks.html">sinks</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#create">create(projectName, body, x__xgafv=None)</a></code></p>
+ <code><a href="#create">create(parent=None, body, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a sink.</p>
<p class="toc_element">
- <code><a href="#delete">delete(sinkName, x__xgafv=None)</a></code></p>
+ <code><a href="#delete">delete(sinkName=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a sink.</p>
<p class="toc_element">
- <code><a href="#get">get(sinkName, x__xgafv=None)</a></code></p>
+ <code><a href="#get">get(sinkName=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a sink.</p>
<p class="toc_element">
- <code><a href="#list">list(projectName, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
<p class="firstline">Lists sinks.</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>
<p class="toc_element">
- <code><a href="#update">update(sinkName, body, x__xgafv=None)</a></code></p>
-<p class="firstline">Creates or updates a sink.</p>
+ <code><a href="#update">update(sinkName=None, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Updates or creates a sink.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="create">create(projectName, body, x__xgafv=None)</code>
+ <code class="details" id="create">create(parent=None, body, x__xgafv=None)</code>
<pre>Creates a sink.
Args:
- projectName: string, The resource name of the project in which to create the sink. Example: `"projects/my-project-id"`. The new sink must be provided in the request. (required)
+ parent: string, Required. The resource in which to create the sink.
+Example: `"projects/my-project-id"`.
+The new sink must be provided in the request. (required)
body: object, The request body. (required)
The object takes the form of:
-{ # Describes a sink used to export log entries outside Cloud Logging.
- "filter": "A String", # An [advanced logs filter](/logging/docs/view/advanced_filters). Only log entries matching that filter are exported. The filter must be consistent with the log entry format specified by the `outputVersionFormat` parameter, regardless of the format of the log entry that was originally written to Cloud Logging. Example (V2 format): `"logName=projects/my-projectid/logs/syslog AND severity>=ERROR"`.
- "destination": "A String", # The export destination. See [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs). Examples: `"storage.googleapis.com/a-bucket"`, `"bigquery.googleapis.com/projects/a-project-id/datasets/a-dataset"`.
- "name": "A String", # Required. The client-assigned sink identifier. Example: `"my-severe-errors-to-pubsub"`. Sink identifiers are limited to 1000 characters and can include only the following characters: `A-Z`, `a-z`, `0-9`, and the special characters `_-.`.
- "outputVersionFormat": "A String", # The log entry version to use for this sink's exported log entries. This version does not have to correspond to the version of the log entry when it was written to Cloud Logging.
+{ # Describes a sink used to export log entries outside Stackdriver Logging.
+ "filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters).
+ # Only log entries matching the filter are exported. The filter
+ # must be consistent with the log entry format specified by the
+ # `outputVersionFormat` parameter, regardless of the format of the
+ # log entry that was originally written to Stackdriver Logging.
+ # Example filter (V2 format):
+ #
+ # logName=projects/my-projectid/logs/syslog AND severity>=ERROR
+ "destination": "A String", # Required. The export destination. See
+ # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs).
+ # Examples:
+ #
+ # "storage.googleapis.com/my-gcs-bucket"
+ # "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset"
+ # "pubsub.googleapis.com/projects/my-project/topics/my-topic"
+ "writerIdentity": "A String", # Output only. The iam identity to which the destination needs to grant write
+ # access. This may be a service account or a group.
+ # Examples (Do not assume these specific values):
+ # "serviceAccount:cloud-logs@system.gserviceaccount.com"
+ # "group:cloud-logs@google.com"
+ #
+ # For GCS destinations, the role "roles/owner" is required on the bucket
+ # For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is
+ # required on the topic
+ # For BigQuery, the role "roles/editor" is required on the dataset
+ "name": "A String", # Required. The client-assigned sink identifier, unique within the
+ # project. Example: `"my-syslog-errors-to-pubsub"`. Sink identifiers are
+ # limited to 1000 characters and can include only the following characters:
+ # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`. The maximum length
+ # of the name is 100 characters.
+ "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log
+ # entries. This version does not have to correspond to the version of the
+ # log entry that was written to Stackdriver Logging. If omitted, the
+ # v2 format is used.
}
x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
- { # Describes a sink used to export log entries outside Cloud Logging.
- "filter": "A String", # An [advanced logs filter](/logging/docs/view/advanced_filters). Only log entries matching that filter are exported. The filter must be consistent with the log entry format specified by the `outputVersionFormat` parameter, regardless of the format of the log entry that was originally written to Cloud Logging. Example (V2 format): `"logName=projects/my-projectid/logs/syslog AND severity>=ERROR"`.
- "destination": "A String", # The export destination. See [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs). Examples: `"storage.googleapis.com/a-bucket"`, `"bigquery.googleapis.com/projects/a-project-id/datasets/a-dataset"`.
- "name": "A String", # Required. The client-assigned sink identifier. Example: `"my-severe-errors-to-pubsub"`. Sink identifiers are limited to 1000 characters and can include only the following characters: `A-Z`, `a-z`, `0-9`, and the special characters `_-.`.
- "outputVersionFormat": "A String", # The log entry version to use for this sink's exported log entries. This version does not have to correspond to the version of the log entry when it was written to Cloud Logging.
+ { # Describes a sink used to export log entries outside Stackdriver Logging.
+ "filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters).
+ # Only log entries matching the filter are exported. The filter
+ # must be consistent with the log entry format specified by the
+ # `outputVersionFormat` parameter, regardless of the format of the
+ # log entry that was originally written to Stackdriver Logging.
+ # Example filter (V2 format):
+ #
+ # logName=projects/my-projectid/logs/syslog AND severity>=ERROR
+ "destination": "A String", # Required. The export destination. See
+ # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs).
+ # Examples:
+ #
+ # "storage.googleapis.com/my-gcs-bucket"
+ # "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset"
+ # "pubsub.googleapis.com/projects/my-project/topics/my-topic"
+ "writerIdentity": "A String", # Output only. The iam identity to which the destination needs to grant write
+ # access. This may be a service account or a group.
+ # Examples (Do not assume these specific values):
+ # "serviceAccount:cloud-logs@system.gserviceaccount.com"
+ # "group:cloud-logs@google.com"
+ #
+ # For GCS destinations, the role "roles/owner" is required on the bucket
+ # For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is
+ # required on the topic
+ # For BigQuery, the role "roles/editor" is required on the dataset
+ "name": "A String", # Required. The client-assigned sink identifier, unique within the
+ # project. Example: `"my-syslog-errors-to-pubsub"`. Sink identifiers are
+ # limited to 1000 characters and can include only the following characters:
+ # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`. The maximum length
+ # of the name is 100 characters.
+ "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log
+ # entries. This version does not have to correspond to the version of the
+ # log entry that was written to Stackdriver Logging. If omitted, the
+ # v2 format is used.
}</pre>
</div>
<div class="method">
- <code class="details" id="delete">delete(sinkName, x__xgafv=None)</code>
+ <code class="details" id="delete">delete(sinkName=None, x__xgafv=None)</code>
<pre>Deletes a sink.
Args:
- sinkName: string, The resource name of the sink to delete. Example: `"projects/my-project-id/sinks/my-sink-id"`. (required)
+ sinkName: string, Required. The resource name of the sink to delete, including the parent
+resource and the sink identifier. Example:
+`"projects/my-project-id/sinks/my-sink-id"`. It is an error if the sink
+does not exist. (required)
x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
- { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
+ { # A generic empty message that you can re-use to avoid defining duplicated
+ # empty messages in your APIs. A typical example is to use it as the request
+ # or the response type of an API method. For instance:
+ #
+ # service Foo {
+ # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
+ # }
+ #
+ # The JSON representation for `Empty` is empty JSON object `{}`.
}</pre>
</div>
<div class="method">
- <code class="details" id="get">get(sinkName, x__xgafv=None)</code>
+ <code class="details" id="get">get(sinkName=None, x__xgafv=None)</code>
<pre>Gets a sink.
Args:
- sinkName: string, The resource name of the sink to return. Example: `"projects/my-project-id/sinks/my-sink-id"`. (required)
+ sinkName: string, Required. The resource name of the sink to return.
+Example: `"projects/my-project-id/sinks/my-sink-id"`. (required)
x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
- { # Describes a sink used to export log entries outside Cloud Logging.
- "filter": "A String", # An [advanced logs filter](/logging/docs/view/advanced_filters). Only log entries matching that filter are exported. The filter must be consistent with the log entry format specified by the `outputVersionFormat` parameter, regardless of the format of the log entry that was originally written to Cloud Logging. Example (V2 format): `"logName=projects/my-projectid/logs/syslog AND severity>=ERROR"`.
- "destination": "A String", # The export destination. See [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs). Examples: `"storage.googleapis.com/a-bucket"`, `"bigquery.googleapis.com/projects/a-project-id/datasets/a-dataset"`.
- "name": "A String", # Required. The client-assigned sink identifier. Example: `"my-severe-errors-to-pubsub"`. Sink identifiers are limited to 1000 characters and can include only the following characters: `A-Z`, `a-z`, `0-9`, and the special characters `_-.`.
- "outputVersionFormat": "A String", # The log entry version to use for this sink's exported log entries. This version does not have to correspond to the version of the log entry when it was written to Cloud Logging.
+ { # Describes a sink used to export log entries outside Stackdriver Logging.
+ "filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters).
+ # Only log entries matching the filter are exported. The filter
+ # must be consistent with the log entry format specified by the
+ # `outputVersionFormat` parameter, regardless of the format of the
+ # log entry that was originally written to Stackdriver Logging.
+ # Example filter (V2 format):
+ #
+ # logName=projects/my-projectid/logs/syslog AND severity>=ERROR
+ "destination": "A String", # Required. The export destination. See
+ # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs).
+ # Examples:
+ #
+ # "storage.googleapis.com/my-gcs-bucket"
+ # "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset"
+ # "pubsub.googleapis.com/projects/my-project/topics/my-topic"
+ "writerIdentity": "A String", # Output only. The iam identity to which the destination needs to grant write
+ # access. This may be a service account or a group.
+ # Examples (Do not assume these specific values):
+ # "serviceAccount:cloud-logs@system.gserviceaccount.com"
+ # "group:cloud-logs@google.com"
+ #
+ # For GCS destinations, the role "roles/owner" is required on the bucket
+ # For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is
+ # required on the topic
+ # For BigQuery, the role "roles/editor" is required on the dataset
+ "name": "A String", # Required. The client-assigned sink identifier, unique within the
+ # project. Example: `"my-syslog-errors-to-pubsub"`. Sink identifiers are
+ # limited to 1000 characters and can include only the following characters:
+ # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`. The maximum length
+ # of the name is 100 characters.
+ "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log
+ # entries. This version does not have to correspond to the version of the
+ # log entry that was written to Stackdriver Logging. If omitted, the
+ # v2 format is used.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(projectName, pageSize=None, pageToken=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</code>
<pre>Lists sinks.
Args:
- projectName: string, Required. The resource name of the project containing the sinks. Example: `"projects/my-logging-project"`. (required)
- pageSize: integer, Optional. The maximum number of results to return from this request. You must check for presence of `nextPageToken` to determine if additional results are available, which you can retrieve by passing the `nextPageToken` value as the `pageToken` parameter in the next request.
- pageToken: string, Optional. If the `pageToken` parameter is supplied, then the next page of results is retrieved. The `pageToken` parameter must be set to the value of the `nextPageToken` from the previous response. The value of `projectName` must be the same as in the previous request.
+ parent: string, Required. The cloud resource containing the sinks.
+Example: `"projects/my-logging-project"`. (required)
+ pageToken: string, Optional. If present, then retrieve the next batch of results from the
+preceding call to this method. `pageToken` must be the value of
+`nextPageToken` from the previous response. The values of other method
+parameters should be identical to those in the previous call.
x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+ pageSize: integer, Optional. The maximum number of results to return from this request.
+Non-positive values are ignored. The presence of `nextPageToken` in the
+response indicates that more results might be available.
Returns:
An object of the form:
{ # Result returned from `ListSinks`.
- "nextPageToken": "A String", # If there are more results than were returned, then `nextPageToken` is included in the response. To get the next set of results, call this method again using the value of `nextPageToken` as `pageToken`.
+ "nextPageToken": "A String", # If there might be more results than appear in this response, then
+ # `nextPageToken` is included. To get the next set of results, call the same
+ # method again using the value of `nextPageToken` as `pageToken`.
"sinks": [ # A list of sinks.
- { # Describes a sink used to export log entries outside Cloud Logging.
- "filter": "A String", # An [advanced logs filter](/logging/docs/view/advanced_filters). Only log entries matching that filter are exported. The filter must be consistent with the log entry format specified by the `outputVersionFormat` parameter, regardless of the format of the log entry that was originally written to Cloud Logging. Example (V2 format): `"logName=projects/my-projectid/logs/syslog AND severity>=ERROR"`.
- "destination": "A String", # The export destination. See [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs). Examples: `"storage.googleapis.com/a-bucket"`, `"bigquery.googleapis.com/projects/a-project-id/datasets/a-dataset"`.
- "name": "A String", # Required. The client-assigned sink identifier. Example: `"my-severe-errors-to-pubsub"`. Sink identifiers are limited to 1000 characters and can include only the following characters: `A-Z`, `a-z`, `0-9`, and the special characters `_-.`.
- "outputVersionFormat": "A String", # The log entry version to use for this sink's exported log entries. This version does not have to correspond to the version of the log entry when it was written to Cloud Logging.
+ { # Describes a sink used to export log entries outside Stackdriver Logging.
+ "filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters).
+ # Only log entries matching the filter are exported. The filter
+ # must be consistent with the log entry format specified by the
+ # `outputVersionFormat` parameter, regardless of the format of the
+ # log entry that was originally written to Stackdriver Logging.
+ # Example filter (V2 format):
+ #
+ # logName=projects/my-projectid/logs/syslog AND severity>=ERROR
+ "destination": "A String", # Required. The export destination. See
+ # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs).
+ # Examples:
+ #
+ # "storage.googleapis.com/my-gcs-bucket"
+ # "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset"
+ # "pubsub.googleapis.com/projects/my-project/topics/my-topic"
+ "writerIdentity": "A String", # Output only. The iam identity to which the destination needs to grant write
+ # access. This may be a service account or a group.
+ # Examples (Do not assume these specific values):
+ # "serviceAccount:cloud-logs@system.gserviceaccount.com"
+ # "group:cloud-logs@google.com"
+ #
+ # For GCS destinations, the role "roles/owner" is required on the bucket
+ # For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is
+ # required on the topic
+ # For BigQuery, the role "roles/editor" is required on the dataset
+ "name": "A String", # Required. The client-assigned sink identifier, unique within the
+ # project. Example: `"my-syslog-errors-to-pubsub"`. Sink identifiers are
+ # limited to 1000 characters and can include only the following characters:
+ # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`. The maximum length
+ # of the name is 100 characters.
+ "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log
+ # entries. This version does not have to correspond to the version of the
+ # log entry that was written to Stackdriver Logging. If omitted, the
+ # v2 format is used.
},
],
}</pre>
@@ -197,31 +351,96 @@
</div>
<div class="method">
- <code class="details" id="update">update(sinkName, body, x__xgafv=None)</code>
- <pre>Creates or updates a sink.
+ <code class="details" id="update">update(sinkName=None, body, x__xgafv=None)</code>
+ <pre>Updates or creates a sink.
Args:
- sinkName: string, The resource name of the sink to update. Example: `"projects/my-project-id/sinks/my-sink-id"`. The updated sink must be provided in the request and have the same name that is specified in `sinkName`. If the sink does not exist, it is created. (required)
+ sinkName: string, Required. The resource name of the sink to update, including the parent
+resource and the sink identifier. If the sink does not exist, this method
+creates the sink. Example: `"projects/my-project-id/sinks/my-sink-id"`. (required)
body: object, The request body. (required)
The object takes the form of:
-{ # Describes a sink used to export log entries outside Cloud Logging.
- "filter": "A String", # An [advanced logs filter](/logging/docs/view/advanced_filters). Only log entries matching that filter are exported. The filter must be consistent with the log entry format specified by the `outputVersionFormat` parameter, regardless of the format of the log entry that was originally written to Cloud Logging. Example (V2 format): `"logName=projects/my-projectid/logs/syslog AND severity>=ERROR"`.
- "destination": "A String", # The export destination. See [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs). Examples: `"storage.googleapis.com/a-bucket"`, `"bigquery.googleapis.com/projects/a-project-id/datasets/a-dataset"`.
- "name": "A String", # Required. The client-assigned sink identifier. Example: `"my-severe-errors-to-pubsub"`. Sink identifiers are limited to 1000 characters and can include only the following characters: `A-Z`, `a-z`, `0-9`, and the special characters `_-.`.
- "outputVersionFormat": "A String", # The log entry version to use for this sink's exported log entries. This version does not have to correspond to the version of the log entry when it was written to Cloud Logging.
+{ # Describes a sink used to export log entries outside Stackdriver Logging.
+ "filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters).
+ # Only log entries matching the filter are exported. The filter
+ # must be consistent with the log entry format specified by the
+ # `outputVersionFormat` parameter, regardless of the format of the
+ # log entry that was originally written to Stackdriver Logging.
+ # Example filter (V2 format):
+ #
+ # logName=projects/my-projectid/logs/syslog AND severity>=ERROR
+ "destination": "A String", # Required. The export destination. See
+ # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs).
+ # Examples:
+ #
+ # "storage.googleapis.com/my-gcs-bucket"
+ # "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset"
+ # "pubsub.googleapis.com/projects/my-project/topics/my-topic"
+ "writerIdentity": "A String", # Output only. The iam identity to which the destination needs to grant write
+ # access. This may be a service account or a group.
+ # Examples (Do not assume these specific values):
+ # "serviceAccount:cloud-logs@system.gserviceaccount.com"
+ # "group:cloud-logs@google.com"
+ #
+ # For GCS destinations, the role "roles/owner" is required on the bucket
+ # For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is
+ # required on the topic
+ # For BigQuery, the role "roles/editor" is required on the dataset
+ "name": "A String", # Required. The client-assigned sink identifier, unique within the
+ # project. Example: `"my-syslog-errors-to-pubsub"`. Sink identifiers are
+ # limited to 1000 characters and can include only the following characters:
+ # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`. The maximum length
+ # of the name is 100 characters.
+ "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log
+ # entries. This version does not have to correspond to the version of the
+ # log entry that was written to Stackdriver Logging. If omitted, the
+ # v2 format is used.
}
x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
- { # Describes a sink used to export log entries outside Cloud Logging.
- "filter": "A String", # An [advanced logs filter](/logging/docs/view/advanced_filters). Only log entries matching that filter are exported. The filter must be consistent with the log entry format specified by the `outputVersionFormat` parameter, regardless of the format of the log entry that was originally written to Cloud Logging. Example (V2 format): `"logName=projects/my-projectid/logs/syslog AND severity>=ERROR"`.
- "destination": "A String", # The export destination. See [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs). Examples: `"storage.googleapis.com/a-bucket"`, `"bigquery.googleapis.com/projects/a-project-id/datasets/a-dataset"`.
- "name": "A String", # Required. The client-assigned sink identifier. Example: `"my-severe-errors-to-pubsub"`. Sink identifiers are limited to 1000 characters and can include only the following characters: `A-Z`, `a-z`, `0-9`, and the special characters `_-.`.
- "outputVersionFormat": "A String", # The log entry version to use for this sink's exported log entries. This version does not have to correspond to the version of the log entry when it was written to Cloud Logging.
+ { # Describes a sink used to export log entries outside Stackdriver Logging.
+ "filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters).
+ # Only log entries matching the filter are exported. The filter
+ # must be consistent with the log entry format specified by the
+ # `outputVersionFormat` parameter, regardless of the format of the
+ # log entry that was originally written to Stackdriver Logging.
+ # Example filter (V2 format):
+ #
+ # logName=projects/my-projectid/logs/syslog AND severity>=ERROR
+ "destination": "A String", # Required. The export destination. See
+ # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs).
+ # Examples:
+ #
+ # "storage.googleapis.com/my-gcs-bucket"
+ # "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset"
+ # "pubsub.googleapis.com/projects/my-project/topics/my-topic"
+ "writerIdentity": "A String", # Output only. The iam identity to which the destination needs to grant write
+ # access. This may be a service account or a group.
+ # Examples (Do not assume these specific values):
+ # "serviceAccount:cloud-logs@system.gserviceaccount.com"
+ # "group:cloud-logs@google.com"
+ #
+ # For GCS destinations, the role "roles/owner" is required on the bucket
+ # For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is
+ # required on the topic
+ # For BigQuery, the role "roles/editor" is required on the dataset
+ "name": "A String", # Required. The client-assigned sink identifier, unique within the
+ # project. Example: `"my-syslog-errors-to-pubsub"`. Sink identifiers are
+ # limited to 1000 characters and can include only the following characters:
+ # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`. The maximum length
+ # of the name is 100 characters.
+ "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log
+ # entries. This version does not have to correspond to the version of the
+ # log entry that was written to Stackdriver Logging. If omitted, the
+ # v2 format is used.
}</pre>
</div>
diff --git a/docs/dyn/ml_v1beta1.html b/docs/dyn/ml_v1beta1.html
new file mode 100644
index 0000000..c8ffcd4
--- /dev/null
+++ b/docs/dyn/ml_v1beta1.html
@@ -0,0 +1,103 @@
+<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="ml_v1beta1.html">Google Cloud Machine Learning</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="ml_v1beta1.projects.html">projects()</a></code>
+</p>
+<p class="firstline">Returns the projects Resource.</p>
+
+<p class="toc_element">
+ <code><a href="#new_batch_http_request">new_batch_http_request()</a></code></p>
+<p class="firstline">Create a BatchHttpRequest object based on the discovery document.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="new_batch_http_request">new_batch_http_request()</code>
+ <pre>Create a BatchHttpRequest object based on the discovery document.
+
+ Args:
+ callback: callable, A callback to be called for each response, of the
+ form callback(id, response, exception). The first parameter is the
+ request id, and the second is the deserialized response object. The
+ third is an apiclient.errors.HttpError exception object if an HTTP
+ error occurred while processing the request, or None if no error
+ occurred.
+
+ Returns:
+ A BatchHttpRequest object based on the discovery document.
+ </pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/ml_v1beta1.projects.html b/docs/dyn/ml_v1beta1.projects.html
new file mode 100644
index 0000000..6aab1f0
--- /dev/null
+++ b/docs/dyn/ml_v1beta1.projects.html
@@ -0,0 +1,368 @@
+<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="ml_v1beta1.html">Google Cloud Machine Learning</a> . <a href="ml_v1beta1.projects.html">projects</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="ml_v1beta1.projects.jobs.html">jobs()</a></code>
+</p>
+<p class="firstline">Returns the jobs Resource.</p>
+
+<p class="toc_element">
+ <code><a href="ml_v1beta1.projects.models.html">models()</a></code>
+</p>
+<p class="firstline">Returns the models Resource.</p>
+
+<p class="toc_element">
+ <code><a href="ml_v1beta1.projects.operations.html">operations()</a></code>
+</p>
+<p class="firstline">Returns the operations Resource.</p>
+
+<p class="toc_element">
+ <code><a href="#getConfig">getConfig(name=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Get the service account information associated with your project. You need</p>
+<p class="toc_element">
+ <code><a href="#predict">predict(name=None, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Performs prediction on the data in the request.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="getConfig">getConfig(name=None, x__xgafv=None)</code>
+ <pre>Get the service account information associated with your project. You need
+this information in order to grant the service account persmissions for
+the Google Cloud Storage location where you put your model training code
+for training the model with Google Cloud Machine Learning.
+
+Args:
+ name: string, Required. The project name.
+
+Authorization: requires `Viewer` role on the specified project. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Returns service account information associated with a project.
+ "serviceAccountProject": "A String", # The project number for `service_account`.
+ "serviceAccount": "A String", # The service account Cloud ML uses to access resources in the project.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="predict">predict(name=None, body, x__xgafv=None)</code>
+ <pre>Performs prediction on the data in the request.
+
+Responses are very similar to requests. There are two top-level fields,
+each of which are JSON lists:
+
+<dl>
+ <dt>predictions</dt>
+ <dd>The list of predictions, one per instance in the request.</dd>
+ <dt>error</dt>
+ <dd>An error message returned instead of a prediction list if any
+ instance produced an error.</dd>
+</dl>
+
+If the call is successful, the response body will contain one prediction
+entry per instance in the request body. If prediction fails for any
+instance, the response body will contain no predictions and will contian
+a single error entry instead.
+
+Even though there is one prediction per instance, the format of a
+prediction is not directly related to the format of an instance.
+Predictions take whatever format is specified in the outputs collection
+defined in the model. The collection of predictions is returned in a JSON
+list. Each member of the list can be a simple value, a list, or a JSON
+object of any complexity. If your model has more than one output tensor,
+each prediction will be a JSON object containing a name/value pair for each
+output. The names identify the output aliases in the graph.
+
+The following examples show some possible responses:
+
+A simple set of predictions for three input instances, where each
+prediction is an integer value:
+<pre>
+{"predictions": [5, 4, 3]}
+</pre>
+A more complex set of predictions, each containing two named values that
+correspond to output tensors, named **label** and **scores** respectively.
+The value of **label** is the predicted category ("car" or "beach") and
+**scores** contains a list of probabilities for that instance across the
+possible categories.
+<pre>
+{"predictions": [{"label": "beach", "scores": [0.1, 0.9]},
+ {"label": "car", "scores": [0.75, 0.25]}]}
+</pre>
+A response when there is an error processing an input instance:
+<pre>
+{"error": "Divide by zero"}
+</pre>
+
+Args:
+ name: string, Required. The resource name of a model or a version.
+
+Authorization: requires `Viewer` role on the parent project. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Request for predictions to be issued against a trained model.
+ #
+ # The body of the request is a single JSON object with a single top-level
+ # field:
+ #
+ # <dl>
+ # <dt>instances</dt>
+ # <dd>A JSON array containing values representing the instances to use for
+ # prediction.</dd>
+ # </dl>
+ #
+ # The structure of each element of the instances list is determined by your
+ # model's input definition. Instances can include named inputs or can contain
+ # only unlabeled values.
+ #
+ # Most data does not include named inputs. Some instances will be simple
+ # JSON values (boolean, number, or string). However, instances are often lists
+ # of simple values, or complex nested lists. Here are some examples of request
+ # bodies:
+ #
+ # CSV data with each row encoded as a string value:
+ # <pre>
+ # {"instances": ["1.0,true,\\"x\\"", "-2.0,false,\\"y\\""]}
+ # </pre>
+ # Plain text:
+ # <pre>
+ # {"instances": ["the quick brown fox", "la bruja le dio"]}
+ # </pre>
+ # Sentences encoded as lists of words (vectors of strings):
+ # <pre>
+ # {"instances": [["the","quick","brown"], ["la","bruja","le"]]}
+ # </pre>
+ # Floating point scalar values:
+ # <pre>
+ # {"instances": [0.0, 1.1, 2.2]}
+ # </pre>
+ # Vectors of integers:
+ # <pre>
+ # {"instances": [[0, 1, 2], [3, 4, 5],...]}
+ # </pre>
+ # Tensors (in this case, two-dimensional tensors):
+ # <pre>
+ # {"instances": [[[0, 1, 2], [3, 4, 5]], ...]}
+ # </pre>
+ # Images represented as a three-dimensional list. In this encoding scheme the
+ # first two dimensions represent the rows and columns of the image, and the
+ # third contains the R, G, and B values for each pixel.
+ # <pre>
+ # {"instances": [[[[138, 30, 66], [130, 20, 56], ...]]]]}
+ # </pre>
+ # Data must be encoded as UTF-8. If your data uses another character encoding,
+ # you must base64 encode the data and mark it as binary. To mark a JSON string
+ # as binary, replace it with an object with a single attribute named `b`:
+ # <pre>{"b": "..."} </pre>
+ # For example:
+ #
+ # Two Serialized tf.Examples (fake data, for illustrative purposes only):
+ # <pre>
+ # {"instances": [{"b64": "X5ad6u"}, {"b64": "IA9j4nx"}]}
+ # </pre>
+ # Two JPEG image byte strings (fake data, for illustrative purposes only):
+ # <pre>
+ # {"instances": [{"b64": "ASa8asdf"}, {"b64": "JLK7ljk3"}]}
+ # </pre>
+ # If your data includes named references, format each instance as a JSON object
+ # with the named references as the keys:
+ #
+ # JSON input data to be preprocessed:
+ # <pre>
+ # {"instances": [{"a": 1.0, "b": true, "c": "x"},
+ # {"a": -2.0, "b": false, "c": "y"}]}
+ # </pre>
+ # Some models have an underlying TensorFlow graph that accepts multiple input
+ # tensors. In this case, you should use the names of JSON name/value pairs to
+ # identify the input tensors, as shown in the following exmaples:
+ #
+ # For a graph with input tensor aliases "tag" (string) and "image"
+ # (base64-encoded string):
+ # <pre>
+ # {"instances": [{"tag": "beach", "image": {"b64": "ASa8asdf"}},
+ # {"tag": "car", "image": {"b64": "JLK7ljk3"}}]}
+ # </pre>
+ # For a graph with input tensor aliases "tag" (string) and "image"
+ # (3-dimensional array of 8-bit ints):
+ # <pre>
+ # {"instances": [{"tag": "beach", "image": [[[263, 1, 10], [262, 2, 11], ...]]},
+ # {"tag": "car", "image": [[[10, 11, 24], [23, 10, 15], ...]]}]}
+ # </pre>
+ # If the call is successful, the response body will contain one prediction
+ # entry per instance in the request body. If prediction fails for any
+ # instance, the response body will contain no predictions and will contian
+ # a single error entry instead.
+ "httpBody": { # Message that represents an arbitrary HTTP body. It should only be used for #
+ # Required. The prediction request body.
+ # payload formats that can't be represented as JSON, such as raw binary or
+ # an HTML page.
+ #
+ #
+ # This message can be used both in streaming and non-streaming API methods in
+ # the request as well as the response.
+ #
+ # It can be used as a top-level request field, which is convenient if one
+ # wants to extract parameters from either the URL or HTTP template into the
+ # request fields and also want access to the raw HTTP body.
+ #
+ # Example:
+ #
+ # message GetResourceRequest {
+ # // A unique request id.
+ # string request_id = 1;
+ #
+ # // The raw HTTP body is bound to this field.
+ # google.api.HttpBody http_body = 2;
+ # }
+ #
+ # service ResourceService {
+ # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);
+ # rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty);
+ # }
+ #
+ # Example with streaming methods:
+ #
+ # service CaldavService {
+ # rpc GetCalendar(stream google.api.HttpBody)
+ # returns (stream google.api.HttpBody);
+ # rpc UpdateCalendar(stream google.api.HttpBody)
+ # returns (stream google.api.HttpBody);
+ # }
+ #
+ # Use of this type only changes how the request and response bodies are
+ # handled, all other features will continue to work unchanged.
+ "contentType": "A String", # The HTTP Content-Type string representing the content type of the body.
+ "data": "A String", # HTTP body binary data.
+ },
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Message that represents an arbitrary HTTP body. It should only be used for
+ # payload formats that can't be represented as JSON, such as raw binary or
+ # an HTML page.
+ #
+ #
+ # This message can be used both in streaming and non-streaming API methods in
+ # the request as well as the response.
+ #
+ # It can be used as a top-level request field, which is convenient if one
+ # wants to extract parameters from either the URL or HTTP template into the
+ # request fields and also want access to the raw HTTP body.
+ #
+ # Example:
+ #
+ # message GetResourceRequest {
+ # // A unique request id.
+ # string request_id = 1;
+ #
+ # // The raw HTTP body is bound to this field.
+ # google.api.HttpBody http_body = 2;
+ # }
+ #
+ # service ResourceService {
+ # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);
+ # rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty);
+ # }
+ #
+ # Example with streaming methods:
+ #
+ # service CaldavService {
+ # rpc GetCalendar(stream google.api.HttpBody)
+ # returns (stream google.api.HttpBody);
+ # rpc UpdateCalendar(stream google.api.HttpBody)
+ # returns (stream google.api.HttpBody);
+ # }
+ #
+ # Use of this type only changes how the request and response bodies are
+ # handled, all other features will continue to work unchanged.
+ "contentType": "A String", # The HTTP Content-Type string representing the content type of the body.
+ "data": "A String", # HTTP body binary data.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/ml_v1beta1.projects.jobs.html b/docs/dyn/ml_v1beta1.projects.jobs.html
new file mode 100644
index 0000000..427080e
--- /dev/null
+++ b/docs/dyn/ml_v1beta1.projects.jobs.html
@@ -0,0 +1,935 @@
+<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="ml_v1beta1.html">Google Cloud Machine Learning</a> . <a href="ml_v1beta1.projects.html">projects</a> . <a href="ml_v1beta1.projects.jobs.html">jobs</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#cancel">cancel(name=None, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Cancels a running job.</p>
+<p class="toc_element">
+ <code><a href="#create">create(parent=None, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Creates a training or a batch prediction job.</p>
+<p class="toc_element">
+ <code><a href="#get">get(name=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Describes a job.</p>
+<p class="toc_element">
+ <code><a href="#list">list(parent=None, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Lists the jobs in the project.</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>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="cancel">cancel(name=None, body, x__xgafv=None)</code>
+ <pre>Cancels a running job.
+
+Args:
+ name: string, Required. The name of the job to cancel.
+
+Authorization: requires `Editor` role on the parent project. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Request message for the CancelJob method.
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated
+ # empty messages in your APIs. A typical example is to use it as the request
+ # or the response type of an API method. For instance:
+ #
+ # service Foo {
+ # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
+ # }
+ #
+ # The JSON representation for `Empty` is empty JSON object `{}`.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="create">create(parent=None, body, x__xgafv=None)</code>
+ <pre>Creates a training or a batch prediction job.
+
+Args:
+ parent: string, Required. The project name.
+
+Authorization: requires `Editor` role on the specified project. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Represents a training or prediction job.
+ "trainingOutput": { # Represents results of a training job. # The current training job result.
+ "completedTrialCount": "A String", # The number of hyperparameter tuning trials that completed successfully.
+ "trials": [ # Results for individual Hyperparameter trials.
+ { # Represents the result of a single hyperparameter tuning trial from a
+ # training job. The TrainingOutput object that is returned on successful
+ # completion of a training job with hyperparameter tuning includes a list
+ # of HyperparameterOutput objects, one for each successful trial.
+ "hyperparameters": { # The hyperparameters given to this trial.
+ "a_key": "A String",
+ },
+ "trialId": "A String", # The trial id for these results.
+ "allMetrics": [ # All recorded object metrics for this trial.
+ { # An observed value of a metric.
+ "trainingStep": "A String", # The global training step for this metric.
+ "objectiveValue": 3.14, # The objective value at this training step.
+ },
+ ],
+ "finalMetric": { # An observed value of a metric. # The final objective metric seen for this trial.
+ "trainingStep": "A String", # The global training step for this metric.
+ "objectiveValue": 3.14, # The objective value at this training step.
+ },
+ },
+ ],
+ },
+ "startTime": "A String", # Output only. When the job processing was started.
+ "errorMessage": "A String", # Output only. The details of a failure or a cancellation.
+ "jobId": "A String", # Required. The user-specified id of the job.
+ "state": "A String", # Output only. The detailed state of a job.
+ "predictionInput": { # Represents input parameters for a prediction job. # Input parameters to create a prediction job.
+ "modelName": "A String", # Use this field if you want to use the default version for the specified
+ # model. The string must use the following format:
+ #
+ # `"project/<var>[YOUR_PROJECT]</var>/models/<var>[YOUR_MODEL]</var>"`
+ "inputPaths": [ # Required. The Google Cloud Storage location of the input data files.
+ # May contain wildcards.
+ "A String",
+ ],
+ "maxWorkerCount": "A String", # Optional. The maximum amount of workers to be used for parallel processing.
+ # Defaults to 10.
+ "outputPath": "A String", # Required. The output Google Cloud Storage location.
+ "dataFormat": "A String", # Required. The format of the input data files.
+ "versionName": "A String", # Use this field if you want to specify a version of the model to use. The
+ # string is formatted the same way as `model_version`, with the addition
+ # of the version information:
+ #
+ # `"project/<var>[YOUR_PROJECT]</var>/models/<var>YOUR_MODEL/versions/<var>[YOUR_VERSION]</var>"`
+ "region": "A String", # Required. The Google Compute Engine region to run the prediction job in.
+ },
+ "trainingInput": { # Represents input parameters for a training job. # Input parameters to create a training job.
+ "workerType": "A String", # Optional. Specifies the type of virtual machine to use for your training
+ # job's worker nodes.
+ #
+ # The supported values are the same as those described in the entry for
+ # `masterType`.
+ #
+ # This value must be present when `scaleTier` is set to `CUSTOM` and
+ # `workerCount` is greater than zero.
+ "scaleTier": "A String", # Required. Specifies the machine types, the number of replicas for workers
+ # and parameter servers.
+ "masterType": "A String", # Optional. Specifies the type of virtual machine to use for your training
+ # job's master worker.
+ #
+ # The following types are supported:
+ #
+ # <dl>
+ # <dt>standard</dt>
+ # <dd>
+ # A basic machine configuration suitable for training simple models with
+ # small to moderate datasets.
+ # </dd>
+ # <dt>large_model</dt>
+ # <dd>
+ # A machine with a lot of memory, specially suited for parameter servers
+ # when your model is large (having many hidden layers or layers with very
+ # large numbers of nodes).
+ # </dd>
+ # <dt>complex_model_s</dt>
+ # <dd>
+ # A machine suitable for the master and workers of the cluster when your
+ # model requires more computation than the standard machine can handle
+ # satisfactorily.
+ # </dd>
+ # <dt>complex_model_m</dt>
+ # <dd>
+ # A machine with roughly twice the number of cores and roughly double the
+ # memory of <code suppresswarning="true">complex_model_s</code>.
+ # </dd>
+ # <dt>complex_model_l</dt>
+ # <dd>
+ # A machine with roughly twice the number of cores and roughly double the
+ # memory of <code suppresswarning="true">complex_model_m</code>.
+ # </dd>
+ # </dl>
+ #
+ # You must set this value when `scaleTier` is set to `CUSTOM`.
+ "hyperparameters": { # Represents a set of hyperparameters to optimize. # Optional. The set of Hyperparameters to tune.
+ "maxTrials": 42, # Optional. How many training trials should be attempted to optimize
+ # the specified hyperparameters.
+ #
+ # Defaults to one.
+ "params": [ # Required. The set of parameters to tune.
+ { # Represents a single hyperparameter to optimize.
+ "maxValue": 3.14, # Required if typeis `DOUBLE` or `INTEGER`. This field
+ # should be unset if type is `CATEGORICAL`. This value should be integers if
+ # type is `INTEGER`.
+ "minValue": 3.14, # Required if type is `DOUBLE` or `INTEGER`. This field
+ # should be unset if type is `CATEGORICAL`. This value should be integers if
+ # type is INTEGER.
+ "discreteValues": [ # Required if type is `DISCRETE`.
+ # A list of feasible points.
+ # The list should be in strictly increasing order. For instance, this
+ # parameter might have possible settings of 1.5, 2.5, and 4.0. This list
+ # should not contain more than 1,000 values.
+ 3.14,
+ ],
+ "parameterName": "A String", # Required. The parameter name must be unique amongst all ParameterConfigs in
+ # a HyperparameterSpec message. E.g., "learning_rate".
+ "categoricalValues": [ # Required if type is `CATEGORICAL`. The list of possible categories.
+ "A String",
+ ],
+ "type": "A String", # Required. The type of the parameter.
+ "scaleType": "A String", # Optional. How the parameter should be scaled to the hypercube.
+ # Leave unset for categorical parameters.
+ # Some kind of scaling is strongly recommended for real or integral
+ # parameters (e.g., `UNIT_LINEAR_SCALE`).
+ },
+ ],
+ "maxParallelTrials": 42, # Optional. The number of training trials to run concurrently.
+ # You can reduce the time it takes to perform hyperparameter tuning by adding
+ # trials in parallel. However, each trail only benefits from the information
+ # gained in completed trials. That means that a trial does not get access to
+ # the results of trials running at the same time, which could reduce the
+ # quality of the overall optimization.
+ #
+ # Each trial will use the same scale tier and machine types.
+ #
+ # Defaults to one.
+ "goal": "A String", # Required. The type of goal to use for tuning. Available types are
+ # `MAXIMIZE` and `MINIMIZE`.
+ #
+ # Defaults to `MAXIMIZE`.
+ },
+ "region": "A String", # Required. The Google Compute Engine region to run the training job in.
+ "args": [ # Optional. Command line arguments to pass to the program.
+ "A String",
+ ],
+ "pythonModule": "A String", # Required. The Python module name to run after installing the packages.
+ "packageUris": [ # Required. The Google Cloud Storage location of the packages with
+ # the training program and any additional dependencies.
+ "A String",
+ ],
+ "workerCount": "A String", # Optional. The number of worker replicas to use for the training job. Each
+ # replica in the cluster will be of the type specified in `worker_type`.
+ #
+ # This value can only be used when `scale_tier` is set to `CUSTOM`. If you
+ # set this value, you must also set `worker_type`.
+ "parameterServerType": "A String", # Optional. Specifies the type of virtual machine to use for your training
+ # job's parameter server.
+ #
+ # The supported values are the same as those described in the entry for
+ # `master_type`.
+ #
+ # This value must be present when `scaleTier` is set to `CUSTOM` and
+ # `parameter_server_count` is greater than zero.
+ "parameterServerCount": "A String", # Optional. The number of parameter server replicas to use for the training
+ # job. Each replica in the cluster will be of the type specified in
+ # `parameter_server_type`.
+ #
+ # This value can only be used when `scale_tier` is set to `CUSTOM`.If you
+ # set this value, you must also set `parameter_server_type`.
+ },
+ "endTime": "A String", # Output only. When the job processing was completed.
+ "predictionOutput": { # Represents results of a prediction job. # The current prediction job result.
+ "outputPath": "A String", # The output Google Cloud Storage location provided at the job creation time.
+ "predictionCount": "A String", # The number of generated predictions.
+ "errorCount": "A String", # The number of data instances which resulted in errors.
+ },
+ "createTime": "A String", # Output only. When the job was created.
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a training or prediction job.
+ "trainingOutput": { # Represents results of a training job. # The current training job result.
+ "completedTrialCount": "A String", # The number of hyperparameter tuning trials that completed successfully.
+ "trials": [ # Results for individual Hyperparameter trials.
+ { # Represents the result of a single hyperparameter tuning trial from a
+ # training job. The TrainingOutput object that is returned on successful
+ # completion of a training job with hyperparameter tuning includes a list
+ # of HyperparameterOutput objects, one for each successful trial.
+ "hyperparameters": { # The hyperparameters given to this trial.
+ "a_key": "A String",
+ },
+ "trialId": "A String", # The trial id for these results.
+ "allMetrics": [ # All recorded object metrics for this trial.
+ { # An observed value of a metric.
+ "trainingStep": "A String", # The global training step for this metric.
+ "objectiveValue": 3.14, # The objective value at this training step.
+ },
+ ],
+ "finalMetric": { # An observed value of a metric. # The final objective metric seen for this trial.
+ "trainingStep": "A String", # The global training step for this metric.
+ "objectiveValue": 3.14, # The objective value at this training step.
+ },
+ },
+ ],
+ },
+ "startTime": "A String", # Output only. When the job processing was started.
+ "errorMessage": "A String", # Output only. The details of a failure or a cancellation.
+ "jobId": "A String", # Required. The user-specified id of the job.
+ "state": "A String", # Output only. The detailed state of a job.
+ "predictionInput": { # Represents input parameters for a prediction job. # Input parameters to create a prediction job.
+ "modelName": "A String", # Use this field if you want to use the default version for the specified
+ # model. The string must use the following format:
+ #
+ # `"project/<var>[YOUR_PROJECT]</var>/models/<var>[YOUR_MODEL]</var>"`
+ "inputPaths": [ # Required. The Google Cloud Storage location of the input data files.
+ # May contain wildcards.
+ "A String",
+ ],
+ "maxWorkerCount": "A String", # Optional. The maximum amount of workers to be used for parallel processing.
+ # Defaults to 10.
+ "outputPath": "A String", # Required. The output Google Cloud Storage location.
+ "dataFormat": "A String", # Required. The format of the input data files.
+ "versionName": "A String", # Use this field if you want to specify a version of the model to use. The
+ # string is formatted the same way as `model_version`, with the addition
+ # of the version information:
+ #
+ # `"project/<var>[YOUR_PROJECT]</var>/models/<var>YOUR_MODEL/versions/<var>[YOUR_VERSION]</var>"`
+ "region": "A String", # Required. The Google Compute Engine region to run the prediction job in.
+ },
+ "trainingInput": { # Represents input parameters for a training job. # Input parameters to create a training job.
+ "workerType": "A String", # Optional. Specifies the type of virtual machine to use for your training
+ # job's worker nodes.
+ #
+ # The supported values are the same as those described in the entry for
+ # `masterType`.
+ #
+ # This value must be present when `scaleTier` is set to `CUSTOM` and
+ # `workerCount` is greater than zero.
+ "scaleTier": "A String", # Required. Specifies the machine types, the number of replicas for workers
+ # and parameter servers.
+ "masterType": "A String", # Optional. Specifies the type of virtual machine to use for your training
+ # job's master worker.
+ #
+ # The following types are supported:
+ #
+ # <dl>
+ # <dt>standard</dt>
+ # <dd>
+ # A basic machine configuration suitable for training simple models with
+ # small to moderate datasets.
+ # </dd>
+ # <dt>large_model</dt>
+ # <dd>
+ # A machine with a lot of memory, specially suited for parameter servers
+ # when your model is large (having many hidden layers or layers with very
+ # large numbers of nodes).
+ # </dd>
+ # <dt>complex_model_s</dt>
+ # <dd>
+ # A machine suitable for the master and workers of the cluster when your
+ # model requires more computation than the standard machine can handle
+ # satisfactorily.
+ # </dd>
+ # <dt>complex_model_m</dt>
+ # <dd>
+ # A machine with roughly twice the number of cores and roughly double the
+ # memory of <code suppresswarning="true">complex_model_s</code>.
+ # </dd>
+ # <dt>complex_model_l</dt>
+ # <dd>
+ # A machine with roughly twice the number of cores and roughly double the
+ # memory of <code suppresswarning="true">complex_model_m</code>.
+ # </dd>
+ # </dl>
+ #
+ # You must set this value when `scaleTier` is set to `CUSTOM`.
+ "hyperparameters": { # Represents a set of hyperparameters to optimize. # Optional. The set of Hyperparameters to tune.
+ "maxTrials": 42, # Optional. How many training trials should be attempted to optimize
+ # the specified hyperparameters.
+ #
+ # Defaults to one.
+ "params": [ # Required. The set of parameters to tune.
+ { # Represents a single hyperparameter to optimize.
+ "maxValue": 3.14, # Required if typeis `DOUBLE` or `INTEGER`. This field
+ # should be unset if type is `CATEGORICAL`. This value should be integers if
+ # type is `INTEGER`.
+ "minValue": 3.14, # Required if type is `DOUBLE` or `INTEGER`. This field
+ # should be unset if type is `CATEGORICAL`. This value should be integers if
+ # type is INTEGER.
+ "discreteValues": [ # Required if type is `DISCRETE`.
+ # A list of feasible points.
+ # The list should be in strictly increasing order. For instance, this
+ # parameter might have possible settings of 1.5, 2.5, and 4.0. This list
+ # should not contain more than 1,000 values.
+ 3.14,
+ ],
+ "parameterName": "A String", # Required. The parameter name must be unique amongst all ParameterConfigs in
+ # a HyperparameterSpec message. E.g., "learning_rate".
+ "categoricalValues": [ # Required if type is `CATEGORICAL`. The list of possible categories.
+ "A String",
+ ],
+ "type": "A String", # Required. The type of the parameter.
+ "scaleType": "A String", # Optional. How the parameter should be scaled to the hypercube.
+ # Leave unset for categorical parameters.
+ # Some kind of scaling is strongly recommended for real or integral
+ # parameters (e.g., `UNIT_LINEAR_SCALE`).
+ },
+ ],
+ "maxParallelTrials": 42, # Optional. The number of training trials to run concurrently.
+ # You can reduce the time it takes to perform hyperparameter tuning by adding
+ # trials in parallel. However, each trail only benefits from the information
+ # gained in completed trials. That means that a trial does not get access to
+ # the results of trials running at the same time, which could reduce the
+ # quality of the overall optimization.
+ #
+ # Each trial will use the same scale tier and machine types.
+ #
+ # Defaults to one.
+ "goal": "A String", # Required. The type of goal to use for tuning. Available types are
+ # `MAXIMIZE` and `MINIMIZE`.
+ #
+ # Defaults to `MAXIMIZE`.
+ },
+ "region": "A String", # Required. The Google Compute Engine region to run the training job in.
+ "args": [ # Optional. Command line arguments to pass to the program.
+ "A String",
+ ],
+ "pythonModule": "A String", # Required. The Python module name to run after installing the packages.
+ "packageUris": [ # Required. The Google Cloud Storage location of the packages with
+ # the training program and any additional dependencies.
+ "A String",
+ ],
+ "workerCount": "A String", # Optional. The number of worker replicas to use for the training job. Each
+ # replica in the cluster will be of the type specified in `worker_type`.
+ #
+ # This value can only be used when `scale_tier` is set to `CUSTOM`. If you
+ # set this value, you must also set `worker_type`.
+ "parameterServerType": "A String", # Optional. Specifies the type of virtual machine to use for your training
+ # job's parameter server.
+ #
+ # The supported values are the same as those described in the entry for
+ # `master_type`.
+ #
+ # This value must be present when `scaleTier` is set to `CUSTOM` and
+ # `parameter_server_count` is greater than zero.
+ "parameterServerCount": "A String", # Optional. The number of parameter server replicas to use for the training
+ # job. Each replica in the cluster will be of the type specified in
+ # `parameter_server_type`.
+ #
+ # This value can only be used when `scale_tier` is set to `CUSTOM`.If you
+ # set this value, you must also set `parameter_server_type`.
+ },
+ "endTime": "A String", # Output only. When the job processing was completed.
+ "predictionOutput": { # Represents results of a prediction job. # The current prediction job result.
+ "outputPath": "A String", # The output Google Cloud Storage location provided at the job creation time.
+ "predictionCount": "A String", # The number of generated predictions.
+ "errorCount": "A String", # The number of data instances which resulted in errors.
+ },
+ "createTime": "A String", # Output only. When the job was created.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(name=None, x__xgafv=None)</code>
+ <pre>Describes a job.
+
+Args:
+ name: string, Required. The name of the job to get the description of.
+
+Authorization: requires `Viewer` role on the parent project. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a training or prediction job.
+ "trainingOutput": { # Represents results of a training job. # The current training job result.
+ "completedTrialCount": "A String", # The number of hyperparameter tuning trials that completed successfully.
+ "trials": [ # Results for individual Hyperparameter trials.
+ { # Represents the result of a single hyperparameter tuning trial from a
+ # training job. The TrainingOutput object that is returned on successful
+ # completion of a training job with hyperparameter tuning includes a list
+ # of HyperparameterOutput objects, one for each successful trial.
+ "hyperparameters": { # The hyperparameters given to this trial.
+ "a_key": "A String",
+ },
+ "trialId": "A String", # The trial id for these results.
+ "allMetrics": [ # All recorded object metrics for this trial.
+ { # An observed value of a metric.
+ "trainingStep": "A String", # The global training step for this metric.
+ "objectiveValue": 3.14, # The objective value at this training step.
+ },
+ ],
+ "finalMetric": { # An observed value of a metric. # The final objective metric seen for this trial.
+ "trainingStep": "A String", # The global training step for this metric.
+ "objectiveValue": 3.14, # The objective value at this training step.
+ },
+ },
+ ],
+ },
+ "startTime": "A String", # Output only. When the job processing was started.
+ "errorMessage": "A String", # Output only. The details of a failure or a cancellation.
+ "jobId": "A String", # Required. The user-specified id of the job.
+ "state": "A String", # Output only. The detailed state of a job.
+ "predictionInput": { # Represents input parameters for a prediction job. # Input parameters to create a prediction job.
+ "modelName": "A String", # Use this field if you want to use the default version for the specified
+ # model. The string must use the following format:
+ #
+ # `"project/<var>[YOUR_PROJECT]</var>/models/<var>[YOUR_MODEL]</var>"`
+ "inputPaths": [ # Required. The Google Cloud Storage location of the input data files.
+ # May contain wildcards.
+ "A String",
+ ],
+ "maxWorkerCount": "A String", # Optional. The maximum amount of workers to be used for parallel processing.
+ # Defaults to 10.
+ "outputPath": "A String", # Required. The output Google Cloud Storage location.
+ "dataFormat": "A String", # Required. The format of the input data files.
+ "versionName": "A String", # Use this field if you want to specify a version of the model to use. The
+ # string is formatted the same way as `model_version`, with the addition
+ # of the version information:
+ #
+ # `"project/<var>[YOUR_PROJECT]</var>/models/<var>YOUR_MODEL/versions/<var>[YOUR_VERSION]</var>"`
+ "region": "A String", # Required. The Google Compute Engine region to run the prediction job in.
+ },
+ "trainingInput": { # Represents input parameters for a training job. # Input parameters to create a training job.
+ "workerType": "A String", # Optional. Specifies the type of virtual machine to use for your training
+ # job's worker nodes.
+ #
+ # The supported values are the same as those described in the entry for
+ # `masterType`.
+ #
+ # This value must be present when `scaleTier` is set to `CUSTOM` and
+ # `workerCount` is greater than zero.
+ "scaleTier": "A String", # Required. Specifies the machine types, the number of replicas for workers
+ # and parameter servers.
+ "masterType": "A String", # Optional. Specifies the type of virtual machine to use for your training
+ # job's master worker.
+ #
+ # The following types are supported:
+ #
+ # <dl>
+ # <dt>standard</dt>
+ # <dd>
+ # A basic machine configuration suitable for training simple models with
+ # small to moderate datasets.
+ # </dd>
+ # <dt>large_model</dt>
+ # <dd>
+ # A machine with a lot of memory, specially suited for parameter servers
+ # when your model is large (having many hidden layers or layers with very
+ # large numbers of nodes).
+ # </dd>
+ # <dt>complex_model_s</dt>
+ # <dd>
+ # A machine suitable for the master and workers of the cluster when your
+ # model requires more computation than the standard machine can handle
+ # satisfactorily.
+ # </dd>
+ # <dt>complex_model_m</dt>
+ # <dd>
+ # A machine with roughly twice the number of cores and roughly double the
+ # memory of <code suppresswarning="true">complex_model_s</code>.
+ # </dd>
+ # <dt>complex_model_l</dt>
+ # <dd>
+ # A machine with roughly twice the number of cores and roughly double the
+ # memory of <code suppresswarning="true">complex_model_m</code>.
+ # </dd>
+ # </dl>
+ #
+ # You must set this value when `scaleTier` is set to `CUSTOM`.
+ "hyperparameters": { # Represents a set of hyperparameters to optimize. # Optional. The set of Hyperparameters to tune.
+ "maxTrials": 42, # Optional. How many training trials should be attempted to optimize
+ # the specified hyperparameters.
+ #
+ # Defaults to one.
+ "params": [ # Required. The set of parameters to tune.
+ { # Represents a single hyperparameter to optimize.
+ "maxValue": 3.14, # Required if typeis `DOUBLE` or `INTEGER`. This field
+ # should be unset if type is `CATEGORICAL`. This value should be integers if
+ # type is `INTEGER`.
+ "minValue": 3.14, # Required if type is `DOUBLE` or `INTEGER`. This field
+ # should be unset if type is `CATEGORICAL`. This value should be integers if
+ # type is INTEGER.
+ "discreteValues": [ # Required if type is `DISCRETE`.
+ # A list of feasible points.
+ # The list should be in strictly increasing order. For instance, this
+ # parameter might have possible settings of 1.5, 2.5, and 4.0. This list
+ # should not contain more than 1,000 values.
+ 3.14,
+ ],
+ "parameterName": "A String", # Required. The parameter name must be unique amongst all ParameterConfigs in
+ # a HyperparameterSpec message. E.g., "learning_rate".
+ "categoricalValues": [ # Required if type is `CATEGORICAL`. The list of possible categories.
+ "A String",
+ ],
+ "type": "A String", # Required. The type of the parameter.
+ "scaleType": "A String", # Optional. How the parameter should be scaled to the hypercube.
+ # Leave unset for categorical parameters.
+ # Some kind of scaling is strongly recommended for real or integral
+ # parameters (e.g., `UNIT_LINEAR_SCALE`).
+ },
+ ],
+ "maxParallelTrials": 42, # Optional. The number of training trials to run concurrently.
+ # You can reduce the time it takes to perform hyperparameter tuning by adding
+ # trials in parallel. However, each trail only benefits from the information
+ # gained in completed trials. That means that a trial does not get access to
+ # the results of trials running at the same time, which could reduce the
+ # quality of the overall optimization.
+ #
+ # Each trial will use the same scale tier and machine types.
+ #
+ # Defaults to one.
+ "goal": "A String", # Required. The type of goal to use for tuning. Available types are
+ # `MAXIMIZE` and `MINIMIZE`.
+ #
+ # Defaults to `MAXIMIZE`.
+ },
+ "region": "A String", # Required. The Google Compute Engine region to run the training job in.
+ "args": [ # Optional. Command line arguments to pass to the program.
+ "A String",
+ ],
+ "pythonModule": "A String", # Required. The Python module name to run after installing the packages.
+ "packageUris": [ # Required. The Google Cloud Storage location of the packages with
+ # the training program and any additional dependencies.
+ "A String",
+ ],
+ "workerCount": "A String", # Optional. The number of worker replicas to use for the training job. Each
+ # replica in the cluster will be of the type specified in `worker_type`.
+ #
+ # This value can only be used when `scale_tier` is set to `CUSTOM`. If you
+ # set this value, you must also set `worker_type`.
+ "parameterServerType": "A String", # Optional. Specifies the type of virtual machine to use for your training
+ # job's parameter server.
+ #
+ # The supported values are the same as those described in the entry for
+ # `master_type`.
+ #
+ # This value must be present when `scaleTier` is set to `CUSTOM` and
+ # `parameter_server_count` is greater than zero.
+ "parameterServerCount": "A String", # Optional. The number of parameter server replicas to use for the training
+ # job. Each replica in the cluster will be of the type specified in
+ # `parameter_server_type`.
+ #
+ # This value can only be used when `scale_tier` is set to `CUSTOM`.If you
+ # set this value, you must also set `parameter_server_type`.
+ },
+ "endTime": "A String", # Output only. When the job processing was completed.
+ "predictionOutput": { # Represents results of a prediction job. # The current prediction job result.
+ "outputPath": "A String", # The output Google Cloud Storage location provided at the job creation time.
+ "predictionCount": "A String", # The number of generated predictions.
+ "errorCount": "A String", # The number of data instances which resulted in errors.
+ },
+ "createTime": "A String", # Output only. When the job was created.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(parent=None, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
+ <pre>Lists the jobs in the project.
+
+Args:
+ parent: string, Required. The name of the project for which to list jobs.
+
+Authorization: requires `Viewer` role on the specified project. (required)
+ pageSize: integer, Optional. The number of jobs to retrieve per "page" of results. If there
+are more remaining results than this number, the response message will
+contain a valid value in the `next_page_token` field.
+
+The default value is 20, and the maximum page size is 100.
+ filter: string, Optional. Specifies the subset of jobs to retrieve.
+ pageToken: string, Optional. A page token to request the next page of results.
+
+You get the token from the `next_page_token` field of the response from
+the previous call.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response message for the ListJobs method.
+ "nextPageToken": "A String", # Optional. Pass this token as the `page_token` field of the request for a
+ # subsequent call.
+ "jobs": [ # The list of jobs.
+ { # Represents a training or prediction job.
+ "trainingOutput": { # Represents results of a training job. # The current training job result.
+ "completedTrialCount": "A String", # The number of hyperparameter tuning trials that completed successfully.
+ "trials": [ # Results for individual Hyperparameter trials.
+ { # Represents the result of a single hyperparameter tuning trial from a
+ # training job. The TrainingOutput object that is returned on successful
+ # completion of a training job with hyperparameter tuning includes a list
+ # of HyperparameterOutput objects, one for each successful trial.
+ "hyperparameters": { # The hyperparameters given to this trial.
+ "a_key": "A String",
+ },
+ "trialId": "A String", # The trial id for these results.
+ "allMetrics": [ # All recorded object metrics for this trial.
+ { # An observed value of a metric.
+ "trainingStep": "A String", # The global training step for this metric.
+ "objectiveValue": 3.14, # The objective value at this training step.
+ },
+ ],
+ "finalMetric": { # An observed value of a metric. # The final objective metric seen for this trial.
+ "trainingStep": "A String", # The global training step for this metric.
+ "objectiveValue": 3.14, # The objective value at this training step.
+ },
+ },
+ ],
+ },
+ "startTime": "A String", # Output only. When the job processing was started.
+ "errorMessage": "A String", # Output only. The details of a failure or a cancellation.
+ "jobId": "A String", # Required. The user-specified id of the job.
+ "state": "A String", # Output only. The detailed state of a job.
+ "predictionInput": { # Represents input parameters for a prediction job. # Input parameters to create a prediction job.
+ "modelName": "A String", # Use this field if you want to use the default version for the specified
+ # model. The string must use the following format:
+ #
+ # `"project/<var>[YOUR_PROJECT]</var>/models/<var>[YOUR_MODEL]</var>"`
+ "inputPaths": [ # Required. The Google Cloud Storage location of the input data files.
+ # May contain wildcards.
+ "A String",
+ ],
+ "maxWorkerCount": "A String", # Optional. The maximum amount of workers to be used for parallel processing.
+ # Defaults to 10.
+ "outputPath": "A String", # Required. The output Google Cloud Storage location.
+ "dataFormat": "A String", # Required. The format of the input data files.
+ "versionName": "A String", # Use this field if you want to specify a version of the model to use. The
+ # string is formatted the same way as `model_version`, with the addition
+ # of the version information:
+ #
+ # `"project/<var>[YOUR_PROJECT]</var>/models/<var>YOUR_MODEL/versions/<var>[YOUR_VERSION]</var>"`
+ "region": "A String", # Required. The Google Compute Engine region to run the prediction job in.
+ },
+ "trainingInput": { # Represents input parameters for a training job. # Input parameters to create a training job.
+ "workerType": "A String", # Optional. Specifies the type of virtual machine to use for your training
+ # job's worker nodes.
+ #
+ # The supported values are the same as those described in the entry for
+ # `masterType`.
+ #
+ # This value must be present when `scaleTier` is set to `CUSTOM` and
+ # `workerCount` is greater than zero.
+ "scaleTier": "A String", # Required. Specifies the machine types, the number of replicas for workers
+ # and parameter servers.
+ "masterType": "A String", # Optional. Specifies the type of virtual machine to use for your training
+ # job's master worker.
+ #
+ # The following types are supported:
+ #
+ # <dl>
+ # <dt>standard</dt>
+ # <dd>
+ # A basic machine configuration suitable for training simple models with
+ # small to moderate datasets.
+ # </dd>
+ # <dt>large_model</dt>
+ # <dd>
+ # A machine with a lot of memory, specially suited for parameter servers
+ # when your model is large (having many hidden layers or layers with very
+ # large numbers of nodes).
+ # </dd>
+ # <dt>complex_model_s</dt>
+ # <dd>
+ # A machine suitable for the master and workers of the cluster when your
+ # model requires more computation than the standard machine can handle
+ # satisfactorily.
+ # </dd>
+ # <dt>complex_model_m</dt>
+ # <dd>
+ # A machine with roughly twice the number of cores and roughly double the
+ # memory of <code suppresswarning="true">complex_model_s</code>.
+ # </dd>
+ # <dt>complex_model_l</dt>
+ # <dd>
+ # A machine with roughly twice the number of cores and roughly double the
+ # memory of <code suppresswarning="true">complex_model_m</code>.
+ # </dd>
+ # </dl>
+ #
+ # You must set this value when `scaleTier` is set to `CUSTOM`.
+ "hyperparameters": { # Represents a set of hyperparameters to optimize. # Optional. The set of Hyperparameters to tune.
+ "maxTrials": 42, # Optional. How many training trials should be attempted to optimize
+ # the specified hyperparameters.
+ #
+ # Defaults to one.
+ "params": [ # Required. The set of parameters to tune.
+ { # Represents a single hyperparameter to optimize.
+ "maxValue": 3.14, # Required if typeis `DOUBLE` or `INTEGER`. This field
+ # should be unset if type is `CATEGORICAL`. This value should be integers if
+ # type is `INTEGER`.
+ "minValue": 3.14, # Required if type is `DOUBLE` or `INTEGER`. This field
+ # should be unset if type is `CATEGORICAL`. This value should be integers if
+ # type is INTEGER.
+ "discreteValues": [ # Required if type is `DISCRETE`.
+ # A list of feasible points.
+ # The list should be in strictly increasing order. For instance, this
+ # parameter might have possible settings of 1.5, 2.5, and 4.0. This list
+ # should not contain more than 1,000 values.
+ 3.14,
+ ],
+ "parameterName": "A String", # Required. The parameter name must be unique amongst all ParameterConfigs in
+ # a HyperparameterSpec message. E.g., "learning_rate".
+ "categoricalValues": [ # Required if type is `CATEGORICAL`. The list of possible categories.
+ "A String",
+ ],
+ "type": "A String", # Required. The type of the parameter.
+ "scaleType": "A String", # Optional. How the parameter should be scaled to the hypercube.
+ # Leave unset for categorical parameters.
+ # Some kind of scaling is strongly recommended for real or integral
+ # parameters (e.g., `UNIT_LINEAR_SCALE`).
+ },
+ ],
+ "maxParallelTrials": 42, # Optional. The number of training trials to run concurrently.
+ # You can reduce the time it takes to perform hyperparameter tuning by adding
+ # trials in parallel. However, each trail only benefits from the information
+ # gained in completed trials. That means that a trial does not get access to
+ # the results of trials running at the same time, which could reduce the
+ # quality of the overall optimization.
+ #
+ # Each trial will use the same scale tier and machine types.
+ #
+ # Defaults to one.
+ "goal": "A String", # Required. The type of goal to use for tuning. Available types are
+ # `MAXIMIZE` and `MINIMIZE`.
+ #
+ # Defaults to `MAXIMIZE`.
+ },
+ "region": "A String", # Required. The Google Compute Engine region to run the training job in.
+ "args": [ # Optional. Command line arguments to pass to the program.
+ "A String",
+ ],
+ "pythonModule": "A String", # Required. The Python module name to run after installing the packages.
+ "packageUris": [ # Required. The Google Cloud Storage location of the packages with
+ # the training program and any additional dependencies.
+ "A String",
+ ],
+ "workerCount": "A String", # Optional. The number of worker replicas to use for the training job. Each
+ # replica in the cluster will be of the type specified in `worker_type`.
+ #
+ # This value can only be used when `scale_tier` is set to `CUSTOM`. If you
+ # set this value, you must also set `worker_type`.
+ "parameterServerType": "A String", # Optional. Specifies the type of virtual machine to use for your training
+ # job's parameter server.
+ #
+ # The supported values are the same as those described in the entry for
+ # `master_type`.
+ #
+ # This value must be present when `scaleTier` is set to `CUSTOM` and
+ # `parameter_server_count` is greater than zero.
+ "parameterServerCount": "A String", # Optional. The number of parameter server replicas to use for the training
+ # job. Each replica in the cluster will be of the type specified in
+ # `parameter_server_type`.
+ #
+ # This value can only be used when `scale_tier` is set to `CUSTOM`.If you
+ # set this value, you must also set `parameter_server_type`.
+ },
+ "endTime": "A String", # Output only. When the job processing was completed.
+ "predictionOutput": { # Represents results of a prediction job. # The current prediction job result.
+ "outputPath": "A String", # The output Google Cloud Storage location provided at the job creation time.
+ "predictionCount": "A String", # The number of generated predictions.
+ "errorCount": "A String", # The number of data instances which resulted in errors.
+ },
+ "createTime": "A String", # Output only. When the job was created.
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
+ <pre>Retrieves the next page of results.
+
+Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+Returns:
+ A request object that you can call 'execute()' on to request the next
+ page. Returns None if there are no more items in the collection.
+ </pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/ml_v1beta1.projects.models.html b/docs/dyn/ml_v1beta1.projects.models.html
new file mode 100644
index 0000000..088032f
--- /dev/null
+++ b/docs/dyn/ml_v1beta1.projects.models.html
@@ -0,0 +1,472 @@
+<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="ml_v1beta1.html">Google Cloud Machine Learning</a> . <a href="ml_v1beta1.projects.html">projects</a> . <a href="ml_v1beta1.projects.models.html">models</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="ml_v1beta1.projects.models.versions.html">versions()</a></code>
+</p>
+<p class="firstline">Returns the versions Resource.</p>
+
+<p class="toc_element">
+ <code><a href="#create">create(parent=None, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Creates a model which will later contain one or more versions.</p>
+<p class="toc_element">
+ <code><a href="#delete">delete(name=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Deletes a model.</p>
+<p class="toc_element">
+ <code><a href="#get">get(name=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Gets information about a model, including its name, the description (if</p>
+<p class="toc_element">
+ <code><a href="#list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
+<p class="firstline">Lists the models in a project.</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>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="create">create(parent=None, body, x__xgafv=None)</code>
+ <pre>Creates a model which will later contain one or more versions.
+
+You must add at least one version before you can request predictions from
+the model. Add versions by calling
+[projects.models.versions.create](/ml/reference/rest/v1beta1/projects.models.versions/create).
+
+Args:
+ parent: string, Required. The project name.
+
+Authorization: requires `Editor` role on the specified project. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Represents a machine learning solution.
+ #
+ # A model can have multiple versions, each of which is a deployed, trained
+ # model ready to receive prediction requests. The model itself is just a
+ # container.
+ "defaultVersion": { # Represents a version of the model. # Output only. The default version of the model. This version will be used to
+ # handle prediction requests that do not specify a version.
+ #
+ # You can change the default version by calling
+ # [projects.methods.versions.setDefault](/ml/reference/rest/v1beta1/projects.models.versions/setDefault).
+ #
+ # Each version is a trained model deployed in the cloud, ready to handle
+ # prediction requests. A model can have multiple versions. You can get
+ # information about all of the versions of a given model by calling
+ # [projects.models.versions.list](/ml/reference/rest/v1beta1/projects.models.versions/list).
+ "description": "A String", # Optional. The description specified for the version when it was created.
+ "lastUseTime": "A String", # Output only. The time the version was last used for prediction.
+ "deploymentUri": "A String", # Required. The Google Cloud Storage location of the trained model used to
+ # create the version. See the
+ # [overview of model deployment](/ml/docs/concepts/deployment-overview) for
+ # more informaiton.
+ #
+ # When passing Version to
+ # [projects.models.versions.create](/ml/reference/rest/v1beta1/projects.models.versions/create)
+ # the model service uses the specified location as the source of the model.
+ # Once deployed, the model version is hosted by the prediction service, so
+ # this location is useful only as a historical record.
+ "createTime": "A String", # Output only. The time the version was created.
+ "isDefault": True or False, # Output only. If true, this version will be used to handle prediction
+ # requests that do not specify a version.
+ #
+ # You can change the default version by calling
+ # [projects.methods.versions.setDefault](/ml/reference/rest/v1beta1/projects.models.versions/setDefault).
+ "name": "A String", # Required.The name specified for the version when it was created.
+ #
+ # The version name must be unique within the model it is created in.
+ },
+ "description": "A String", # Optional. The description specified for the model when it was created.
+ "name": "A String", # Required. The name specified for the model when it was created.
+ #
+ # The model name must be unique within the project it is created in.
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a machine learning solution.
+ #
+ # A model can have multiple versions, each of which is a deployed, trained
+ # model ready to receive prediction requests. The model itself is just a
+ # container.
+ "defaultVersion": { # Represents a version of the model. # Output only. The default version of the model. This version will be used to
+ # handle prediction requests that do not specify a version.
+ #
+ # You can change the default version by calling
+ # [projects.methods.versions.setDefault](/ml/reference/rest/v1beta1/projects.models.versions/setDefault).
+ #
+ # Each version is a trained model deployed in the cloud, ready to handle
+ # prediction requests. A model can have multiple versions. You can get
+ # information about all of the versions of a given model by calling
+ # [projects.models.versions.list](/ml/reference/rest/v1beta1/projects.models.versions/list).
+ "description": "A String", # Optional. The description specified for the version when it was created.
+ "lastUseTime": "A String", # Output only. The time the version was last used for prediction.
+ "deploymentUri": "A String", # Required. The Google Cloud Storage location of the trained model used to
+ # create the version. See the
+ # [overview of model deployment](/ml/docs/concepts/deployment-overview) for
+ # more informaiton.
+ #
+ # When passing Version to
+ # [projects.models.versions.create](/ml/reference/rest/v1beta1/projects.models.versions/create)
+ # the model service uses the specified location as the source of the model.
+ # Once deployed, the model version is hosted by the prediction service, so
+ # this location is useful only as a historical record.
+ "createTime": "A String", # Output only. The time the version was created.
+ "isDefault": True or False, # Output only. If true, this version will be used to handle prediction
+ # requests that do not specify a version.
+ #
+ # You can change the default version by calling
+ # [projects.methods.versions.setDefault](/ml/reference/rest/v1beta1/projects.models.versions/setDefault).
+ "name": "A String", # Required.The name specified for the version when it was created.
+ #
+ # The version name must be unique within the model it is created in.
+ },
+ "description": "A String", # Optional. The description specified for the model when it was created.
+ "name": "A String", # Required. The name specified for the model when it was created.
+ #
+ # The model name must be unique within the project it is created in.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="delete">delete(name=None, x__xgafv=None)</code>
+ <pre>Deletes a model.
+
+You can only delete a model if there are no versions in it. You can delete
+versions by calling
+[projects.models.versions.delete](/ml/reference/rest/v1beta1/projects.models.versions/delete).
+
+Args:
+ name: string, Required. The name of the model.
+
+Authorization: requires `Editor` role on the parent project. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a
+ # network API call.
+ "metadata": { # Service-specific metadata associated with the operation. It typically
+ # contains progress information and common metadata such as create time.
+ # Some services might not provide such metadata. Any method that returns a
+ # long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "done": True or False, # If the value is `false`, it means the operation is still in progress.
+ # If true, the operation is completed, and either `error` or `response` is
+ # available.
+ "response": { # The normal response of the operation in case of success. If the original
+ # method returns no data on success, such as `Delete`, the response is
+ # `google.protobuf.Empty`. If the original method is standard
+ # `Get`/`Create`/`Update`, the response should be the resource. For other
+ # methods, the response should have the type `XxxResponse`, where `Xxx`
+ # is the original method name. For example, if the original method name
+ # is `TakeSnapshot()`, the inferred response type is
+ # `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that
+ # originally returns it. If you use the default HTTP mapping, the
+ # `name` should have the format of `operations/some/unique/name`.
+ "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure.
+ # programming environments, including REST APIs and RPC APIs. It is used by
+ # [gRPC](https://github.com/grpc). The error model is designed to be:
+ #
+ # - Simple to use and understand for most users
+ # - Flexible enough to meet unexpected needs
+ #
+ # # Overview
+ #
+ # The `Status` message contains three pieces of data: error code, error message,
+ # and error details. The error code should be an enum value of
+ # google.rpc.Code, but it may accept additional error codes if needed. The
+ # error message should be a developer-facing English message that helps
+ # developers *understand* and *resolve* the error. If a localized user-facing
+ # error message is needed, put the localized message in the error details or
+ # localize it in the client. The optional error details may contain arbitrary
+ # information about the error. There is a predefined set of error detail types
+ # in the package `google.rpc` which can be used for common error conditions.
+ #
+ # # Language mapping
+ #
+ # The `Status` message is the logical representation of the error model, but it
+ # is not necessarily the actual wire format. When the `Status` message is
+ # exposed in different client libraries and different wire protocols, it can be
+ # mapped differently. For example, it will likely be mapped to some exceptions
+ # in Java, but more likely mapped to some error codes in C.
+ #
+ # # Other uses
+ #
+ # The error model and the `Status` message can be used in a variety of
+ # environments, either with or without APIs, to provide a
+ # consistent developer experience across different environments.
+ #
+ # Example uses of this error model include:
+ #
+ # - Partial errors. If a service needs to return partial errors to the client,
+ # it may embed the `Status` in the normal response to indicate the partial
+ # errors.
+ #
+ # - Workflow errors. A typical workflow has multiple steps. Each step may
+ # have a `Status` message for error reporting purpose.
+ #
+ # - Batch operations. If a client uses batch request and batch response, the
+ # `Status` message should be used directly inside batch response, one for
+ # each error sub-response.
+ #
+ # - Asynchronous operations. If an API call embeds asynchronous operation
+ # results in its response, the status of those operations should be
+ # represented directly using the `Status` message.
+ #
+ # - Logging. If some API errors are stored in logs, the message `Status` could
+ # be used directly after any stripping needed for security/privacy reasons.
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There will be a
+ # common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(name=None, x__xgafv=None)</code>
+ <pre>Gets information about a model, including its name, the description (if
+set), and the default version (if at least one version of the model has
+been deployed).
+
+Args:
+ name: string, Required. The name of the model.
+
+Authorization: requires `Viewer` role on the parent project. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a machine learning solution.
+ #
+ # A model can have multiple versions, each of which is a deployed, trained
+ # model ready to receive prediction requests. The model itself is just a
+ # container.
+ "defaultVersion": { # Represents a version of the model. # Output only. The default version of the model. This version will be used to
+ # handle prediction requests that do not specify a version.
+ #
+ # You can change the default version by calling
+ # [projects.methods.versions.setDefault](/ml/reference/rest/v1beta1/projects.models.versions/setDefault).
+ #
+ # Each version is a trained model deployed in the cloud, ready to handle
+ # prediction requests. A model can have multiple versions. You can get
+ # information about all of the versions of a given model by calling
+ # [projects.models.versions.list](/ml/reference/rest/v1beta1/projects.models.versions/list).
+ "description": "A String", # Optional. The description specified for the version when it was created.
+ "lastUseTime": "A String", # Output only. The time the version was last used for prediction.
+ "deploymentUri": "A String", # Required. The Google Cloud Storage location of the trained model used to
+ # create the version. See the
+ # [overview of model deployment](/ml/docs/concepts/deployment-overview) for
+ # more informaiton.
+ #
+ # When passing Version to
+ # [projects.models.versions.create](/ml/reference/rest/v1beta1/projects.models.versions/create)
+ # the model service uses the specified location as the source of the model.
+ # Once deployed, the model version is hosted by the prediction service, so
+ # this location is useful only as a historical record.
+ "createTime": "A String", # Output only. The time the version was created.
+ "isDefault": True or False, # Output only. If true, this version will be used to handle prediction
+ # requests that do not specify a version.
+ #
+ # You can change the default version by calling
+ # [projects.methods.versions.setDefault](/ml/reference/rest/v1beta1/projects.models.versions/setDefault).
+ "name": "A String", # Required.The name specified for the version when it was created.
+ #
+ # The version name must be unique within the model it is created in.
+ },
+ "description": "A String", # Optional. The description specified for the model when it was created.
+ "name": "A String", # Required. The name specified for the model when it was created.
+ #
+ # The model name must be unique within the project it is created in.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</code>
+ <pre>Lists the models in a project.
+
+Each project can contain multiple models, and each model can have multiple
+versions.
+
+Args:
+ parent: string, Required. The name of the project whose models are to be listed.
+
+Authorization: requires `Viewer` role on the specified project. (required)
+ pageToken: string, Optional. A page token to request the next page of results.
+
+You get the token from the `next_page_token` field of the response from
+the previous call.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+ pageSize: integer, Optional. The number of models to retrieve per "page" of results. If there
+are more remaining results than this number, the response message will
+contain a valid value in the `next_page_token` field.
+
+The default value is 20, and the maximum page size is 100.
+
+Returns:
+ An object of the form:
+
+ { # Response message for the ListModels method.
+ "models": [ # The list of models.
+ { # Represents a machine learning solution.
+ #
+ # A model can have multiple versions, each of which is a deployed, trained
+ # model ready to receive prediction requests. The model itself is just a
+ # container.
+ "defaultVersion": { # Represents a version of the model. # Output only. The default version of the model. This version will be used to
+ # handle prediction requests that do not specify a version.
+ #
+ # You can change the default version by calling
+ # [projects.methods.versions.setDefault](/ml/reference/rest/v1beta1/projects.models.versions/setDefault).
+ #
+ # Each version is a trained model deployed in the cloud, ready to handle
+ # prediction requests. A model can have multiple versions. You can get
+ # information about all of the versions of a given model by calling
+ # [projects.models.versions.list](/ml/reference/rest/v1beta1/projects.models.versions/list).
+ "description": "A String", # Optional. The description specified for the version when it was created.
+ "lastUseTime": "A String", # Output only. The time the version was last used for prediction.
+ "deploymentUri": "A String", # Required. The Google Cloud Storage location of the trained model used to
+ # create the version. See the
+ # [overview of model deployment](/ml/docs/concepts/deployment-overview) for
+ # more informaiton.
+ #
+ # When passing Version to
+ # [projects.models.versions.create](/ml/reference/rest/v1beta1/projects.models.versions/create)
+ # the model service uses the specified location as the source of the model.
+ # Once deployed, the model version is hosted by the prediction service, so
+ # this location is useful only as a historical record.
+ "createTime": "A String", # Output only. The time the version was created.
+ "isDefault": True or False, # Output only. If true, this version will be used to handle prediction
+ # requests that do not specify a version.
+ #
+ # You can change the default version by calling
+ # [projects.methods.versions.setDefault](/ml/reference/rest/v1beta1/projects.models.versions/setDefault).
+ "name": "A String", # Required.The name specified for the version when it was created.
+ #
+ # The version name must be unique within the model it is created in.
+ },
+ "description": "A String", # Optional. The description specified for the model when it was created.
+ "name": "A String", # Required. The name specified for the model when it was created.
+ #
+ # The model name must be unique within the project it is created in.
+ },
+ ],
+ "nextPageToken": "A String", # Optional. Pass this token as the `page_token` field of the request for a
+ # subsequent call.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
+ <pre>Retrieves the next page of results.
+
+Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+Returns:
+ A request object that you can call 'execute()' on to request the next
+ page. Returns None if there are no more items in the collection.
+ </pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/ml_v1beta1.projects.models.versions.html b/docs/dyn/ml_v1beta1.projects.models.versions.html
new file mode 100644
index 0000000..a28a565
--- /dev/null
+++ b/docs/dyn/ml_v1beta1.projects.models.versions.html
@@ -0,0 +1,546 @@
+<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="ml_v1beta1.html">Google Cloud Machine Learning</a> . <a href="ml_v1beta1.projects.html">projects</a> . <a href="ml_v1beta1.projects.models.html">models</a> . <a href="ml_v1beta1.projects.models.versions.html">versions</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#create">create(parent=None, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Creates a new version of a model from a trained TensorFlow model.</p>
+<p class="toc_element">
+ <code><a href="#delete">delete(name=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Deletes a model version.</p>
+<p class="toc_element">
+ <code><a href="#get">get(name=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Gets information about a model version.</p>
+<p class="toc_element">
+ <code><a href="#list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
+<p class="firstline">Gets basic information about all the versions of a model.</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>
+<p class="toc_element">
+ <code><a href="#setDefault">setDefault(name=None, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Designates a version to be the default for the model.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="create">create(parent=None, body, x__xgafv=None)</code>
+ <pre>Creates a new version of a model from a trained TensorFlow model.
+
+If the version created in the cloud by this call is the first deployed
+version of the specified model, it will be made the default version of the
+model. When you add a version to a model that already has one or more
+versions, the default version does not automatically change. If you want a
+new version to be the default, you must call
+[projects.models.versions.setDefault](/ml/reference/rest/v1beta1/projects.models.versions/setDefault).
+
+Args:
+ parent: string, Required. The name of the model.
+
+Authorization: requires `Editor` role on the parent project. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Represents a version of the model.
+ #
+ # Each version is a trained model deployed in the cloud, ready to handle
+ # prediction requests. A model can have multiple versions. You can get
+ # information about all of the versions of a given model by calling
+ # [projects.models.versions.list](/ml/reference/rest/v1beta1/projects.models.versions/list).
+ "description": "A String", # Optional. The description specified for the version when it was created.
+ "lastUseTime": "A String", # Output only. The time the version was last used for prediction.
+ "deploymentUri": "A String", # Required. The Google Cloud Storage location of the trained model used to
+ # create the version. See the
+ # [overview of model deployment](/ml/docs/concepts/deployment-overview) for
+ # more informaiton.
+ #
+ # When passing Version to
+ # [projects.models.versions.create](/ml/reference/rest/v1beta1/projects.models.versions/create)
+ # the model service uses the specified location as the source of the model.
+ # Once deployed, the model version is hosted by the prediction service, so
+ # this location is useful only as a historical record.
+ "createTime": "A String", # Output only. The time the version was created.
+ "isDefault": True or False, # Output only. If true, this version will be used to handle prediction
+ # requests that do not specify a version.
+ #
+ # You can change the default version by calling
+ # [projects.methods.versions.setDefault](/ml/reference/rest/v1beta1/projects.models.versions/setDefault).
+ "name": "A String", # Required.The name specified for the version when it was created.
+ #
+ # The version name must be unique within the model it is created in.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a
+ # network API call.
+ "metadata": { # Service-specific metadata associated with the operation. It typically
+ # contains progress information and common metadata such as create time.
+ # Some services might not provide such metadata. Any method that returns a
+ # long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "done": True or False, # If the value is `false`, it means the operation is still in progress.
+ # If true, the operation is completed, and either `error` or `response` is
+ # available.
+ "response": { # The normal response of the operation in case of success. If the original
+ # method returns no data on success, such as `Delete`, the response is
+ # `google.protobuf.Empty`. If the original method is standard
+ # `Get`/`Create`/`Update`, the response should be the resource. For other
+ # methods, the response should have the type `XxxResponse`, where `Xxx`
+ # is the original method name. For example, if the original method name
+ # is `TakeSnapshot()`, the inferred response type is
+ # `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that
+ # originally returns it. If you use the default HTTP mapping, the
+ # `name` should have the format of `operations/some/unique/name`.
+ "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure.
+ # programming environments, including REST APIs and RPC APIs. It is used by
+ # [gRPC](https://github.com/grpc). The error model is designed to be:
+ #
+ # - Simple to use and understand for most users
+ # - Flexible enough to meet unexpected needs
+ #
+ # # Overview
+ #
+ # The `Status` message contains three pieces of data: error code, error message,
+ # and error details. The error code should be an enum value of
+ # google.rpc.Code, but it may accept additional error codes if needed. The
+ # error message should be a developer-facing English message that helps
+ # developers *understand* and *resolve* the error. If a localized user-facing
+ # error message is needed, put the localized message in the error details or
+ # localize it in the client. The optional error details may contain arbitrary
+ # information about the error. There is a predefined set of error detail types
+ # in the package `google.rpc` which can be used for common error conditions.
+ #
+ # # Language mapping
+ #
+ # The `Status` message is the logical representation of the error model, but it
+ # is not necessarily the actual wire format. When the `Status` message is
+ # exposed in different client libraries and different wire protocols, it can be
+ # mapped differently. For example, it will likely be mapped to some exceptions
+ # in Java, but more likely mapped to some error codes in C.
+ #
+ # # Other uses
+ #
+ # The error model and the `Status` message can be used in a variety of
+ # environments, either with or without APIs, to provide a
+ # consistent developer experience across different environments.
+ #
+ # Example uses of this error model include:
+ #
+ # - Partial errors. If a service needs to return partial errors to the client,
+ # it may embed the `Status` in the normal response to indicate the partial
+ # errors.
+ #
+ # - Workflow errors. A typical workflow has multiple steps. Each step may
+ # have a `Status` message for error reporting purpose.
+ #
+ # - Batch operations. If a client uses batch request and batch response, the
+ # `Status` message should be used directly inside batch response, one for
+ # each error sub-response.
+ #
+ # - Asynchronous operations. If an API call embeds asynchronous operation
+ # results in its response, the status of those operations should be
+ # represented directly using the `Status` message.
+ #
+ # - Logging. If some API errors are stored in logs, the message `Status` could
+ # be used directly after any stripping needed for security/privacy reasons.
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There will be a
+ # common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="delete">delete(name=None, x__xgafv=None)</code>
+ <pre>Deletes a model version.
+
+Each model can have multiple versions deployed and in use at any given
+time. Use this method to remove a single version.
+
+Note: You cannot delete the version that is set as the default version
+of the model unless it is the only remaining version.
+
+Args:
+ name: string, Required. The name of the version. You can get the names of all the
+versions of a model by calling
+[projects.models.versions.list](/ml/reference/rest/v1beta1/projects.models.versions/list).
+
+Authorization: requires `Editor` role on the parent project. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a
+ # network API call.
+ "metadata": { # Service-specific metadata associated with the operation. It typically
+ # contains progress information and common metadata such as create time.
+ # Some services might not provide such metadata. Any method that returns a
+ # long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "done": True or False, # If the value is `false`, it means the operation is still in progress.
+ # If true, the operation is completed, and either `error` or `response` is
+ # available.
+ "response": { # The normal response of the operation in case of success. If the original
+ # method returns no data on success, such as `Delete`, the response is
+ # `google.protobuf.Empty`. If the original method is standard
+ # `Get`/`Create`/`Update`, the response should be the resource. For other
+ # methods, the response should have the type `XxxResponse`, where `Xxx`
+ # is the original method name. For example, if the original method name
+ # is `TakeSnapshot()`, the inferred response type is
+ # `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that
+ # originally returns it. If you use the default HTTP mapping, the
+ # `name` should have the format of `operations/some/unique/name`.
+ "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure.
+ # programming environments, including REST APIs and RPC APIs. It is used by
+ # [gRPC](https://github.com/grpc). The error model is designed to be:
+ #
+ # - Simple to use and understand for most users
+ # - Flexible enough to meet unexpected needs
+ #
+ # # Overview
+ #
+ # The `Status` message contains three pieces of data: error code, error message,
+ # and error details. The error code should be an enum value of
+ # google.rpc.Code, but it may accept additional error codes if needed. The
+ # error message should be a developer-facing English message that helps
+ # developers *understand* and *resolve* the error. If a localized user-facing
+ # error message is needed, put the localized message in the error details or
+ # localize it in the client. The optional error details may contain arbitrary
+ # information about the error. There is a predefined set of error detail types
+ # in the package `google.rpc` which can be used for common error conditions.
+ #
+ # # Language mapping
+ #
+ # The `Status` message is the logical representation of the error model, but it
+ # is not necessarily the actual wire format. When the `Status` message is
+ # exposed in different client libraries and different wire protocols, it can be
+ # mapped differently. For example, it will likely be mapped to some exceptions
+ # in Java, but more likely mapped to some error codes in C.
+ #
+ # # Other uses
+ #
+ # The error model and the `Status` message can be used in a variety of
+ # environments, either with or without APIs, to provide a
+ # consistent developer experience across different environments.
+ #
+ # Example uses of this error model include:
+ #
+ # - Partial errors. If a service needs to return partial errors to the client,
+ # it may embed the `Status` in the normal response to indicate the partial
+ # errors.
+ #
+ # - Workflow errors. A typical workflow has multiple steps. Each step may
+ # have a `Status` message for error reporting purpose.
+ #
+ # - Batch operations. If a client uses batch request and batch response, the
+ # `Status` message should be used directly inside batch response, one for
+ # each error sub-response.
+ #
+ # - Asynchronous operations. If an API call embeds asynchronous operation
+ # results in its response, the status of those operations should be
+ # represented directly using the `Status` message.
+ #
+ # - Logging. If some API errors are stored in logs, the message `Status` could
+ # be used directly after any stripping needed for security/privacy reasons.
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There will be a
+ # common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(name=None, x__xgafv=None)</code>
+ <pre>Gets information about a model version.
+
+Models can have multiple versions. You can call
+[projects.models.versions.list](/ml/reference/rest/v1beta1/projects.models.versions/list)
+to get the same information that this method returns for all of the
+versions of a model.
+
+Args:
+ name: string, Required. The name of the version.
+
+Authorization: requires `Viewer` role on the parent project. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a version of the model.
+ #
+ # Each version is a trained model deployed in the cloud, ready to handle
+ # prediction requests. A model can have multiple versions. You can get
+ # information about all of the versions of a given model by calling
+ # [projects.models.versions.list](/ml/reference/rest/v1beta1/projects.models.versions/list).
+ "description": "A String", # Optional. The description specified for the version when it was created.
+ "lastUseTime": "A String", # Output only. The time the version was last used for prediction.
+ "deploymentUri": "A String", # Required. The Google Cloud Storage location of the trained model used to
+ # create the version. See the
+ # [overview of model deployment](/ml/docs/concepts/deployment-overview) for
+ # more informaiton.
+ #
+ # When passing Version to
+ # [projects.models.versions.create](/ml/reference/rest/v1beta1/projects.models.versions/create)
+ # the model service uses the specified location as the source of the model.
+ # Once deployed, the model version is hosted by the prediction service, so
+ # this location is useful only as a historical record.
+ "createTime": "A String", # Output only. The time the version was created.
+ "isDefault": True or False, # Output only. If true, this version will be used to handle prediction
+ # requests that do not specify a version.
+ #
+ # You can change the default version by calling
+ # [projects.methods.versions.setDefault](/ml/reference/rest/v1beta1/projects.models.versions/setDefault).
+ "name": "A String", # Required.The name specified for the version when it was created.
+ #
+ # The version name must be unique within the model it is created in.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</code>
+ <pre>Gets basic information about all the versions of a model.
+
+If you expect that a model has a lot of versions, or if you need to handle
+only a limited number of results at a time, you can request that the list
+be retrieved in batches (called pages):
+
+Args:
+ parent: string, Required. The name of the model for which to list the version.
+
+Authorization: requires `Viewer` role on the parent project. (required)
+ pageToken: string, Optional. A page token to request the next page of results.
+
+You get the token from the `next_page_token` field of the response from
+the previous call.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+ pageSize: integer, Optional. The number of versions to retrieve per "page" of results. If
+there are more remaining results than this number, the response message
+will contain a valid value in the `next_page_token` field.
+
+The default value is 20, and the maximum page size is 100.
+
+Returns:
+ An object of the form:
+
+ { # Response message for the ListVersions method.
+ "nextPageToken": "A String", # Optional. Pass this token as the `page_token` field of the request for a
+ # subsequent call.
+ "versions": [ # The list of versions.
+ { # Represents a version of the model.
+ #
+ # Each version is a trained model deployed in the cloud, ready to handle
+ # prediction requests. A model can have multiple versions. You can get
+ # information about all of the versions of a given model by calling
+ # [projects.models.versions.list](/ml/reference/rest/v1beta1/projects.models.versions/list).
+ "description": "A String", # Optional. The description specified for the version when it was created.
+ "lastUseTime": "A String", # Output only. The time the version was last used for prediction.
+ "deploymentUri": "A String", # Required. The Google Cloud Storage location of the trained model used to
+ # create the version. See the
+ # [overview of model deployment](/ml/docs/concepts/deployment-overview) for
+ # more informaiton.
+ #
+ # When passing Version to
+ # [projects.models.versions.create](/ml/reference/rest/v1beta1/projects.models.versions/create)
+ # the model service uses the specified location as the source of the model.
+ # Once deployed, the model version is hosted by the prediction service, so
+ # this location is useful only as a historical record.
+ "createTime": "A String", # Output only. The time the version was created.
+ "isDefault": True or False, # Output only. If true, this version will be used to handle prediction
+ # requests that do not specify a version.
+ #
+ # You can change the default version by calling
+ # [projects.methods.versions.setDefault](/ml/reference/rest/v1beta1/projects.models.versions/setDefault).
+ "name": "A String", # Required.The name specified for the version when it was created.
+ #
+ # The version name must be unique within the model it is created in.
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
+ <pre>Retrieves the next page of results.
+
+Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+Returns:
+ A request object that you can call 'execute()' on to request the next
+ page. Returns None if there are no more items in the collection.
+ </pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setDefault">setDefault(name=None, body, x__xgafv=None)</code>
+ <pre>Designates a version to be the default for the model.
+
+The default version is used for prediction requests made against the model
+that don't specify a version.
+
+The first version to be created for a model is automatically set as the
+default. You must make any subsequent changes to the default version
+setting manually using this method.
+
+Args:
+ name: string, Required. The name of the version to make the default for the model. You
+can get the names of all the versions of a model by calling
+[projects.models.versions.list](/ml/reference/rest/v1beta1/projects.models.versions/list).
+
+Authorization: requires `Editor` role on the parent project. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Request message for the SetDefaultVersion request.
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a version of the model.
+ #
+ # Each version is a trained model deployed in the cloud, ready to handle
+ # prediction requests. A model can have multiple versions. You can get
+ # information about all of the versions of a given model by calling
+ # [projects.models.versions.list](/ml/reference/rest/v1beta1/projects.models.versions/list).
+ "description": "A String", # Optional. The description specified for the version when it was created.
+ "lastUseTime": "A String", # Output only. The time the version was last used for prediction.
+ "deploymentUri": "A String", # Required. The Google Cloud Storage location of the trained model used to
+ # create the version. See the
+ # [overview of model deployment](/ml/docs/concepts/deployment-overview) for
+ # more informaiton.
+ #
+ # When passing Version to
+ # [projects.models.versions.create](/ml/reference/rest/v1beta1/projects.models.versions/create)
+ # the model service uses the specified location as the source of the model.
+ # Once deployed, the model version is hosted by the prediction service, so
+ # this location is useful only as a historical record.
+ "createTime": "A String", # Output only. The time the version was created.
+ "isDefault": True or False, # Output only. If true, this version will be used to handle prediction
+ # requests that do not specify a version.
+ #
+ # You can change the default version by calling
+ # [projects.methods.versions.setDefault](/ml/reference/rest/v1beta1/projects.models.versions/setDefault).
+ "name": "A String", # Required.The name specified for the version when it was created.
+ #
+ # The version name must be unique within the model it is created in.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/ml_v1beta1.projects.operations.html b/docs/dyn/ml_v1beta1.projects.operations.html
new file mode 100644
index 0000000..5c094a6
--- /dev/null
+++ b/docs/dyn/ml_v1beta1.projects.operations.html
@@ -0,0 +1,390 @@
+<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="ml_v1beta1.html">Google Cloud Machine Learning</a> . <a href="ml_v1beta1.projects.html">projects</a> . <a href="ml_v1beta1.projects.operations.html">operations</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#cancel">cancel(name, x__xgafv=None)</a></code></p>
+<p class="firstline">Starts asynchronous cancellation on a long-running operation. The server</p>
+<p class="toc_element">
+ <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
+<p class="firstline">Deletes a long-running operation. This method indicates that the client is</p>
+<p class="toc_element">
+ <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
+<p class="firstline">Gets the latest state of a long-running operation. Clients can use this</p>
+<p class="toc_element">
+ <code><a href="#list">list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Lists operations that match the specified filter in the request. If the</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>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="cancel">cancel(name, x__xgafv=None)</code>
+ <pre>Starts asynchronous cancellation on a long-running operation. The server
+makes a best effort to cancel the operation, but success is not
+guaranteed. If the server doesn't support this method, it returns
+`google.rpc.Code.UNIMPLEMENTED`. Clients can use
+Operations.GetOperation or
+other methods to check whether the cancellation succeeded or whether the
+operation completed despite cancellation.
+
+Args:
+ name: string, The name of the operation resource to be cancelled. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated
+ # empty messages in your APIs. A typical example is to use it as the request
+ # or the response type of an API method. For instance:
+ #
+ # service Foo {
+ # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
+ # }
+ #
+ # The JSON representation for `Empty` is empty JSON object `{}`.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="delete">delete(name, x__xgafv=None)</code>
+ <pre>Deletes a long-running operation. This method indicates that the client is
+no longer interested in the operation result. It does not cancel the
+operation. If the server doesn't support this method, it returns
+`google.rpc.Code.UNIMPLEMENTED`.
+
+Args:
+ name: string, The name of the operation resource to be deleted. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated
+ # empty messages in your APIs. A typical example is to use it as the request
+ # or the response type of an API method. For instance:
+ #
+ # service Foo {
+ # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
+ # }
+ #
+ # The JSON representation for `Empty` is empty JSON object `{}`.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(name, x__xgafv=None)</code>
+ <pre>Gets the latest state of a long-running operation. Clients can use this
+method to poll the operation result at intervals as recommended by the API
+service.
+
+Args:
+ name: string, The name of the operation resource. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a
+ # network API call.
+ "metadata": { # Service-specific metadata associated with the operation. It typically
+ # contains progress information and common metadata such as create time.
+ # Some services might not provide such metadata. Any method that returns a
+ # long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "done": True or False, # If the value is `false`, it means the operation is still in progress.
+ # If true, the operation is completed, and either `error` or `response` is
+ # available.
+ "response": { # The normal response of the operation in case of success. If the original
+ # method returns no data on success, such as `Delete`, the response is
+ # `google.protobuf.Empty`. If the original method is standard
+ # `Get`/`Create`/`Update`, the response should be the resource. For other
+ # methods, the response should have the type `XxxResponse`, where `Xxx`
+ # is the original method name. For example, if the original method name
+ # is `TakeSnapshot()`, the inferred response type is
+ # `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that
+ # originally returns it. If you use the default HTTP mapping, the
+ # `name` should have the format of `operations/some/unique/name`.
+ "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure.
+ # programming environments, including REST APIs and RPC APIs. It is used by
+ # [gRPC](https://github.com/grpc). The error model is designed to be:
+ #
+ # - Simple to use and understand for most users
+ # - Flexible enough to meet unexpected needs
+ #
+ # # Overview
+ #
+ # The `Status` message contains three pieces of data: error code, error message,
+ # and error details. The error code should be an enum value of
+ # google.rpc.Code, but it may accept additional error codes if needed. The
+ # error message should be a developer-facing English message that helps
+ # developers *understand* and *resolve* the error. If a localized user-facing
+ # error message is needed, put the localized message in the error details or
+ # localize it in the client. The optional error details may contain arbitrary
+ # information about the error. There is a predefined set of error detail types
+ # in the package `google.rpc` which can be used for common error conditions.
+ #
+ # # Language mapping
+ #
+ # The `Status` message is the logical representation of the error model, but it
+ # is not necessarily the actual wire format. When the `Status` message is
+ # exposed in different client libraries and different wire protocols, it can be
+ # mapped differently. For example, it will likely be mapped to some exceptions
+ # in Java, but more likely mapped to some error codes in C.
+ #
+ # # Other uses
+ #
+ # The error model and the `Status` message can be used in a variety of
+ # environments, either with or without APIs, to provide a
+ # consistent developer experience across different environments.
+ #
+ # Example uses of this error model include:
+ #
+ # - Partial errors. If a service needs to return partial errors to the client,
+ # it may embed the `Status` in the normal response to indicate the partial
+ # errors.
+ #
+ # - Workflow errors. A typical workflow has multiple steps. Each step may
+ # have a `Status` message for error reporting purpose.
+ #
+ # - Batch operations. If a client uses batch request and batch response, the
+ # `Status` message should be used directly inside batch response, one for
+ # each error sub-response.
+ #
+ # - Asynchronous operations. If an API call embeds asynchronous operation
+ # results in its response, the status of those operations should be
+ # represented directly using the `Status` message.
+ #
+ # - Logging. If some API errors are stored in logs, the message `Status` could
+ # be used directly after any stripping needed for security/privacy reasons.
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There will be a
+ # common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
+ <pre>Lists operations that match the specified filter in the request. If the
+server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+NOTE: the `name` binding below allows API services to override the binding
+to use different resource name schemes, such as `users/*/operations`.
+
+Args:
+ name: string, The name of the operation collection. (required)
+ pageSize: integer, The standard list page size.
+ filter: string, The standard list filter.
+ pageToken: string, The standard list page token.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The response message for Operations.ListOperations.
+ "nextPageToken": "A String", # The standard List next-page token.
+ "operations": [ # A list of operations that matches the specified filter in the request.
+ { # This resource represents a long-running operation that is the result of a
+ # network API call.
+ "metadata": { # Service-specific metadata associated with the operation. It typically
+ # contains progress information and common metadata such as create time.
+ # Some services might not provide such metadata. Any method that returns a
+ # long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "done": True or False, # If the value is `false`, it means the operation is still in progress.
+ # If true, the operation is completed, and either `error` or `response` is
+ # available.
+ "response": { # The normal response of the operation in case of success. If the original
+ # method returns no data on success, such as `Delete`, the response is
+ # `google.protobuf.Empty`. If the original method is standard
+ # `Get`/`Create`/`Update`, the response should be the resource. For other
+ # methods, the response should have the type `XxxResponse`, where `Xxx`
+ # is the original method name. For example, if the original method name
+ # is `TakeSnapshot()`, the inferred response type is
+ # `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that
+ # originally returns it. If you use the default HTTP mapping, the
+ # `name` should have the format of `operations/some/unique/name`.
+ "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure.
+ # programming environments, including REST APIs and RPC APIs. It is used by
+ # [gRPC](https://github.com/grpc). The error model is designed to be:
+ #
+ # - Simple to use and understand for most users
+ # - Flexible enough to meet unexpected needs
+ #
+ # # Overview
+ #
+ # The `Status` message contains three pieces of data: error code, error message,
+ # and error details. The error code should be an enum value of
+ # google.rpc.Code, but it may accept additional error codes if needed. The
+ # error message should be a developer-facing English message that helps
+ # developers *understand* and *resolve* the error. If a localized user-facing
+ # error message is needed, put the localized message in the error details or
+ # localize it in the client. The optional error details may contain arbitrary
+ # information about the error. There is a predefined set of error detail types
+ # in the package `google.rpc` which can be used for common error conditions.
+ #
+ # # Language mapping
+ #
+ # The `Status` message is the logical representation of the error model, but it
+ # is not necessarily the actual wire format. When the `Status` message is
+ # exposed in different client libraries and different wire protocols, it can be
+ # mapped differently. For example, it will likely be mapped to some exceptions
+ # in Java, but more likely mapped to some error codes in C.
+ #
+ # # Other uses
+ #
+ # The error model and the `Status` message can be used in a variety of
+ # environments, either with or without APIs, to provide a
+ # consistent developer experience across different environments.
+ #
+ # Example uses of this error model include:
+ #
+ # - Partial errors. If a service needs to return partial errors to the client,
+ # it may embed the `Status` in the normal response to indicate the partial
+ # errors.
+ #
+ # - Workflow errors. A typical workflow has multiple steps. Each step may
+ # have a `Status` message for error reporting purpose.
+ #
+ # - Batch operations. If a client uses batch request and batch response, the
+ # `Status` message should be used directly inside batch response, one for
+ # each error sub-response.
+ #
+ # - Asynchronous operations. If an API call embeds asynchronous operation
+ # results in its response, the status of those operations should be
+ # represented directly using the `Status` message.
+ #
+ # - Logging. If some API errors are stored in logs, the message `Status` could
+ # be used directly after any stripping needed for security/privacy reasons.
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There will be a
+ # common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
+ <pre>Retrieves the next page of results.
+
+Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+Returns:
+ A request object that you can call 'execute()' on to request the next
+ page. Returns None if there are no more items in the collection.
+ </pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/monitoring_v3.html b/docs/dyn/monitoring_v3.html
index 783d845..e802bf6 100644
--- a/docs/dyn/monitoring_v3.html
+++ b/docs/dyn/monitoring_v3.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="monitoring_v3.html">Google Monitoring API</a></h1>
+<h1><a href="monitoring_v3.html">Stackdriver Monitoring API</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="monitoring_v3.projects.html">projects()</a></code>
diff --git a/docs/dyn/monitoring_v3.projects.collectdTimeSeries.html b/docs/dyn/monitoring_v3.projects.collectdTimeSeries.html
index dda189d..635ece3 100644
--- a/docs/dyn/monitoring_v3.projects.collectdTimeSeries.html
+++ b/docs/dyn/monitoring_v3.projects.collectdTimeSeries.html
@@ -72,125 +72,139 @@
</style>
-<h1><a href="monitoring_v3.html">Google Monitoring API</a> . <a href="monitoring_v3.projects.html">projects</a> . <a href="monitoring_v3.projects.collectdTimeSeries.html">collectdTimeSeries</a></h1>
+<h1><a href="monitoring_v3.html">Stackdriver Monitoring API</a> . <a href="monitoring_v3.projects.html">projects</a> . <a href="monitoring_v3.projects.collectdTimeSeries.html">collectdTimeSeries</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#create">create(name, body, x__xgafv=None)</a></code></p>
-<p class="firstline">Creates a new time series with the given data points. This method is only for use in `collectd`-related code, including the Google Monitoring Agent. See [google.monitoring.v3.MetricService.CreateTimeSeries] instead.</p>
+<p class="firstline">Stackdriver Monitoring Agent only: Creates a new time series.<aside class="caution">This method is only for use by the Stackdriver Monitoring Agent. Use projects.timeSeries.create instead.</aside></p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(name, body, x__xgafv=None)</code>
- <pre>Creates a new time series with the given data points. This method is only for use in `collectd`-related code, including the Google Monitoring Agent. See [google.monitoring.v3.MetricService.CreateTimeSeries] instead.
+ <pre>Stackdriver Monitoring Agent only: Creates a new time series.<aside class="caution">This method is only for use by the Stackdriver Monitoring Agent. Use projects.timeSeries.create instead.</aside>
Args:
- name: string, The project in which to create the time series. The format is `"projects/PROJECT_ID_OR_NUMBER"`. (required)
+ name: string, The project in which to create the time series. The format is "projects/PROJECT_ID_OR_NUMBER". (required)
body: object, The request body. (required)
The object takes the form of:
-{ # The `CreateCollectdTimeSeries` request.
- "collectdPayloads": [ # The `collectd` payloads representing the time series data. You must not include more than a single point for each time series, so no two payloads can have the same values for all of the fields `plugin`, `plugin_instance`, `type`, and `type_instance`.
- { # A collection of data points sent from a `collectd`-based plugin. See the `collectd` documentation for more information.
- "plugin": "A String", # The name of the plugin. Example: `"disk"`.
- "typeInstance": "A String", # The measurement type instance. Example: `"used"`.
- "values": [ # The measured values during this time interval. Each value must have a different `dataSourceName`.
- { # A single data point from a `collectd`-based plugin.
+{ # The CreateCollectdTimeSeries request.
+ "collectdPayloads": [ # The collectd payloads representing the time series data. You must not include more than a single point for each time series, so no two payloads can have the same values for all of the fields plugin, plugin_instance, type, and type_instance.
+ { # A collection of data points sent from a collectd-based plugin. See the collectd documentation for more information.
+ "plugin": "A String", # The name of the plugin. Example: "disk".
+ "typeInstance": "A String", # The measurement type instance. Example: "used".
+ "values": [ # The measured values during this time interval. Each value must have a different dataSourceName.
+ { # A single data point from a collectd-based plugin.
"dataSourceType": "A String", # The type of measurement.
- "dataSourceName": "A String", # The data source for the `collectd` value. For example there are two data sources for network measurements: `"rx"` and `"tx"`.
+ "dataSourceName": "A String", # The data source for the collectd value. For example there are two data sources for network measurements: "rx" and "tx".
"value": { # A single strongly-typed value. # The measurement value.
- "distributionValue": { # Distribution contains summary statistics for a population of values and, optionally, a histogram representing the distribution of those values across a specified set of histogram buckets. The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values. The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by specifying parameters for a method of computing them (buckets of fixed width or buckets of exponentially increasing width). Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the `mean` and `sum_of_squared_deviation` fields meaningless. # A distribution value.
+ "distributionValue": { # Distribution contains summary statistics for a population of values and, optionally, a histogram representing the distribution of those values across a specified set of histogram buckets.The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values.The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by specifying parameters for a method of computing them (buckets of fixed width or buckets of exponentially increasing width).Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the mean and sum_of_squared_deviation fields meaningless. # A distribution value.
"count": "A String", # The number of values in the population. Must be non-negative.
- "bucketCounts": [ # If `bucket_options` is given, then the sum of the values in `bucket_counts` must equal the value in `count`. If `bucket_options` is not given, no `bucket_counts` fields may be given. Bucket counts are given in order under the numbering scheme described above (the underflow bucket has number 0; the finite buckets, if any, have numbers 1 through N-2; the overflow bucket has number N-1). The size of `bucket_counts` must be no greater than N as defined in `bucket_options`. Any suffix of trailing zero bucket_count fields may be omitted.
+ "bucketCounts": [ # If bucket_options is given, then the sum of the values in bucket_counts must equal the value in count. If bucket_options is not given, no bucket_counts fields may be given.Bucket counts are given in order under the numbering scheme described above (the underflow bucket has number 0; the finite buckets, if any, have numbers 1 through N-2; the overflow bucket has number N-1).The size of bucket_counts must be no greater than N as defined in bucket_options.Any suffix of trailing zero bucket_count fields may be omitted.
"A String",
],
- "bucketOptions": { # A Distribution may optionally contain a histogram of the values in the population. The histogram is given in `bucket_counts` as counts of values that fall into one of a sequence of non-overlapping buckets. The sequence of buckets is described by `bucket_options`. A bucket specifies an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket is strictly greater than the lower bound. The sequence of N buckets for a Distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite. `BucketOptions` describes bucket boundaries in one of three ways. Two describe the boundaries by giving parameters for a formula to generate boundaries and one gives the bucket boundaries explicitly. If `bucket_boundaries` is not given, then no `bucket_counts` may be given. # Defines the histogram bucket boundaries.
- "exponentialBuckets": { # Specify a sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket. Defines `num_finite_buckets + 2` (= N) buckets with these boundaries for bucket i: Upper bound (0 <= i < N-1): scale * (growth_factor ^ i). Lower bound (1 <= i < N): scale * (growth_factor ^ (i - 1)). # The exponential buckets.
- "scale": 3.14, # Must be greater than 0
- "growthFactor": 3.14, # Must be greater than 1
- "numFiniteBuckets": 42, # must be greater than 0
+ "bucketOptions": { # A Distribution may optionally contain a histogram of the values in the population. The histogram is given in bucket_counts as counts of values that fall into one of a sequence of non-overlapping buckets. The sequence of buckets is described by bucket_options.A bucket specifies an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket is strictly greater than the lower bound.The sequence of N buckets for a Distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite.BucketOptions describes bucket boundaries in one of three ways. Two describe the boundaries by giving parameters for a formula to generate boundaries and one gives the bucket boundaries explicitly.If bucket_options is not given, then no bucket_counts may be given. # Defines the histogram bucket boundaries.
+ "exponentialBuckets": { # Specify a sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket.Defines num_finite_buckets + 2 (= N) buckets with these boundaries for bucket i:Upper bound (0 <= i < N-1): scale * (growth_factor ^ i). Lower bound (1 <= i < N): scale * (growth_factor ^ (i - 1)). # The exponential buckets.
+ "scale": 3.14, # Must be greater than 0.
+ "growthFactor": 3.14, # Must be greater than 1.
+ "numFiniteBuckets": 42, # Must be greater than 0.
},
- "linearBuckets": { # Specify a sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket. Defines `num_finite_buckets + 2` (= N) buckets with these boundaries for bucket `i`: Upper bound (0 <= i < N-1): offset + (width * i). Lower bound (1 <= i < N): offset + (width * (i - 1)). # The linear bucket.
+ "linearBuckets": { # Specify a sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket.Defines num_finite_buckets + 2 (= N) buckets with these boundaries for bucket i:Upper bound (0 <= i < N-1): offset + (width * i). Lower bound (1 <= i < N): offset + (width * (i - 1)). # The linear bucket.
"width": 3.14, # Must be greater than 0.
"numFiniteBuckets": 42, # Must be greater than 0.
"offset": 3.14, # Lower bound of the first bucket.
},
- "explicitBuckets": { # A set of buckets with arbitrary widths. Defines `size(bounds) + 1` (= N) buckets with these boundaries for bucket i: Upper bound (0 <= i < N-1): bounds[i] Lower bound (1 <= i < N); bounds[i - 1] There must be at least one element in `bounds`. If `bounds` has only one element, there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets. # The explicit buckets.
+ "explicitBuckets": { # A set of buckets with arbitrary widths.Defines size(bounds) + 1 (= N) buckets with these boundaries for bucket i:Upper bound (0 <= i < N-1): boundsi Lower bound (1 <= i < N); boundsi - 1There must be at least one element in bounds. If bounds has only one element, there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets. # The explicit buckets.
"bounds": [ # The values must be monotonically increasing.
3.14,
],
},
},
- "range": { # The range of the population values. # If specified, contains the range of the population values. The field must not be present if the `count` is zero.
+ "range": { # The range of the population values. # If specified, contains the range of the population values. The field must not be present if the count is zero. This field is presently ignored by the Stackdriver Monitoring API v3.
"max": 3.14, # The maximum of the population values.
"min": 3.14, # The minimum of the population values.
},
- "sumOfSquaredDeviation": 3.14, # The sum of squared deviations from the mean of the values in the population. For values x_i this is: Sum[i=1..n]((x_i - mean)^2) Knuth, "The Art of Computer Programming", Vol. 2, page 323, 3rd edition describes Welford's method for accumulating this sum in one pass. If `count` is zero then this field must be zero.
- "mean": 3.14, # The arithmetic mean of the values in the population. If `count` is zero then this field must be zero.
+ "sumOfSquaredDeviation": 3.14, # The sum of squared deviations from the mean of the values in the population. For values x_i this is:
+ # Sum[i=1..n]((x_i - mean)^2)
+ # Knuth, "The Art of Computer Programming", Vol. 2, page 323, 3rd edition describes Welford's method for accumulating this sum in one pass.If count is zero then this field must be zero.
+ "mean": 3.14, # The arithmetic mean of the values in the population. If count is zero then this field must be zero.
},
"stringValue": "A String", # A variable-length string value.
- "boolValue": True or False, # A Boolean value: `true` or `false`.
- "int64Value": "A String", # A 64-bit integer. Its range is approximately ±9.2x1018.
- "doubleValue": 3.14, # A 64-bit double-precision floating-point number. Its magnitude is approximately ±10±300 and it has 16 significant digits of precision.
+ "boolValue": True or False, # A Boolean value: true or false.
+ "int64Value": "A String", # A 64-bit integer. Its range is approximately ±9.2x10<sup>18</sup>.
+ "doubleValue": 3.14, # A 64-bit double-precision floating-point number. Its magnitude is approximately ±10<sup>±300</sup> and it has 16 significant digits of precision.
},
},
],
"startTime": "A String", # The start time of the interval.
"endTime": "A String", # The end time of the interval.
- "type": "A String", # The measurement type. Example: `"memory"`.
- "pluginInstance": "A String", # The instance name of the plugin Example: `"hdcl"`.
- "metadata": { # The measurement metadata. Example: `"process_id" -> 12345`
+ "type": "A String", # The measurement type. Example: "memory".
+ "pluginInstance": "A String", # The instance name of the plugin Example: "hdcl".
+ "metadata": { # The measurement metadata. Example: "process_id" -> 12345
"a_key": { # A single strongly-typed value.
- "distributionValue": { # Distribution contains summary statistics for a population of values and, optionally, a histogram representing the distribution of those values across a specified set of histogram buckets. The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values. The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by specifying parameters for a method of computing them (buckets of fixed width or buckets of exponentially increasing width). Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the `mean` and `sum_of_squared_deviation` fields meaningless. # A distribution value.
+ "distributionValue": { # Distribution contains summary statistics for a population of values and, optionally, a histogram representing the distribution of those values across a specified set of histogram buckets.The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values.The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by specifying parameters for a method of computing them (buckets of fixed width or buckets of exponentially increasing width).Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the mean and sum_of_squared_deviation fields meaningless. # A distribution value.
"count": "A String", # The number of values in the population. Must be non-negative.
- "bucketCounts": [ # If `bucket_options` is given, then the sum of the values in `bucket_counts` must equal the value in `count`. If `bucket_options` is not given, no `bucket_counts` fields may be given. Bucket counts are given in order under the numbering scheme described above (the underflow bucket has number 0; the finite buckets, if any, have numbers 1 through N-2; the overflow bucket has number N-1). The size of `bucket_counts` must be no greater than N as defined in `bucket_options`. Any suffix of trailing zero bucket_count fields may be omitted.
+ "bucketCounts": [ # If bucket_options is given, then the sum of the values in bucket_counts must equal the value in count. If bucket_options is not given, no bucket_counts fields may be given.Bucket counts are given in order under the numbering scheme described above (the underflow bucket has number 0; the finite buckets, if any, have numbers 1 through N-2; the overflow bucket has number N-1).The size of bucket_counts must be no greater than N as defined in bucket_options.Any suffix of trailing zero bucket_count fields may be omitted.
"A String",
],
- "bucketOptions": { # A Distribution may optionally contain a histogram of the values in the population. The histogram is given in `bucket_counts` as counts of values that fall into one of a sequence of non-overlapping buckets. The sequence of buckets is described by `bucket_options`. A bucket specifies an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket is strictly greater than the lower bound. The sequence of N buckets for a Distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite. `BucketOptions` describes bucket boundaries in one of three ways. Two describe the boundaries by giving parameters for a formula to generate boundaries and one gives the bucket boundaries explicitly. If `bucket_boundaries` is not given, then no `bucket_counts` may be given. # Defines the histogram bucket boundaries.
- "exponentialBuckets": { # Specify a sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket. Defines `num_finite_buckets + 2` (= N) buckets with these boundaries for bucket i: Upper bound (0 <= i < N-1): scale * (growth_factor ^ i). Lower bound (1 <= i < N): scale * (growth_factor ^ (i - 1)). # The exponential buckets.
- "scale": 3.14, # Must be greater than 0
- "growthFactor": 3.14, # Must be greater than 1
- "numFiniteBuckets": 42, # must be greater than 0
+ "bucketOptions": { # A Distribution may optionally contain a histogram of the values in the population. The histogram is given in bucket_counts as counts of values that fall into one of a sequence of non-overlapping buckets. The sequence of buckets is described by bucket_options.A bucket specifies an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket is strictly greater than the lower bound.The sequence of N buckets for a Distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite.BucketOptions describes bucket boundaries in one of three ways. Two describe the boundaries by giving parameters for a formula to generate boundaries and one gives the bucket boundaries explicitly.If bucket_options is not given, then no bucket_counts may be given. # Defines the histogram bucket boundaries.
+ "exponentialBuckets": { # Specify a sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket.Defines num_finite_buckets + 2 (= N) buckets with these boundaries for bucket i:Upper bound (0 <= i < N-1): scale * (growth_factor ^ i). Lower bound (1 <= i < N): scale * (growth_factor ^ (i - 1)). # The exponential buckets.
+ "scale": 3.14, # Must be greater than 0.
+ "growthFactor": 3.14, # Must be greater than 1.
+ "numFiniteBuckets": 42, # Must be greater than 0.
},
- "linearBuckets": { # Specify a sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket. Defines `num_finite_buckets + 2` (= N) buckets with these boundaries for bucket `i`: Upper bound (0 <= i < N-1): offset + (width * i). Lower bound (1 <= i < N): offset + (width * (i - 1)). # The linear bucket.
+ "linearBuckets": { # Specify a sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket.Defines num_finite_buckets + 2 (= N) buckets with these boundaries for bucket i:Upper bound (0 <= i < N-1): offset + (width * i). Lower bound (1 <= i < N): offset + (width * (i - 1)). # The linear bucket.
"width": 3.14, # Must be greater than 0.
"numFiniteBuckets": 42, # Must be greater than 0.
"offset": 3.14, # Lower bound of the first bucket.
},
- "explicitBuckets": { # A set of buckets with arbitrary widths. Defines `size(bounds) + 1` (= N) buckets with these boundaries for bucket i: Upper bound (0 <= i < N-1): bounds[i] Lower bound (1 <= i < N); bounds[i - 1] There must be at least one element in `bounds`. If `bounds` has only one element, there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets. # The explicit buckets.
+ "explicitBuckets": { # A set of buckets with arbitrary widths.Defines size(bounds) + 1 (= N) buckets with these boundaries for bucket i:Upper bound (0 <= i < N-1): boundsi Lower bound (1 <= i < N); boundsi - 1There must be at least one element in bounds. If bounds has only one element, there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets. # The explicit buckets.
"bounds": [ # The values must be monotonically increasing.
3.14,
],
},
},
- "range": { # The range of the population values. # If specified, contains the range of the population values. The field must not be present if the `count` is zero.
+ "range": { # The range of the population values. # If specified, contains the range of the population values. The field must not be present if the count is zero. This field is presently ignored by the Stackdriver Monitoring API v3.
"max": 3.14, # The maximum of the population values.
"min": 3.14, # The minimum of the population values.
},
- "sumOfSquaredDeviation": 3.14, # The sum of squared deviations from the mean of the values in the population. For values x_i this is: Sum[i=1..n]((x_i - mean)^2) Knuth, "The Art of Computer Programming", Vol. 2, page 323, 3rd edition describes Welford's method for accumulating this sum in one pass. If `count` is zero then this field must be zero.
- "mean": 3.14, # The arithmetic mean of the values in the population. If `count` is zero then this field must be zero.
+ "sumOfSquaredDeviation": 3.14, # The sum of squared deviations from the mean of the values in the population. For values x_i this is:
+ # Sum[i=1..n]((x_i - mean)^2)
+ # Knuth, "The Art of Computer Programming", Vol. 2, page 323, 3rd edition describes Welford's method for accumulating this sum in one pass.If count is zero then this field must be zero.
+ "mean": 3.14, # The arithmetic mean of the values in the population. If count is zero then this field must be zero.
},
"stringValue": "A String", # A variable-length string value.
- "boolValue": True or False, # A Boolean value: `true` or `false`.
- "int64Value": "A String", # A 64-bit integer. Its range is approximately ±9.2x1018.
- "doubleValue": 3.14, # A 64-bit double-precision floating-point number. Its magnitude is approximately ±10±300 and it has 16 significant digits of precision.
+ "boolValue": True or False, # A Boolean value: true or false.
+ "int64Value": "A String", # A 64-bit integer. Its range is approximately ±9.2x10<sup>18</sup>.
+ "doubleValue": 3.14, # A 64-bit double-precision floating-point number. Its magnitude is approximately ±10<sup>±300</sup> and it has 16 significant digits of precision.
},
},
},
],
- "resource": { # An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The `type` field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the `labels` field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for `"gce_instance"` has labels `"instance_id"` and `"zone"`: { "type": "gce_instance", "labels": { "instance_id": "my-instance", "zone": "us-central1-a" }} # The monitored resource associated with the time series.
- "labels": { # Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Cloud SQL databases use the labels `"database_id"` and `"zone"`.
+ "resource": { # An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for "gce_instance" has labels "instance_id" and "zone": # The monitored resource associated with the time series.
+ # { "type": "gce_instance",
+ # "labels": { "instance_id": "12345678901234",
+ # "zone": "us-central1-a" }}
+ "labels": { # Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Cloud SQL databases use the labels "database_id" and "zone".
"a_key": "A String",
},
- "type": "A String", # Required. The monitored resource type. This field must match the `type` field of a MonitoredResourceDescriptor object. For example, the type of a Cloud SQL database is `"cloudsql_database"`.
+ "type": "A String", # Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Cloud SQL database is "cloudsql_database".
},
- "collectdVersion": "A String", # The version of `collectd` that collected the data. Example: `"5.3.0-192.el6"`.
+ "collectdVersion": "A String", # The version of collectd that collected the data. Example: "5.3.0-192.el6".
}
x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
- { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:
+ # service Foo {
+ # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
+ # }
+ # The JSON representation for Empty is empty JSON object {}.
}</pre>
</div>
diff --git a/docs/dyn/monitoring_v3.projects.groups.html b/docs/dyn/monitoring_v3.projects.groups.html
index 68f850f..1e8481b 100644
--- a/docs/dyn/monitoring_v3.projects.groups.html
+++ b/docs/dyn/monitoring_v3.projects.groups.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="monitoring_v3.html">Google Monitoring API</a> . <a href="monitoring_v3.projects.html">projects</a> . <a href="monitoring_v3.projects.groups.html">groups</a></h1>
+<h1><a href="monitoring_v3.html">Stackdriver Monitoring API</a> . <a href="monitoring_v3.projects.html">projects</a> . <a href="monitoring_v3.projects.groups.html">groups</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="monitoring_v3.projects.groups.members.html">members()</a></code>
@@ -96,36 +96,39 @@
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#update">update(name, body, validateOnly=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Updates an existing group. You can change any group attributes except `name`.</p>
+<p class="firstline">Updates an existing group. You can change any group attributes except name.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(name, body, validateOnly=None, x__xgafv=None)</code>
<pre>Creates a new group.
Args:
- name: string, The project in which to create the group. The format is `"projects/{project_id_or_number}"`. (required)
+ name: string, The project in which to create the group. The format is "projects/{project_id_or_number}". (required)
body: object, The request body. (required)
The object takes the form of:
-{ # The description of a dynamic collection of monitored resources. Each group has a filter that is matched against monitored resources and their associated metadata. If a group's filter matches an available monitored resource, then that resource is a member of that group. Groups can contain any number of monitored resources, and each monitored resource can be a member of any number of groups. Groups can be nested in parent-child hierarchies. The `parentName` field identifies an optional parent for each group. If a group has a parent, then the only monitored resources available to be matched by the group's filter are the resources contained in the parent group. In other words, a group contains the monitored resources that match its filter and the filters of all the group's ancestors. A group without a parent can contain any monitored resource. For example, consider an infrastructure running a set of instances with two user-defined tags: `"environment"` and `"role"`. A parent group has a filter, `environment="production"`. A child of that parent group has a filter, `role="transcoder"`. The parent group contains all instances in the production environment, regardless of their roles. The child group contains instances that have the transcoder role *and* are in the production environment. The monitored resources contained in a group can change at any moment, depending on what resources exist and what filters are associated with the group and its ancestors.
+{ # The description of a dynamic collection of monitored resources. Each group has a filter that is matched against monitored resources and their associated metadata. If a group's filter matches an available monitored resource, then that resource is a member of that group. Groups can contain any number of monitored resources, and each monitored resource can be a member of any number of groups.Groups can be nested in parent-child hierarchies. The parentName field identifies an optional parent for each group. If a group has a parent, then the only monitored resources available to be matched by the group's filter are the resources contained in the parent group. In other words, a group contains the monitored resources that match its filter and the filters of all the group's ancestors. A group without a parent can contain any monitored resource.For example, consider an infrastructure running a set of instances with two user-defined tags: "environment" and "role". A parent group has a filter, environment="production". A child of that parent group has a filter, role="transcoder". The parent group contains all instances in the production environment, regardless of their roles. The child group contains instances that have the transcoder role and are in the production environment.The monitored resources contained in a group can change at any moment, depending on what resources exist and what filters are associated with the group and its ancestors.
"filter": "A String", # The filter used to determine which monitored resources belong to this group.
- "parentName": "A String", # The name of the group's parent, if it has one. The format is `"projects/{project_id_or_number}/groups/{group_id}"`. For groups with no parent, `parentName` is the empty string, `""`.
+ "parentName": "A String", # The name of the group's parent, if it has one. The format is "projects/{project_id_or_number}/groups/{group_id}". For groups with no parent, parentName is the empty string, "".
"displayName": "A String", # A user-assigned name for this group, used only for display purposes.
- "name": "A String", # The name of this group. The format is `"projects/{project_id_or_number}/groups/{group_id}"`. When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to `CreateGroup` and a unique `{group_id}` that is generated automatically. @OutputOnly
+ "name": "A String", # Output only. The name of this group. The format is "projects/{project_id_or_number}/groups/{group_id}". When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to CreateGroup and a unique {group_id} that is generated automatically.
"isCluster": True or False, # If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters.
}
validateOnly: boolean, If true, validate this request but do not create the group.
x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
- { # The description of a dynamic collection of monitored resources. Each group has a filter that is matched against monitored resources and their associated metadata. If a group's filter matches an available monitored resource, then that resource is a member of that group. Groups can contain any number of monitored resources, and each monitored resource can be a member of any number of groups. Groups can be nested in parent-child hierarchies. The `parentName` field identifies an optional parent for each group. If a group has a parent, then the only monitored resources available to be matched by the group's filter are the resources contained in the parent group. In other words, a group contains the monitored resources that match its filter and the filters of all the group's ancestors. A group without a parent can contain any monitored resource. For example, consider an infrastructure running a set of instances with two user-defined tags: `"environment"` and `"role"`. A parent group has a filter, `environment="production"`. A child of that parent group has a filter, `role="transcoder"`. The parent group contains all instances in the production environment, regardless of their roles. The child group contains instances that have the transcoder role *and* are in the production environment. The monitored resources contained in a group can change at any moment, depending on what resources exist and what filters are associated with the group and its ancestors.
+ { # The description of a dynamic collection of monitored resources. Each group has a filter that is matched against monitored resources and their associated metadata. If a group's filter matches an available monitored resource, then that resource is a member of that group. Groups can contain any number of monitored resources, and each monitored resource can be a member of any number of groups.Groups can be nested in parent-child hierarchies. The parentName field identifies an optional parent for each group. If a group has a parent, then the only monitored resources available to be matched by the group's filter are the resources contained in the parent group. In other words, a group contains the monitored resources that match its filter and the filters of all the group's ancestors. A group without a parent can contain any monitored resource.For example, consider an infrastructure running a set of instances with two user-defined tags: "environment" and "role". A parent group has a filter, environment="production". A child of that parent group has a filter, role="transcoder". The parent group contains all instances in the production environment, regardless of their roles. The child group contains instances that have the transcoder role and are in the production environment.The monitored resources contained in a group can change at any moment, depending on what resources exist and what filters are associated with the group and its ancestors.
"filter": "A String", # The filter used to determine which monitored resources belong to this group.
- "parentName": "A String", # The name of the group's parent, if it has one. The format is `"projects/{project_id_or_number}/groups/{group_id}"`. For groups with no parent, `parentName` is the empty string, `""`.
+ "parentName": "A String", # The name of the group's parent, if it has one. The format is "projects/{project_id_or_number}/groups/{group_id}". For groups with no parent, parentName is the empty string, "".
"displayName": "A String", # A user-assigned name for this group, used only for display purposes.
- "name": "A String", # The name of this group. The format is `"projects/{project_id_or_number}/groups/{group_id}"`. When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to `CreateGroup` and a unique `{group_id}` that is generated automatically. @OutputOnly
+ "name": "A String", # Output only. The name of this group. The format is "projects/{project_id_or_number}/groups/{group_id}". When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to CreateGroup and a unique {group_id} that is generated automatically.
"isCluster": True or False, # If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters.
}</pre>
</div>
@@ -135,13 +138,20 @@
<pre>Deletes an existing group.
Args:
- name: string, The group to delete. The format is `"projects/{project_id_or_number}/groups/{group_id}"`. (required)
+ name: string, The group to delete. The format is "projects/{project_id_or_number}/groups/{group_id}". (required)
x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
- { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:
+ # service Foo {
+ # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
+ # }
+ # The JSON representation for Empty is empty JSON object {}.
}</pre>
</div>
@@ -150,17 +160,20 @@
<pre>Gets a single group.
Args:
- name: string, The group to retrieve. The format is `"projects/{project_id_or_number}/groups/{group_id}"`. (required)
+ name: string, The group to retrieve. The format is "projects/{project_id_or_number}/groups/{group_id}". (required)
x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
- { # The description of a dynamic collection of monitored resources. Each group has a filter that is matched against monitored resources and their associated metadata. If a group's filter matches an available monitored resource, then that resource is a member of that group. Groups can contain any number of monitored resources, and each monitored resource can be a member of any number of groups. Groups can be nested in parent-child hierarchies. The `parentName` field identifies an optional parent for each group. If a group has a parent, then the only monitored resources available to be matched by the group's filter are the resources contained in the parent group. In other words, a group contains the monitored resources that match its filter and the filters of all the group's ancestors. A group without a parent can contain any monitored resource. For example, consider an infrastructure running a set of instances with two user-defined tags: `"environment"` and `"role"`. A parent group has a filter, `environment="production"`. A child of that parent group has a filter, `role="transcoder"`. The parent group contains all instances in the production environment, regardless of their roles. The child group contains instances that have the transcoder role *and* are in the production environment. The monitored resources contained in a group can change at any moment, depending on what resources exist and what filters are associated with the group and its ancestors.
+ { # The description of a dynamic collection of monitored resources. Each group has a filter that is matched against monitored resources and their associated metadata. If a group's filter matches an available monitored resource, then that resource is a member of that group. Groups can contain any number of monitored resources, and each monitored resource can be a member of any number of groups.Groups can be nested in parent-child hierarchies. The parentName field identifies an optional parent for each group. If a group has a parent, then the only monitored resources available to be matched by the group's filter are the resources contained in the parent group. In other words, a group contains the monitored resources that match its filter and the filters of all the group's ancestors. A group without a parent can contain any monitored resource.For example, consider an infrastructure running a set of instances with two user-defined tags: "environment" and "role". A parent group has a filter, environment="production". A child of that parent group has a filter, role="transcoder". The parent group contains all instances in the production environment, regardless of their roles. The child group contains instances that have the transcoder role and are in the production environment.The monitored resources contained in a group can change at any moment, depending on what resources exist and what filters are associated with the group and its ancestors.
"filter": "A String", # The filter used to determine which monitored resources belong to this group.
- "parentName": "A String", # The name of the group's parent, if it has one. The format is `"projects/{project_id_or_number}/groups/{group_id}"`. For groups with no parent, `parentName` is the empty string, `""`.
+ "parentName": "A String", # The name of the group's parent, if it has one. The format is "projects/{project_id_or_number}/groups/{group_id}". For groups with no parent, parentName is the empty string, "".
"displayName": "A String", # A user-assigned name for this group, used only for display purposes.
- "name": "A String", # The name of this group. The format is `"projects/{project_id_or_number}/groups/{group_id}"`. When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to `CreateGroup` and a unique `{group_id}` that is generated automatically. @OutputOnly
+ "name": "A String", # Output only. The name of this group. The format is "projects/{project_id_or_number}/groups/{group_id}". When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to CreateGroup and a unique {group_id} that is generated automatically.
"isCluster": True or False, # If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters.
}</pre>
</div>
@@ -170,25 +183,28 @@
<pre>Lists the existing groups.
Args:
- name: string, The project whose groups are to be listed. The format is `"projects/{project_id_or_number}"`. (required)
- ancestorsOfGroup: string, A group name: `"projects/{project_id_or_number}/groups/{group_id}"`. Returns groups that are ancestors of the specified group. The groups are returned in order, starting with the immediate parent and ending with the most distant ancestor. If the specified group has no immediate parent, the results are empty.
- descendantsOfGroup: string, A group name: `"projects/{project_id_or_number}/groups/{group_id}"`. Returns the descendants of the specified group. This is a superset of the results returned by the `childrenOfGroup` filter, and includes children-of-children, and so forth.
+ name: string, The project whose groups are to be listed. The format is "projects/{project_id_or_number}". (required)
+ ancestorsOfGroup: string, A group name: "projects/{project_id_or_number}/groups/{group_id}". Returns groups that are ancestors of the specified group. The groups are returned in order, starting with the immediate parent and ending with the most distant ancestor. If the specified group has no immediate parent, the results are empty.
+ descendantsOfGroup: string, A group name: "projects/{project_id_or_number}/groups/{group_id}". Returns the descendants of the specified group. This is a superset of the results returned by the childrenOfGroup filter, and includes children-of-children, and so forth.
pageSize: integer, A positive number that is the maximum number of results to return.
x__xgafv: string, V1 error format.
- pageToken: string, If this field is not empty then it must contain the `nextPageToken` value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.
- childrenOfGroup: string, A group name: `"projects/{project_id_or_number}/groups/{group_id}"`. Returns groups whose `parentName` field contains the group name. If no groups have this parent, the results are empty.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+ pageToken: string, If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.
+ childrenOfGroup: string, A group name: "projects/{project_id_or_number}/groups/{group_id}". Returns groups whose parentName field contains the group name. If no groups have this parent, the results are empty.
Returns:
An object of the form:
- { # The `ListGroups` response.
- "nextPageToken": "A String", # If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as `pageToken` in the next call to this method.
+ { # The ListGroups response.
+ "nextPageToken": "A String", # If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method.
"group": [ # The groups that match the specified filters.
- { # The description of a dynamic collection of monitored resources. Each group has a filter that is matched against monitored resources and their associated metadata. If a group's filter matches an available monitored resource, then that resource is a member of that group. Groups can contain any number of monitored resources, and each monitored resource can be a member of any number of groups. Groups can be nested in parent-child hierarchies. The `parentName` field identifies an optional parent for each group. If a group has a parent, then the only monitored resources available to be matched by the group's filter are the resources contained in the parent group. In other words, a group contains the monitored resources that match its filter and the filters of all the group's ancestors. A group without a parent can contain any monitored resource. For example, consider an infrastructure running a set of instances with two user-defined tags: `"environment"` and `"role"`. A parent group has a filter, `environment="production"`. A child of that parent group has a filter, `role="transcoder"`. The parent group contains all instances in the production environment, regardless of their roles. The child group contains instances that have the transcoder role *and* are in the production environment. The monitored resources contained in a group can change at any moment, depending on what resources exist and what filters are associated with the group and its ancestors.
+ { # The description of a dynamic collection of monitored resources. Each group has a filter that is matched against monitored resources and their associated metadata. If a group's filter matches an available monitored resource, then that resource is a member of that group. Groups can contain any number of monitored resources, and each monitored resource can be a member of any number of groups.Groups can be nested in parent-child hierarchies. The parentName field identifies an optional parent for each group. If a group has a parent, then the only monitored resources available to be matched by the group's filter are the resources contained in the parent group. In other words, a group contains the monitored resources that match its filter and the filters of all the group's ancestors. A group without a parent can contain any monitored resource.For example, consider an infrastructure running a set of instances with two user-defined tags: "environment" and "role". A parent group has a filter, environment="production". A child of that parent group has a filter, role="transcoder". The parent group contains all instances in the production environment, regardless of their roles. The child group contains instances that have the transcoder role and are in the production environment.The monitored resources contained in a group can change at any moment, depending on what resources exist and what filters are associated with the group and its ancestors.
"filter": "A String", # The filter used to determine which monitored resources belong to this group.
- "parentName": "A String", # The name of the group's parent, if it has one. The format is `"projects/{project_id_or_number}/groups/{group_id}"`. For groups with no parent, `parentName` is the empty string, `""`.
+ "parentName": "A String", # The name of the group's parent, if it has one. The format is "projects/{project_id_or_number}/groups/{group_id}". For groups with no parent, parentName is the empty string, "".
"displayName": "A String", # A user-assigned name for this group, used only for display purposes.
- "name": "A String", # The name of this group. The format is `"projects/{project_id_or_number}/groups/{group_id}"`. When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to `CreateGroup` and a unique `{group_id}` that is generated automatically. @OutputOnly
+ "name": "A String", # Output only. The name of this group. The format is "projects/{project_id_or_number}/groups/{group_id}". When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to CreateGroup and a unique {group_id} that is generated automatically.
"isCluster": True or False, # If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters.
},
],
@@ -211,32 +227,35 @@
<div class="method">
<code class="details" id="update">update(name, body, validateOnly=None, x__xgafv=None)</code>
- <pre>Updates an existing group. You can change any group attributes except `name`.
+ <pre>Updates an existing group. You can change any group attributes except name.
Args:
- name: string, The name of this group. The format is `"projects/{project_id_or_number}/groups/{group_id}"`. When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to `CreateGroup` and a unique `{group_id}` that is generated automatically. @OutputOnly (required)
+ name: string, Output only. The name of this group. The format is "projects/{project_id_or_number}/groups/{group_id}". When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to CreateGroup and a unique {group_id} that is generated automatically. (required)
body: object, The request body. (required)
The object takes the form of:
-{ # The description of a dynamic collection of monitored resources. Each group has a filter that is matched against monitored resources and their associated metadata. If a group's filter matches an available monitored resource, then that resource is a member of that group. Groups can contain any number of monitored resources, and each monitored resource can be a member of any number of groups. Groups can be nested in parent-child hierarchies. The `parentName` field identifies an optional parent for each group. If a group has a parent, then the only monitored resources available to be matched by the group's filter are the resources contained in the parent group. In other words, a group contains the monitored resources that match its filter and the filters of all the group's ancestors. A group without a parent can contain any monitored resource. For example, consider an infrastructure running a set of instances with two user-defined tags: `"environment"` and `"role"`. A parent group has a filter, `environment="production"`. A child of that parent group has a filter, `role="transcoder"`. The parent group contains all instances in the production environment, regardless of their roles. The child group contains instances that have the transcoder role *and* are in the production environment. The monitored resources contained in a group can change at any moment, depending on what resources exist and what filters are associated with the group and its ancestors.
+{ # The description of a dynamic collection of monitored resources. Each group has a filter that is matched against monitored resources and their associated metadata. If a group's filter matches an available monitored resource, then that resource is a member of that group. Groups can contain any number of monitored resources, and each monitored resource can be a member of any number of groups.Groups can be nested in parent-child hierarchies. The parentName field identifies an optional parent for each group. If a group has a parent, then the only monitored resources available to be matched by the group's filter are the resources contained in the parent group. In other words, a group contains the monitored resources that match its filter and the filters of all the group's ancestors. A group without a parent can contain any monitored resource.For example, consider an infrastructure running a set of instances with two user-defined tags: "environment" and "role". A parent group has a filter, environment="production". A child of that parent group has a filter, role="transcoder". The parent group contains all instances in the production environment, regardless of their roles. The child group contains instances that have the transcoder role and are in the production environment.The monitored resources contained in a group can change at any moment, depending on what resources exist and what filters are associated with the group and its ancestors.
"filter": "A String", # The filter used to determine which monitored resources belong to this group.
- "parentName": "A String", # The name of the group's parent, if it has one. The format is `"projects/{project_id_or_number}/groups/{group_id}"`. For groups with no parent, `parentName` is the empty string, `""`.
+ "parentName": "A String", # The name of the group's parent, if it has one. The format is "projects/{project_id_or_number}/groups/{group_id}". For groups with no parent, parentName is the empty string, "".
"displayName": "A String", # A user-assigned name for this group, used only for display purposes.
- "name": "A String", # The name of this group. The format is `"projects/{project_id_or_number}/groups/{group_id}"`. When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to `CreateGroup` and a unique `{group_id}` that is generated automatically. @OutputOnly
+ "name": "A String", # Output only. The name of this group. The format is "projects/{project_id_or_number}/groups/{group_id}". When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to CreateGroup and a unique {group_id} that is generated automatically.
"isCluster": True or False, # If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters.
}
validateOnly: boolean, If true, validate this request but do not update the existing group.
x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
- { # The description of a dynamic collection of monitored resources. Each group has a filter that is matched against monitored resources and their associated metadata. If a group's filter matches an available monitored resource, then that resource is a member of that group. Groups can contain any number of monitored resources, and each monitored resource can be a member of any number of groups. Groups can be nested in parent-child hierarchies. The `parentName` field identifies an optional parent for each group. If a group has a parent, then the only monitored resources available to be matched by the group's filter are the resources contained in the parent group. In other words, a group contains the monitored resources that match its filter and the filters of all the group's ancestors. A group without a parent can contain any monitored resource. For example, consider an infrastructure running a set of instances with two user-defined tags: `"environment"` and `"role"`. A parent group has a filter, `environment="production"`. A child of that parent group has a filter, `role="transcoder"`. The parent group contains all instances in the production environment, regardless of their roles. The child group contains instances that have the transcoder role *and* are in the production environment. The monitored resources contained in a group can change at any moment, depending on what resources exist and what filters are associated with the group and its ancestors.
+ { # The description of a dynamic collection of monitored resources. Each group has a filter that is matched against monitored resources and their associated metadata. If a group's filter matches an available monitored resource, then that resource is a member of that group. Groups can contain any number of monitored resources, and each monitored resource can be a member of any number of groups.Groups can be nested in parent-child hierarchies. The parentName field identifies an optional parent for each group. If a group has a parent, then the only monitored resources available to be matched by the group's filter are the resources contained in the parent group. In other words, a group contains the monitored resources that match its filter and the filters of all the group's ancestors. A group without a parent can contain any monitored resource.For example, consider an infrastructure running a set of instances with two user-defined tags: "environment" and "role". A parent group has a filter, environment="production". A child of that parent group has a filter, role="transcoder". The parent group contains all instances in the production environment, regardless of their roles. The child group contains instances that have the transcoder role and are in the production environment.The monitored resources contained in a group can change at any moment, depending on what resources exist and what filters are associated with the group and its ancestors.
"filter": "A String", # The filter used to determine which monitored resources belong to this group.
- "parentName": "A String", # The name of the group's parent, if it has one. The format is `"projects/{project_id_or_number}/groups/{group_id}"`. For groups with no parent, `parentName` is the empty string, `""`.
+ "parentName": "A String", # The name of the group's parent, if it has one. The format is "projects/{project_id_or_number}/groups/{group_id}". For groups with no parent, parentName is the empty string, "".
"displayName": "A String", # A user-assigned name for this group, used only for display purposes.
- "name": "A String", # The name of this group. The format is `"projects/{project_id_or_number}/groups/{group_id}"`. When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to `CreateGroup` and a unique `{group_id}` that is generated automatically. @OutputOnly
+ "name": "A String", # Output only. The name of this group. The format is "projects/{project_id_or_number}/groups/{group_id}". When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to CreateGroup and a unique {group_id} that is generated automatically.
"isCluster": True or False, # If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters.
}</pre>
</div>
diff --git a/docs/dyn/monitoring_v3.projects.groups.members.html b/docs/dyn/monitoring_v3.projects.groups.members.html
index 518ca76..75bc86a 100644
--- a/docs/dyn/monitoring_v3.projects.groups.members.html
+++ b/docs/dyn/monitoring_v3.projects.groups.members.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="monitoring_v3.html">Google Monitoring API</a> . <a href="monitoring_v3.projects.html">projects</a> . <a href="monitoring_v3.projects.groups.html">groups</a> . <a href="monitoring_v3.projects.groups.members.html">members</a></h1>
+<h1><a href="monitoring_v3.html">Stackdriver Monitoring API</a> . <a href="monitoring_v3.projects.html">projects</a> . <a href="monitoring_v3.projects.groups.html">groups</a> . <a href="monitoring_v3.projects.groups.members.html">members</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#list">list(name, pageSize=None, x__xgafv=None, pageToken=None, interval_endTime=None, filter=None, interval_startTime=None)</a></code></p>
@@ -86,26 +86,34 @@
<pre>Lists the monitored resources that are members of a group.
Args:
- name: string, The group whose members are listed. The format is `"projects/{project_id_or_number}/groups/{group_id}"`. (required)
+ name: string, The group whose members are listed. The format is "projects/{project_id_or_number}/groups/{group_id}". (required)
pageSize: integer, A positive number that is the maximum number of results to return.
x__xgafv: string, V1 error format.
- pageToken: string, If this field is not empty then it must contain the `nextPageToken` value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.
- interval_endTime: string, Required. The end of the interval. The interval includes this time.
- filter: string, An optional [list filter](/monitoring/api/learn_more#filtering) describing the members to be returned. The filter may reference the type, labels, and metadata of monitored resources that comprise the group. For example, to return only resources representing Compute Engine VM instances, use this filter: resource.type = "gce_instance"
- interval_startTime: string, If this value is omitted, the interval is a point in time, `endTime`. If `startTime` is present, it must be earlier than (less than) `endTime`. The interval begins after `startTime`—it does not include `startTime`.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+ pageToken: string, If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.
+ interval_endTime: string, Required. The end of the time interval.
+ filter: string, An optional list filter (/monitoring/api/learn_more#filtering) describing the members to be returned. The filter may reference the type, labels, and metadata of monitored resources that comprise the group. For example, to return only resources representing Compute Engine VM instances, use this filter:
+resource.type = "gce_instance"
+
+ interval_startTime: string, Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.
Returns:
An object of the form:
- { # The `ListGroupMembers` response.
- "nextPageToken": "A String", # If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as `pageToken` in the next call to this method.
+ { # The ListGroupMembers response.
+ "nextPageToken": "A String", # If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method.
"totalSize": 42, # The total number of elements matching this request.
"members": [ # A set of monitored resources in the group.
- { # An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The `type` field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the `labels` field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for `"gce_instance"` has labels `"instance_id"` and `"zone"`: { "type": "gce_instance", "labels": { "instance_id": "my-instance", "zone": "us-central1-a" }}
- "labels": { # Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Cloud SQL databases use the labels `"database_id"` and `"zone"`.
+ { # An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for "gce_instance" has labels "instance_id" and "zone":
+ # { "type": "gce_instance",
+ # "labels": { "instance_id": "12345678901234",
+ # "zone": "us-central1-a" }}
+ "labels": { # Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Cloud SQL databases use the labels "database_id" and "zone".
"a_key": "A String",
},
- "type": "A String", # Required. The monitored resource type. This field must match the `type` field of a MonitoredResourceDescriptor object. For example, the type of a Cloud SQL database is `"cloudsql_database"`.
+ "type": "A String", # Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Cloud SQL database is "cloudsql_database".
},
],
}</pre>
diff --git a/docs/dyn/monitoring_v3.projects.html b/docs/dyn/monitoring_v3.projects.html
index 91daa10..89d5eee 100644
--- a/docs/dyn/monitoring_v3.projects.html
+++ b/docs/dyn/monitoring_v3.projects.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="monitoring_v3.html">Google Monitoring API</a> . <a href="monitoring_v3.projects.html">projects</a></h1>
+<h1><a href="monitoring_v3.html">Stackdriver Monitoring API</a> . <a href="monitoring_v3.projects.html">projects</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="monitoring_v3.projects.collectdTimeSeries.html">collectdTimeSeries()</a></code>
diff --git a/docs/dyn/monitoring_v3.projects.metricDescriptors.html b/docs/dyn/monitoring_v3.projects.metricDescriptors.html
index 8fb373b..77f812a 100644
--- a/docs/dyn/monitoring_v3.projects.metricDescriptors.html
+++ b/docs/dyn/monitoring_v3.projects.metricDescriptors.html
@@ -72,14 +72,14 @@
</style>
-<h1><a href="monitoring_v3.html">Google Monitoring API</a> . <a href="monitoring_v3.projects.html">projects</a> . <a href="monitoring_v3.projects.metricDescriptors.html">metricDescriptors</a></h1>
+<h1><a href="monitoring_v3.html">Stackdriver Monitoring API</a> . <a href="monitoring_v3.projects.html">projects</a> . <a href="monitoring_v3.projects.metricDescriptors.html">metricDescriptors</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#create">create(name, body, x__xgafv=None)</a></code></p>
-<p class="firstline">Creates a new metric descriptor. User-created metric descriptors define [custom metrics](/monitoring/custom-metrics).</p>
+<p class="firstline">Creates a new metric descriptor. User-created metric descriptors define custom metrics (/monitoring/custom-metrics).</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
-<p class="firstline">Deletes a metric descriptor. Only user-created [custom metrics](/monitoring/custom-metrics) can be deleted.</p>
+<p class="firstline">Deletes a metric descriptor. Only user-created custom metrics (/monitoring/custom-metrics) can be deleted.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a single metric descriptor. This method does not require a Stackdriver account.</p>
@@ -92,65 +92,165 @@
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(name, body, x__xgafv=None)</code>
- <pre>Creates a new metric descriptor. User-created metric descriptors define [custom metrics](/monitoring/custom-metrics).
+ <pre>Creates a new metric descriptor. User-created metric descriptors define custom metrics (/monitoring/custom-metrics).
Args:
- name: string, The project on which to execute the request. The format is `"projects/{project_id_or_number}"`. (required)
+ name: string, The project on which to execute the request. The format is "projects/{project_id_or_number}". (required)
body: object, The request body. (required)
The object takes the form of:
{ # Defines a metric type and its schema.
"displayName": "A String", # A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count".
- "name": "A String", # Resource name. The format of the name may vary between different implementations. For examples: projects/{project_id}/metricDescriptors/{type=**} metricDescriptors/{type=**}
- "metricKind": "A String", # Whether the metric records instantaneous values, changes to a value, etc.
- "valueType": "A String", # Whether the measurement is an integer, a floating-point number, etc.
- "labels": [ # The set of labels that can be used to describe a specific instance of this metric type. For example, the `compute.googleapis.com/instance/network/received_bytes_count` metric type has a label, `loadbalanced`, that specifies whether the traffic was received through a load balanced IP address.
+ "description": "A String", # A detailed description of the metric, which can be used in documentation.
+ "metricKind": "A String", # Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.
+ "valueType": "A String", # Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.
+ "labels": [ # The set of labels that can be used to describe a specific instance of this metric type. For example, the compute.googleapis.com/instance/network/received_bytes_count metric type has a label, loadbalanced, that specifies whether the traffic was received through a load balanced IP address.
{ # A description of a label.
"valueType": "A String", # The type of data that can be assigned to the label.
"description": "A String", # A human-readable description for the label.
"key": "A String", # The label key.
},
],
- "type": "A String", # The metric type including a DNS name prefix, for example `"compute.googleapis.com/instance/cpu/utilization"`. Metric types should use a natural hierarchical grouping such as the following: compute.googleapis.com/instance/cpu/utilization compute.googleapis.com/instance/disk/read_ops_count compute.googleapis.com/instance/network/received_bytes_count Note that if the metric type changes, the monitoring data will be discontinued, and anything depends on it will break, such as monitoring dashboards, alerting rules and quota limits. Therefore, once a metric has been published, its type should be immutable.
- "unit": "A String", # The unit in which the metric value is reported. It is only applicable if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The supported units are a subset of [The Unified Code for Units of Measure](http://unitsofmeasure.org/ucum.html) standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` second * `min` minute * `h` hour * `d` day **Prefixes (PREFIX)** * `k` kilo (10**3) * `M` mega (10**6) * `G` giga (10**9) * `T` tera (10**12) * `P` peta (10**15) * `E` exa (10**18) * `Z` zetta (10**21) * `Y` yotta (10**24) * `m` milli (10**-3) * `u` micro (10**-6) * `n` nano (10**-9) * `p` pico (10**-12) * `f` femto (10**-15) * `a` atto (10**-18) * `z` zepto (10**-21) * `y` yocto (10**-24) * `Ki` kibi (2**10) * `Mi` mebi (2**20) * `Gi` gibi (2**30) * `Ti` tebi (2**40) **Grammar** The grammar includes the dimensionless unit `1`, such as `1/s`. The grammar also includes these connectors: * `/` division (as an infix operator, e.g. `1/s`). * `.` multiplication (as an infix operator, e.g. `GBy.d`) The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = [ PREFIX ] UNIT [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: * `Annotation` is just a comment if it follows a `UNIT` and is equivalent to `1` if it is used alone. For examples, `{requests}/s == 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of non-blank printable ASCII characters not containing '{' or '}'.
- "description": "A String", # A detailed description of the metric, which can be used in documentation.
+ "type": "A String", # The metric type including a DNS name prefix, for example "compute.googleapis.com/instance/cpu/utilization". Metric types should use a natural hierarchical grouping such as the following:
+ # compute.googleapis.com/instance/cpu/utilization
+ # compute.googleapis.com/instance/disk/read_ops_count
+ # compute.googleapis.com/instance/network/received_bytes_count
+ # Note that if the metric type changes, the monitoring data will be discontinued, and anything depends on it will break, such as monitoring dashboards, alerting rules and quota limits. Therefore, once a metric has been published, its type should be immutable.
+ "unit": "A String", # The unit in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The supported units are a subset of The Unified Code for Units of Measure (http://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT)
+ # bit bit
+ # By byte
+ # s second
+ # min minute
+ # h hour
+ # d dayPrefixes (PREFIX)
+ # k kilo (10**3)
+ # M mega (10**6)
+ # G giga (10**9)
+ # T tera (10**12)
+ # P peta (10**15)
+ # E exa (10**18)
+ # Z zetta (10**21)
+ # Y yotta (10**24)
+ # m milli (10**-3)
+ # u micro (10**-6)
+ # n nano (10**-9)
+ # p pico (10**-12)
+ # f femto (10**-15)
+ # a atto (10**-18)
+ # z zepto (10**-21)
+ # y yocto (10**-24)
+ # Ki kibi (2**10)
+ # Mi mebi (2**20)
+ # Gi gibi (2**30)
+ # Ti tebi (2**40)GrammarThe grammar includes the dimensionless unit 1, such as 1/s.The grammar also includes these connectors:
+ # / division (as an infix operator, e.g. 1/s).
+ # . multiplication (as an infix operator, e.g. GBy.d)The grammar for a unit is as follows:
+ # Expression = Component { "." Component } { "/" Component } ;
+ #
+ # Component = [ PREFIX ] UNIT [ Annotation ]
+ # | Annotation
+ # | "1"
+ # ;
+ #
+ # Annotation = "{" NAME "}" ;
+ # Notes:
+ # Annotation is just a comment if it follows a UNIT and is equivalent to 1 if it is used alone. For examples, {requests}/s == 1/s, By{transmitted}/s == By/s.
+ # NAME is a sequence of non-blank printable ASCII characters not containing '{' or '}'.
+ "name": "A String", # Resource name. The format of the name may vary between different implementations. For examples:
+ # projects/{project_id}/metricDescriptors/{type=**}
+ # metricDescriptors/{type=**}
}
x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
{ # Defines a metric type and its schema.
"displayName": "A String", # A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count".
- "name": "A String", # Resource name. The format of the name may vary between different implementations. For examples: projects/{project_id}/metricDescriptors/{type=**} metricDescriptors/{type=**}
- "metricKind": "A String", # Whether the metric records instantaneous values, changes to a value, etc.
- "valueType": "A String", # Whether the measurement is an integer, a floating-point number, etc.
- "labels": [ # The set of labels that can be used to describe a specific instance of this metric type. For example, the `compute.googleapis.com/instance/network/received_bytes_count` metric type has a label, `loadbalanced`, that specifies whether the traffic was received through a load balanced IP address.
+ "description": "A String", # A detailed description of the metric, which can be used in documentation.
+ "metricKind": "A String", # Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.
+ "valueType": "A String", # Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.
+ "labels": [ # The set of labels that can be used to describe a specific instance of this metric type. For example, the compute.googleapis.com/instance/network/received_bytes_count metric type has a label, loadbalanced, that specifies whether the traffic was received through a load balanced IP address.
{ # A description of a label.
"valueType": "A String", # The type of data that can be assigned to the label.
"description": "A String", # A human-readable description for the label.
"key": "A String", # The label key.
},
],
- "type": "A String", # The metric type including a DNS name prefix, for example `"compute.googleapis.com/instance/cpu/utilization"`. Metric types should use a natural hierarchical grouping such as the following: compute.googleapis.com/instance/cpu/utilization compute.googleapis.com/instance/disk/read_ops_count compute.googleapis.com/instance/network/received_bytes_count Note that if the metric type changes, the monitoring data will be discontinued, and anything depends on it will break, such as monitoring dashboards, alerting rules and quota limits. Therefore, once a metric has been published, its type should be immutable.
- "unit": "A String", # The unit in which the metric value is reported. It is only applicable if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The supported units are a subset of [The Unified Code for Units of Measure](http://unitsofmeasure.org/ucum.html) standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` second * `min` minute * `h` hour * `d` day **Prefixes (PREFIX)** * `k` kilo (10**3) * `M` mega (10**6) * `G` giga (10**9) * `T` tera (10**12) * `P` peta (10**15) * `E` exa (10**18) * `Z` zetta (10**21) * `Y` yotta (10**24) * `m` milli (10**-3) * `u` micro (10**-6) * `n` nano (10**-9) * `p` pico (10**-12) * `f` femto (10**-15) * `a` atto (10**-18) * `z` zepto (10**-21) * `y` yocto (10**-24) * `Ki` kibi (2**10) * `Mi` mebi (2**20) * `Gi` gibi (2**30) * `Ti` tebi (2**40) **Grammar** The grammar includes the dimensionless unit `1`, such as `1/s`. The grammar also includes these connectors: * `/` division (as an infix operator, e.g. `1/s`). * `.` multiplication (as an infix operator, e.g. `GBy.d`) The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = [ PREFIX ] UNIT [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: * `Annotation` is just a comment if it follows a `UNIT` and is equivalent to `1` if it is used alone. For examples, `{requests}/s == 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of non-blank printable ASCII characters not containing '{' or '}'.
- "description": "A String", # A detailed description of the metric, which can be used in documentation.
+ "type": "A String", # The metric type including a DNS name prefix, for example "compute.googleapis.com/instance/cpu/utilization". Metric types should use a natural hierarchical grouping such as the following:
+ # compute.googleapis.com/instance/cpu/utilization
+ # compute.googleapis.com/instance/disk/read_ops_count
+ # compute.googleapis.com/instance/network/received_bytes_count
+ # Note that if the metric type changes, the monitoring data will be discontinued, and anything depends on it will break, such as monitoring dashboards, alerting rules and quota limits. Therefore, once a metric has been published, its type should be immutable.
+ "unit": "A String", # The unit in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The supported units are a subset of The Unified Code for Units of Measure (http://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT)
+ # bit bit
+ # By byte
+ # s second
+ # min minute
+ # h hour
+ # d dayPrefixes (PREFIX)
+ # k kilo (10**3)
+ # M mega (10**6)
+ # G giga (10**9)
+ # T tera (10**12)
+ # P peta (10**15)
+ # E exa (10**18)
+ # Z zetta (10**21)
+ # Y yotta (10**24)
+ # m milli (10**-3)
+ # u micro (10**-6)
+ # n nano (10**-9)
+ # p pico (10**-12)
+ # f femto (10**-15)
+ # a atto (10**-18)
+ # z zepto (10**-21)
+ # y yocto (10**-24)
+ # Ki kibi (2**10)
+ # Mi mebi (2**20)
+ # Gi gibi (2**30)
+ # Ti tebi (2**40)GrammarThe grammar includes the dimensionless unit 1, such as 1/s.The grammar also includes these connectors:
+ # / division (as an infix operator, e.g. 1/s).
+ # . multiplication (as an infix operator, e.g. GBy.d)The grammar for a unit is as follows:
+ # Expression = Component { "." Component } { "/" Component } ;
+ #
+ # Component = [ PREFIX ] UNIT [ Annotation ]
+ # | Annotation
+ # | "1"
+ # ;
+ #
+ # Annotation = "{" NAME "}" ;
+ # Notes:
+ # Annotation is just a comment if it follows a UNIT and is equivalent to 1 if it is used alone. For examples, {requests}/s == 1/s, By{transmitted}/s == By/s.
+ # NAME is a sequence of non-blank printable ASCII characters not containing '{' or '}'.
+ "name": "A String", # Resource name. The format of the name may vary between different implementations. For examples:
+ # projects/{project_id}/metricDescriptors/{type=**}
+ # metricDescriptors/{type=**}
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
- <pre>Deletes a metric descriptor. Only user-created [custom metrics](/monitoring/custom-metrics) can be deleted.
+ <pre>Deletes a metric descriptor. Only user-created custom metrics (/monitoring/custom-metrics) can be deleted.
Args:
- name: string, The metric descriptor on which to execute the request. The format is `"projects/{project_id_or_number}/metricDescriptors/{metric_id}"`. An example of `{metric_id}` is: `"custom.googleapis.com/my_test_metric"`. (required)
+ name: string, The metric descriptor on which to execute the request. The format is "projects/{project_id_or_number}/metricDescriptors/{metric_id}". An example of {metric_id} is: "custom.googleapis.com/my_test_metric". (required)
x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
- { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:
+ # service Foo {
+ # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
+ # }
+ # The JSON representation for Empty is empty JSON object {}.
}</pre>
</div>
@@ -159,27 +259,75 @@
<pre>Gets a single metric descriptor. This method does not require a Stackdriver account.
Args:
- name: string, The metric descriptor on which to execute the request. The format is `"projects/{project_id_or_number}/metricDescriptors/{metric_id}"`. An example value of `{metric_id}` is `"compute.googleapis.com/instance/disk/read_bytes_count"`. (required)
+ name: string, The metric descriptor on which to execute the request. The format is "projects/{project_id_or_number}/metricDescriptors/{metric_id}". An example value of {metric_id} is "compute.googleapis.com/instance/disk/read_bytes_count". (required)
x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
{ # Defines a metric type and its schema.
"displayName": "A String", # A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count".
- "name": "A String", # Resource name. The format of the name may vary between different implementations. For examples: projects/{project_id}/metricDescriptors/{type=**} metricDescriptors/{type=**}
- "metricKind": "A String", # Whether the metric records instantaneous values, changes to a value, etc.
- "valueType": "A String", # Whether the measurement is an integer, a floating-point number, etc.
- "labels": [ # The set of labels that can be used to describe a specific instance of this metric type. For example, the `compute.googleapis.com/instance/network/received_bytes_count` metric type has a label, `loadbalanced`, that specifies whether the traffic was received through a load balanced IP address.
+ "description": "A String", # A detailed description of the metric, which can be used in documentation.
+ "metricKind": "A String", # Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.
+ "valueType": "A String", # Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.
+ "labels": [ # The set of labels that can be used to describe a specific instance of this metric type. For example, the compute.googleapis.com/instance/network/received_bytes_count metric type has a label, loadbalanced, that specifies whether the traffic was received through a load balanced IP address.
{ # A description of a label.
"valueType": "A String", # The type of data that can be assigned to the label.
"description": "A String", # A human-readable description for the label.
"key": "A String", # The label key.
},
],
- "type": "A String", # The metric type including a DNS name prefix, for example `"compute.googleapis.com/instance/cpu/utilization"`. Metric types should use a natural hierarchical grouping such as the following: compute.googleapis.com/instance/cpu/utilization compute.googleapis.com/instance/disk/read_ops_count compute.googleapis.com/instance/network/received_bytes_count Note that if the metric type changes, the monitoring data will be discontinued, and anything depends on it will break, such as monitoring dashboards, alerting rules and quota limits. Therefore, once a metric has been published, its type should be immutable.
- "unit": "A String", # The unit in which the metric value is reported. It is only applicable if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The supported units are a subset of [The Unified Code for Units of Measure](http://unitsofmeasure.org/ucum.html) standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` second * `min` minute * `h` hour * `d` day **Prefixes (PREFIX)** * `k` kilo (10**3) * `M` mega (10**6) * `G` giga (10**9) * `T` tera (10**12) * `P` peta (10**15) * `E` exa (10**18) * `Z` zetta (10**21) * `Y` yotta (10**24) * `m` milli (10**-3) * `u` micro (10**-6) * `n` nano (10**-9) * `p` pico (10**-12) * `f` femto (10**-15) * `a` atto (10**-18) * `z` zepto (10**-21) * `y` yocto (10**-24) * `Ki` kibi (2**10) * `Mi` mebi (2**20) * `Gi` gibi (2**30) * `Ti` tebi (2**40) **Grammar** The grammar includes the dimensionless unit `1`, such as `1/s`. The grammar also includes these connectors: * `/` division (as an infix operator, e.g. `1/s`). * `.` multiplication (as an infix operator, e.g. `GBy.d`) The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = [ PREFIX ] UNIT [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: * `Annotation` is just a comment if it follows a `UNIT` and is equivalent to `1` if it is used alone. For examples, `{requests}/s == 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of non-blank printable ASCII characters not containing '{' or '}'.
- "description": "A String", # A detailed description of the metric, which can be used in documentation.
+ "type": "A String", # The metric type including a DNS name prefix, for example "compute.googleapis.com/instance/cpu/utilization". Metric types should use a natural hierarchical grouping such as the following:
+ # compute.googleapis.com/instance/cpu/utilization
+ # compute.googleapis.com/instance/disk/read_ops_count
+ # compute.googleapis.com/instance/network/received_bytes_count
+ # Note that if the metric type changes, the monitoring data will be discontinued, and anything depends on it will break, such as monitoring dashboards, alerting rules and quota limits. Therefore, once a metric has been published, its type should be immutable.
+ "unit": "A String", # The unit in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The supported units are a subset of The Unified Code for Units of Measure (http://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT)
+ # bit bit
+ # By byte
+ # s second
+ # min minute
+ # h hour
+ # d dayPrefixes (PREFIX)
+ # k kilo (10**3)
+ # M mega (10**6)
+ # G giga (10**9)
+ # T tera (10**12)
+ # P peta (10**15)
+ # E exa (10**18)
+ # Z zetta (10**21)
+ # Y yotta (10**24)
+ # m milli (10**-3)
+ # u micro (10**-6)
+ # n nano (10**-9)
+ # p pico (10**-12)
+ # f femto (10**-15)
+ # a atto (10**-18)
+ # z zepto (10**-21)
+ # y yocto (10**-24)
+ # Ki kibi (2**10)
+ # Mi mebi (2**20)
+ # Gi gibi (2**30)
+ # Ti tebi (2**40)GrammarThe grammar includes the dimensionless unit 1, such as 1/s.The grammar also includes these connectors:
+ # / division (as an infix operator, e.g. 1/s).
+ # . multiplication (as an infix operator, e.g. GBy.d)The grammar for a unit is as follows:
+ # Expression = Component { "." Component } { "/" Component } ;
+ #
+ # Component = [ PREFIX ] UNIT [ Annotation ]
+ # | Annotation
+ # | "1"
+ # ;
+ #
+ # Annotation = "{" NAME "}" ;
+ # Notes:
+ # Annotation is just a comment if it follows a UNIT and is equivalent to 1 if it is used alone. For examples, {requests}/s == 1/s, By{transmitted}/s == By/s.
+ # NAME is a sequence of non-blank printable ASCII characters not containing '{' or '}'.
+ "name": "A String", # Resource name. The format of the name may vary between different implementations. For examples:
+ # projects/{project_id}/metricDescriptors/{type=**}
+ # metricDescriptors/{type=**}
}</pre>
</div>
@@ -188,33 +336,83 @@
<pre>Lists metric descriptors that match a filter. This method does not require a Stackdriver account.
Args:
- name: string, The project on which to execute the request. The format is `"projects/{project_id_or_number}"`. (required)
+ name: string, The project on which to execute the request. The format is "projects/{project_id_or_number}". (required)
pageSize: integer, A positive number that is the maximum number of results to return.
- filter: string, If this field is empty, all custom and system-defined metric descriptors are returned. Otherwise, the [filter](/monitoring/api/v3/filters) specifies which metric descriptors are to be returned. For example, the following filter matches all [custom metrics](/monitoring/custom-metrics): metric.type = starts_with("custom.googleapis.com/")
- pageToken: string, If this field is not empty then it must contain the `nextPageToken` value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.
+ filter: string, If this field is empty, all custom and system-defined metric descriptors are returned. Otherwise, the filter (/monitoring/api/v3/filters) specifies which metric descriptors are to be returned. For example, the following filter matches all custom metrics (/monitoring/custom-metrics):
+metric.type = starts_with("custom.googleapis.com/")
+
+ pageToken: string, If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.
x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
- { # The `ListMetricDescriptors` response.
- "nextPageToken": "A String", # If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as `pageToken` in the next call to this method.
- "metricDescriptors": [ # The metric descriptors that are available to the project and that match the value of `filter`, if present.
+ { # The ListMetricDescriptors response.
+ "nextPageToken": "A String", # If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method.
+ "metricDescriptors": [ # The metric descriptors that are available to the project and that match the value of filter, if present.
{ # Defines a metric type and its schema.
"displayName": "A String", # A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count".
- "name": "A String", # Resource name. The format of the name may vary between different implementations. For examples: projects/{project_id}/metricDescriptors/{type=**} metricDescriptors/{type=**}
- "metricKind": "A String", # Whether the metric records instantaneous values, changes to a value, etc.
- "valueType": "A String", # Whether the measurement is an integer, a floating-point number, etc.
- "labels": [ # The set of labels that can be used to describe a specific instance of this metric type. For example, the `compute.googleapis.com/instance/network/received_bytes_count` metric type has a label, `loadbalanced`, that specifies whether the traffic was received through a load balanced IP address.
+ "description": "A String", # A detailed description of the metric, which can be used in documentation.
+ "metricKind": "A String", # Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.
+ "valueType": "A String", # Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.
+ "labels": [ # The set of labels that can be used to describe a specific instance of this metric type. For example, the compute.googleapis.com/instance/network/received_bytes_count metric type has a label, loadbalanced, that specifies whether the traffic was received through a load balanced IP address.
{ # A description of a label.
"valueType": "A String", # The type of data that can be assigned to the label.
"description": "A String", # A human-readable description for the label.
"key": "A String", # The label key.
},
],
- "type": "A String", # The metric type including a DNS name prefix, for example `"compute.googleapis.com/instance/cpu/utilization"`. Metric types should use a natural hierarchical grouping such as the following: compute.googleapis.com/instance/cpu/utilization compute.googleapis.com/instance/disk/read_ops_count compute.googleapis.com/instance/network/received_bytes_count Note that if the metric type changes, the monitoring data will be discontinued, and anything depends on it will break, such as monitoring dashboards, alerting rules and quota limits. Therefore, once a metric has been published, its type should be immutable.
- "unit": "A String", # The unit in which the metric value is reported. It is only applicable if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The supported units are a subset of [The Unified Code for Units of Measure](http://unitsofmeasure.org/ucum.html) standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` second * `min` minute * `h` hour * `d` day **Prefixes (PREFIX)** * `k` kilo (10**3) * `M` mega (10**6) * `G` giga (10**9) * `T` tera (10**12) * `P` peta (10**15) * `E` exa (10**18) * `Z` zetta (10**21) * `Y` yotta (10**24) * `m` milli (10**-3) * `u` micro (10**-6) * `n` nano (10**-9) * `p` pico (10**-12) * `f` femto (10**-15) * `a` atto (10**-18) * `z` zepto (10**-21) * `y` yocto (10**-24) * `Ki` kibi (2**10) * `Mi` mebi (2**20) * `Gi` gibi (2**30) * `Ti` tebi (2**40) **Grammar** The grammar includes the dimensionless unit `1`, such as `1/s`. The grammar also includes these connectors: * `/` division (as an infix operator, e.g. `1/s`). * `.` multiplication (as an infix operator, e.g. `GBy.d`) The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = [ PREFIX ] UNIT [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: * `Annotation` is just a comment if it follows a `UNIT` and is equivalent to `1` if it is used alone. For examples, `{requests}/s == 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of non-blank printable ASCII characters not containing '{' or '}'.
- "description": "A String", # A detailed description of the metric, which can be used in documentation.
+ "type": "A String", # The metric type including a DNS name prefix, for example "compute.googleapis.com/instance/cpu/utilization". Metric types should use a natural hierarchical grouping such as the following:
+ # compute.googleapis.com/instance/cpu/utilization
+ # compute.googleapis.com/instance/disk/read_ops_count
+ # compute.googleapis.com/instance/network/received_bytes_count
+ # Note that if the metric type changes, the monitoring data will be discontinued, and anything depends on it will break, such as monitoring dashboards, alerting rules and quota limits. Therefore, once a metric has been published, its type should be immutable.
+ "unit": "A String", # The unit in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The supported units are a subset of The Unified Code for Units of Measure (http://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT)
+ # bit bit
+ # By byte
+ # s second
+ # min minute
+ # h hour
+ # d dayPrefixes (PREFIX)
+ # k kilo (10**3)
+ # M mega (10**6)
+ # G giga (10**9)
+ # T tera (10**12)
+ # P peta (10**15)
+ # E exa (10**18)
+ # Z zetta (10**21)
+ # Y yotta (10**24)
+ # m milli (10**-3)
+ # u micro (10**-6)
+ # n nano (10**-9)
+ # p pico (10**-12)
+ # f femto (10**-15)
+ # a atto (10**-18)
+ # z zepto (10**-21)
+ # y yocto (10**-24)
+ # Ki kibi (2**10)
+ # Mi mebi (2**20)
+ # Gi gibi (2**30)
+ # Ti tebi (2**40)GrammarThe grammar includes the dimensionless unit 1, such as 1/s.The grammar also includes these connectors:
+ # / division (as an infix operator, e.g. 1/s).
+ # . multiplication (as an infix operator, e.g. GBy.d)The grammar for a unit is as follows:
+ # Expression = Component { "." Component } { "/" Component } ;
+ #
+ # Component = [ PREFIX ] UNIT [ Annotation ]
+ # | Annotation
+ # | "1"
+ # ;
+ #
+ # Annotation = "{" NAME "}" ;
+ # Notes:
+ # Annotation is just a comment if it follows a UNIT and is equivalent to 1 if it is used alone. For examples, {requests}/s == 1/s, By{transmitted}/s == By/s.
+ # NAME is a sequence of non-blank printable ASCII characters not containing '{' or '}'.
+ "name": "A String", # Resource name. The format of the name may vary between different implementations. For examples:
+ # projects/{project_id}/metricDescriptors/{type=**}
+ # metricDescriptors/{type=**}
},
],
}</pre>
diff --git a/docs/dyn/monitoring_v3.projects.monitoredResourceDescriptors.html b/docs/dyn/monitoring_v3.projects.monitoredResourceDescriptors.html
index 3738462..6779a79 100644
--- a/docs/dyn/monitoring_v3.projects.monitoredResourceDescriptors.html
+++ b/docs/dyn/monitoring_v3.projects.monitoredResourceDescriptors.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="monitoring_v3.html">Google Monitoring API</a> . <a href="monitoring_v3.projects.html">projects</a> . <a href="monitoring_v3.projects.monitoredResourceDescriptors.html">monitoredResourceDescriptors</a></h1>
+<h1><a href="monitoring_v3.html">Stackdriver Monitoring API</a> . <a href="monitoring_v3.projects.html">projects</a> . <a href="monitoring_v3.projects.monitoredResourceDescriptors.html">monitoredResourceDescriptors</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
@@ -89,24 +89,27 @@
<pre>Gets a single monitored resource descriptor. This method does not require a Stackdriver account.
Args:
- name: string, The monitored resource descriptor to get. The format is `"projects/{project_id_or_number}/monitoredResourceDescriptors/{resource_type}"`. The `{resource_type}` is a predefined type, such as `cloudsql_database`. (required)
+ name: string, The monitored resource descriptor to get. The format is "projects/{project_id_or_number}/monitoredResourceDescriptors/{resource_type}". The {resource_type} is a predefined type, such as cloudsql_database. (required)
x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
- { # An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of `"gce_instance"` and specifies the use of the labels `"instance_id"` and `"zone"` to identify particular VM instances. Different APIs can support different monitored resource types. APIs generally provide a `list` method that returns the monitored resource descriptors used by the API.
- "displayName": "A String", # Optional. A concise name for the monitored resource type that might be displayed in user interfaces. For example, `"Google Cloud SQL Database"`.
- "labels": [ # Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels `"database_id"` and `"zone"`.
+ { # An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of "gce_instance" and specifies the use of the labels "instance_id" and "zone" to identify particular VM instances.Different APIs can support different monitored resource types. APIs generally provide a list method that returns the monitored resource descriptors used by the API.
+ "type": "A String", # Required. The monitored resource type. For example, the type "cloudsql_database" represents databases in Google Cloud SQL. The maximum length of this value is 256 characters.
+ "labels": [ # Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels "database_id" and "zone".
{ # A description of a label.
"valueType": "A String", # The type of data that can be assigned to the label.
"description": "A String", # A human-readable description for the label.
"key": "A String", # The label key.
},
],
- "type": "A String", # Required. The monitored resource type. For example, the type `"cloudsql_database"` represents databases in Google Cloud SQL.
- "name": "A String", # Optional. The resource name of the monitored resource descriptor: `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where {type} is the value of the `type` field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format `"monitoredResourceDescriptors/{type}"`.
+ "displayName": "A String", # Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, "Google Cloud SQL Database".
"description": "A String", # Optional. A detailed description of the monitored resource type that might be used in documentation.
+ "name": "A String", # Optional. The resource name of the monitored resource descriptor: "projects/{project_id}/monitoredResourceDescriptors/{type}" where {type} is the value of the type field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format "monitoredResourceDescriptors/{type}".
}</pre>
</div>
@@ -115,30 +118,35 @@
<pre>Lists monitored resource descriptors that match a filter. This method does not require a Stackdriver account.
Args:
- name: string, The project on which to execute the request. The format is `"projects/{project_id_or_number}"`. (required)
+ name: string, The project on which to execute the request. The format is "projects/{project_id_or_number}". (required)
pageSize: integer, A positive number that is the maximum number of results to return.
- filter: string, An optional [filter](/monitoring/api/v3/filters) describing the descriptors to be returned. The filter can reference the descriptor's type and labels. For example, the following filter returns only Google Compute Engine descriptors that have an `id` label: resource.type = starts_with("gce_") AND resource.label:id
- pageToken: string, If this field is not empty then it must contain the `nextPageToken` value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.
+ filter: string, An optional filter (/monitoring/api/v3/filters) describing the descriptors to be returned. The filter can reference the descriptor's type and labels. For example, the following filter returns only Google Compute Engine descriptors that have an id label:
+resource.type = starts_with("gce_") AND resource.label:id
+
+ pageToken: string, If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.
x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
- { # The `ListMonitoredResourcDescriptors` response.
- "nextPageToken": "A String", # If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as `pageToken` in the next call to this method.
- "resourceDescriptors": [ # The monitored resource descriptors that are available to this project and that match `filter`, if present.
- { # An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of `"gce_instance"` and specifies the use of the labels `"instance_id"` and `"zone"` to identify particular VM instances. Different APIs can support different monitored resource types. APIs generally provide a `list` method that returns the monitored resource descriptors used by the API.
- "displayName": "A String", # Optional. A concise name for the monitored resource type that might be displayed in user interfaces. For example, `"Google Cloud SQL Database"`.
- "labels": [ # Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels `"database_id"` and `"zone"`.
+ { # The ListMonitoredResourcDescriptors response.
+ "nextPageToken": "A String", # If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method.
+ "resourceDescriptors": [ # The monitored resource descriptors that are available to this project and that match filter, if present.
+ { # An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of "gce_instance" and specifies the use of the labels "instance_id" and "zone" to identify particular VM instances.Different APIs can support different monitored resource types. APIs generally provide a list method that returns the monitored resource descriptors used by the API.
+ "type": "A String", # Required. The monitored resource type. For example, the type "cloudsql_database" represents databases in Google Cloud SQL. The maximum length of this value is 256 characters.
+ "labels": [ # Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels "database_id" and "zone".
{ # A description of a label.
"valueType": "A String", # The type of data that can be assigned to the label.
"description": "A String", # A human-readable description for the label.
"key": "A String", # The label key.
},
],
- "type": "A String", # Required. The monitored resource type. For example, the type `"cloudsql_database"` represents databases in Google Cloud SQL.
- "name": "A String", # Optional. The resource name of the monitored resource descriptor: `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where {type} is the value of the `type` field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format `"monitoredResourceDescriptors/{type}"`.
+ "displayName": "A String", # Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, "Google Cloud SQL Database".
"description": "A String", # Optional. A detailed description of the monitored resource type that might be used in documentation.
+ "name": "A String", # Optional. The resource name of the monitored resource descriptor: "projects/{project_id}/monitoredResourceDescriptors/{type}" where {type} is the value of the type field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format "monitoredResourceDescriptors/{type}".
},
],
}</pre>
diff --git a/docs/dyn/monitoring_v3.projects.timeSeries.html b/docs/dyn/monitoring_v3.projects.timeSeries.html
index 8c5a729..db01ac0 100644
--- a/docs/dyn/monitoring_v3.projects.timeSeries.html
+++ b/docs/dyn/monitoring_v3.projects.timeSeries.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="monitoring_v3.html">Google Monitoring API</a> . <a href="monitoring_v3.projects.html">projects</a> . <a href="monitoring_v3.projects.timeSeries.html">timeSeries</a></h1>
+<h1><a href="monitoring_v3.html">Stackdriver Monitoring API</a> . <a href="monitoring_v3.projects.html">projects</a> . <a href="monitoring_v3.projects.timeSeries.html">timeSeries</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#create">create(name, body, x__xgafv=None)</a></code></p>
@@ -89,80 +89,92 @@
<pre>Creates or adds data to one or more time series. The response is empty if all time series in the request were written. If any time series could not be written, a corresponding failure message is included in the error response.
Args:
- name: string, The project on which to execute the request. The format is `"projects/{project_id_or_number}"`. (required)
+ name: string, The project on which to execute the request. The format is "projects/{project_id_or_number}". (required)
body: object, The request body. (required)
The object takes the form of:
-{ # The `CreateTimeSeries` request.
- "timeSeries": [ # The new data to be added to a list of time series. Adds at most one data point to each of several time series. The new data point must be more recent than any other point in its time series. Each `TimeSeries` value must fully specify a unique time series by supplying all label values for the metric and the monitored resource.
- { # A collection of data points that describes the time-varying nature of a metric. A time series is identified by a combination of a fully-specified monitored resource and a fully-specified metric.
- "metricKind": "A String", # The metric kind of the time series. This can be different than the metric kind specified in [google.api.MetricDescriptor] because of alignment and reduction operations on the data. This field is ignored when writing data; the value specified in the descriptor is used instead. @OutputOnly
- "metric": { # A specific metric identified by specifying values for all of the labels of a `MetricDescriptor`. # The fully-specified metric used to identify the time series.
- "labels": { # The set of labels that uniquely identify a metric. To specify a metric, all labels enumerated in the `MetricDescriptor` must be assigned values.
+{ # The CreateTimeSeries request.
+ "timeSeries": [ # The new data to be added to a list of time series. Adds at most one data point to each of several time series. The new data point must be more recent than any other point in its time series. Each TimeSeries value must fully specify a unique time series by supplying all label values for the metric and the monitored resource.
+ { # A collection of data points that describes the time-varying values of a metric. A time series is identified by a combination of a fully-specified monitored resource and a fully-specified metric. This type is used for both listing and creating time series.
+ "metricKind": "A String", # The metric kind of the time series. When listing time series, this metric kind might be different from the metric kind of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the metric kind of the associated metric. If the associated metric's descriptor must be auto-created, then this field specifies the metric kind of the new descriptor and must be either GAUGE (the default) or CUMULATIVE.
+ "metric": { # A specific metric identified by specifying values for all of the labels of a MetricDescriptor. # The associated metric. A fully-specified metric used to identify the time series.
+ "labels": { # The set of labels that uniquely identify a metric. To specify a metric, all labels enumerated in the MetricDescriptor must be assigned values.
"a_key": "A String",
},
- "type": "A String", # An existing metric type, see google.api.MetricDescriptor. For example, `compute.googleapis.com/instance/cpu/usage_time`.
+ "type": "A String", # An existing metric type, see google.api.MetricDescriptor. For example, compute.googleapis.com/instance/cpu/usage_time.
},
- "points": [ # The data points of this time series. When used as output, points will be sorted by decreasing time order. When used as input, points could be written in any orders.
+ "points": [ # The data points of this time series. When listing time series, the order of the points is specified by the list method.When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be BOOL, INT64, DOUBLE, or DISTRIBUTION.
{ # A single data point in a time series.
- "interval": { # A time interval extending from after `startTime` through `endTime`. If `startTime` is omitted, the interval is the single point in time, `endTime`. # The time interval to which the value applies.
- "endTime": "A String", # Required. The end of the interval. The interval includes this time.
- "startTime": "A String", # If this value is omitted, the interval is a point in time, `endTime`. If `startTime` is present, it must be earlier than (less than) `endTime`. The interval begins after `startTime`—it does not include `startTime`.
+ "interval": { # A time interval extending just after a start time through an end time. If the start time is the same as the end time, then the interval represents a single point in time. # The time interval to which the data point applies. For GAUGE metrics, only the end time of the interval is used. For DELTA metrics, the start and end time should specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For CUMULATIVE metrics, the start and end time should specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points.
+ "endTime": "A String", # Required. The end of the time interval.
+ "startTime": "A String", # Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.
},
"value": { # A single strongly-typed value. # The value of the data point.
- "distributionValue": { # Distribution contains summary statistics for a population of values and, optionally, a histogram representing the distribution of those values across a specified set of histogram buckets. The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values. The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by specifying parameters for a method of computing them (buckets of fixed width or buckets of exponentially increasing width). Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the `mean` and `sum_of_squared_deviation` fields meaningless. # A distribution value.
+ "distributionValue": { # Distribution contains summary statistics for a population of values and, optionally, a histogram representing the distribution of those values across a specified set of histogram buckets.The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values.The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by specifying parameters for a method of computing them (buckets of fixed width or buckets of exponentially increasing width).Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the mean and sum_of_squared_deviation fields meaningless. # A distribution value.
"count": "A String", # The number of values in the population. Must be non-negative.
- "bucketCounts": [ # If `bucket_options` is given, then the sum of the values in `bucket_counts` must equal the value in `count`. If `bucket_options` is not given, no `bucket_counts` fields may be given. Bucket counts are given in order under the numbering scheme described above (the underflow bucket has number 0; the finite buckets, if any, have numbers 1 through N-2; the overflow bucket has number N-1). The size of `bucket_counts` must be no greater than N as defined in `bucket_options`. Any suffix of trailing zero bucket_count fields may be omitted.
+ "bucketCounts": [ # If bucket_options is given, then the sum of the values in bucket_counts must equal the value in count. If bucket_options is not given, no bucket_counts fields may be given.Bucket counts are given in order under the numbering scheme described above (the underflow bucket has number 0; the finite buckets, if any, have numbers 1 through N-2; the overflow bucket has number N-1).The size of bucket_counts must be no greater than N as defined in bucket_options.Any suffix of trailing zero bucket_count fields may be omitted.
"A String",
],
- "bucketOptions": { # A Distribution may optionally contain a histogram of the values in the population. The histogram is given in `bucket_counts` as counts of values that fall into one of a sequence of non-overlapping buckets. The sequence of buckets is described by `bucket_options`. A bucket specifies an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket is strictly greater than the lower bound. The sequence of N buckets for a Distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite. `BucketOptions` describes bucket boundaries in one of three ways. Two describe the boundaries by giving parameters for a formula to generate boundaries and one gives the bucket boundaries explicitly. If `bucket_boundaries` is not given, then no `bucket_counts` may be given. # Defines the histogram bucket boundaries.
- "exponentialBuckets": { # Specify a sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket. Defines `num_finite_buckets + 2` (= N) buckets with these boundaries for bucket i: Upper bound (0 <= i < N-1): scale * (growth_factor ^ i). Lower bound (1 <= i < N): scale * (growth_factor ^ (i - 1)). # The exponential buckets.
- "scale": 3.14, # Must be greater than 0
- "growthFactor": 3.14, # Must be greater than 1
- "numFiniteBuckets": 42, # must be greater than 0
+ "bucketOptions": { # A Distribution may optionally contain a histogram of the values in the population. The histogram is given in bucket_counts as counts of values that fall into one of a sequence of non-overlapping buckets. The sequence of buckets is described by bucket_options.A bucket specifies an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket is strictly greater than the lower bound.The sequence of N buckets for a Distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite.BucketOptions describes bucket boundaries in one of three ways. Two describe the boundaries by giving parameters for a formula to generate boundaries and one gives the bucket boundaries explicitly.If bucket_options is not given, then no bucket_counts may be given. # Defines the histogram bucket boundaries.
+ "exponentialBuckets": { # Specify a sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket.Defines num_finite_buckets + 2 (= N) buckets with these boundaries for bucket i:Upper bound (0 <= i < N-1): scale * (growth_factor ^ i). Lower bound (1 <= i < N): scale * (growth_factor ^ (i - 1)). # The exponential buckets.
+ "scale": 3.14, # Must be greater than 0.
+ "growthFactor": 3.14, # Must be greater than 1.
+ "numFiniteBuckets": 42, # Must be greater than 0.
},
- "linearBuckets": { # Specify a sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket. Defines `num_finite_buckets + 2` (= N) buckets with these boundaries for bucket `i`: Upper bound (0 <= i < N-1): offset + (width * i). Lower bound (1 <= i < N): offset + (width * (i - 1)). # The linear bucket.
+ "linearBuckets": { # Specify a sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket.Defines num_finite_buckets + 2 (= N) buckets with these boundaries for bucket i:Upper bound (0 <= i < N-1): offset + (width * i). Lower bound (1 <= i < N): offset + (width * (i - 1)). # The linear bucket.
"width": 3.14, # Must be greater than 0.
"numFiniteBuckets": 42, # Must be greater than 0.
"offset": 3.14, # Lower bound of the first bucket.
},
- "explicitBuckets": { # A set of buckets with arbitrary widths. Defines `size(bounds) + 1` (= N) buckets with these boundaries for bucket i: Upper bound (0 <= i < N-1): bounds[i] Lower bound (1 <= i < N); bounds[i - 1] There must be at least one element in `bounds`. If `bounds` has only one element, there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets. # The explicit buckets.
+ "explicitBuckets": { # A set of buckets with arbitrary widths.Defines size(bounds) + 1 (= N) buckets with these boundaries for bucket i:Upper bound (0 <= i < N-1): boundsi Lower bound (1 <= i < N); boundsi - 1There must be at least one element in bounds. If bounds has only one element, there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets. # The explicit buckets.
"bounds": [ # The values must be monotonically increasing.
3.14,
],
},
},
- "range": { # The range of the population values. # If specified, contains the range of the population values. The field must not be present if the `count` is zero.
+ "range": { # The range of the population values. # If specified, contains the range of the population values. The field must not be present if the count is zero. This field is presently ignored by the Stackdriver Monitoring API v3.
"max": 3.14, # The maximum of the population values.
"min": 3.14, # The minimum of the population values.
},
- "sumOfSquaredDeviation": 3.14, # The sum of squared deviations from the mean of the values in the population. For values x_i this is: Sum[i=1..n]((x_i - mean)^2) Knuth, "The Art of Computer Programming", Vol. 2, page 323, 3rd edition describes Welford's method for accumulating this sum in one pass. If `count` is zero then this field must be zero.
- "mean": 3.14, # The arithmetic mean of the values in the population. If `count` is zero then this field must be zero.
+ "sumOfSquaredDeviation": 3.14, # The sum of squared deviations from the mean of the values in the population. For values x_i this is:
+ # Sum[i=1..n]((x_i - mean)^2)
+ # Knuth, "The Art of Computer Programming", Vol. 2, page 323, 3rd edition describes Welford's method for accumulating this sum in one pass.If count is zero then this field must be zero.
+ "mean": 3.14, # The arithmetic mean of the values in the population. If count is zero then this field must be zero.
},
"stringValue": "A String", # A variable-length string value.
- "boolValue": True or False, # A Boolean value: `true` or `false`.
- "int64Value": "A String", # A 64-bit integer. Its range is approximately ±9.2x1018.
- "doubleValue": 3.14, # A 64-bit double-precision floating-point number. Its magnitude is approximately ±10±300 and it has 16 significant digits of precision.
+ "boolValue": True or False, # A Boolean value: true or false.
+ "int64Value": "A String", # A 64-bit integer. Its range is approximately ±9.2x10<sup>18</sup>.
+ "doubleValue": 3.14, # A 64-bit double-precision floating-point number. Its magnitude is approximately ±10<sup>±300</sup> and it has 16 significant digits of precision.
},
},
],
- "resource": { # An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The `type` field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the `labels` field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for `"gce_instance"` has labels `"instance_id"` and `"zone"`: { "type": "gce_instance", "labels": { "instance_id": "my-instance", "zone": "us-central1-a" }} # The fully-specified monitored resource used to identify the time series.
- "labels": { # Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Cloud SQL databases use the labels `"database_id"` and `"zone"`.
+ "resource": { # An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for "gce_instance" has labels "instance_id" and "zone": # The associated resource. A fully-specified monitored resource used to identify the time series.
+ # { "type": "gce_instance",
+ # "labels": { "instance_id": "12345678901234",
+ # "zone": "us-central1-a" }}
+ "labels": { # Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Cloud SQL databases use the labels "database_id" and "zone".
"a_key": "A String",
},
- "type": "A String", # Required. The monitored resource type. This field must match the `type` field of a MonitoredResourceDescriptor object. For example, the type of a Cloud SQL database is `"cloudsql_database"`.
+ "type": "A String", # Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Cloud SQL database is "cloudsql_database".
},
- "valueType": "A String", # The value type of the time series. This can be different than the value type specified in [google.api.MetricDescriptor] because of alignment and reduction operations on the data. This field is ignored when writing data; the value specified in the descriptor is used instead. @OutputOnly
+ "valueType": "A String", # The value type of the time series. When listing time series, this value type might be different from the value type of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the type of the data in the points field.
},
],
}
x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
- { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:
+ # service Foo {
+ # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
+ # }
+ # The JSON representation for Empty is empty JSON object {}.
}</pre>
</div>
@@ -173,82 +185,93 @@
Args:
name: string, The project on which to execute the request. The format is "projects/{project_id_or_number}". (required)
orderBy: string, Specifies the order in which the points of the time series should be returned. By default, results are not ordered. Currently, this field must be left blank.
- pageSize: integer, A positive number that is the maximum number of results to return. When `view` field sets to `FULL`, it limits the number of `Points` server will return; if `view` field is `HEADERS`, it limits the number of `TimeSeries` server will return.
+ pageSize: integer, A positive number that is the maximum number of results to return. When view field sets to FULL, it limits the number of Points server will return; if view field is HEADERS, it limits the number of TimeSeries server will return.
x__xgafv: string, V1 error format.
- aggregation_alignmentPeriod: string, The alignment period for per-[time series](TimeSeries) alignment. If present, `alignmentPeriod` must be at least 60 seconds. After per-time series alignment, each time series will contain data points only on the period boundaries. If `perSeriesAligner` is not specified or equals `ALIGN_NONE`, then this field is ignored. If `perSeriesAligner` is specified and does not equal `ALIGN_NONE`, then this field must be defined; otherwise an error is returned.
- pageToken: string, If this field is not empty then it must contain the `nextPageToken` value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.
- aggregation_groupByFields: string, The set of fields to preserve when `crossSeriesReducer` is specified. The `groupByFields` determine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The `crossSeriesReducer` is applied to each subset of time series. Fields not specified in `groupByFields` are aggregated away. If `groupByFields` is not specified, the time series are aggregated into a single output time series. If `crossSeriesReducer` is not defined, this field is ignored. (repeated)
- aggregation_perSeriesAligner: string, The approach to be used to align individual time series. Not all alignment functions may be applied to all time series, depending on the metric type and value type of the original time series. Alignment may change the metric type or the value type of the time series. Time series data must be aligned in order to perform cross-time series reduction. If `crossSeriesReducer` is specified, then `perSeriesAligner` must be specified and not equal `ALIGN_NONE` and `alignmentPeriod` must be specified; otherwise, an error is returned.
- interval_endTime: string, Required. The end of the interval. The interval includes this time.
- aggregation_crossSeriesReducer: string, The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series. Time series data must be aligned in order to perform cross-time series reduction. If `crossSeriesReducer` is specified, then `perSeriesAligner` must be specified and not equal `ALIGN_NONE` and `alignmentPeriod` must be specified; otherwise, an error is returned.
- filter: string, A [monitoring filter](/monitoring/api/v3/filters) that specifies which time series should be returned. The filter must specify a single metric type, and can additionally specify metric labels and other information. For example: metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND metric.label.instance_name = "my-instance-name"
- interval_startTime: string, If this value is omitted, the interval is a point in time, `endTime`. If `startTime` is present, it must be earlier than (less than) `endTime`. The interval begins after `startTime`—it does not include `startTime`.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+ aggregation_alignmentPeriod: string, The alignment period for per-time series alignment. If present, alignmentPeriod must be at least 60 seconds. After per-time series alignment, each time series will contain data points only on the period boundaries. If perSeriesAligner is not specified or equals ALIGN_NONE, then this field is ignored. If perSeriesAligner is specified and does not equal ALIGN_NONE, then this field must be defined; otherwise an error is returned.
+ pageToken: string, If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.
+ aggregation_groupByFields: string, The set of fields to preserve when crossSeriesReducer is specified. The groupByFields determine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The crossSeriesReducer is applied to each subset of time series. Fields not specified in groupByFields are aggregated away. If groupByFields is not specified, the time series are aggregated into a single output time series. If crossSeriesReducer is not defined, this field is ignored. (repeated)
+ aggregation_perSeriesAligner: string, The approach to be used to align individual time series. Not all alignment functions may be applied to all time series, depending on the metric type and value type of the original time series. Alignment may change the metric type or the value type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned.
+ interval_endTime: string, Required. The end of the time interval.
+ aggregation_crossSeriesReducer: string, The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned.
+ filter: string, A monitoring filter (/monitoring/api/v3/filters) that specifies which time series should be returned. The filter must specify a single metric type, and can additionally specify metric labels and other information. For example:
+metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND
+ metric.label.instance_name = "my-instance-name"
+
+ interval_startTime: string, Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.
view: string, Specifies which information is returned about the time series.
Returns:
An object of the form:
- { # The `ListTimeSeries` response.
- "nextPageToken": "A String", # If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as `pageToken` in the next call to this method.
+ { # The ListTimeSeries response.
+ "nextPageToken": "A String", # If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method.
"timeSeries": [ # One or more time series that match the filter included in the request.
- { # A collection of data points that describes the time-varying nature of a metric. A time series is identified by a combination of a fully-specified monitored resource and a fully-specified metric.
- "metricKind": "A String", # The metric kind of the time series. This can be different than the metric kind specified in [google.api.MetricDescriptor] because of alignment and reduction operations on the data. This field is ignored when writing data; the value specified in the descriptor is used instead. @OutputOnly
- "metric": { # A specific metric identified by specifying values for all of the labels of a `MetricDescriptor`. # The fully-specified metric used to identify the time series.
- "labels": { # The set of labels that uniquely identify a metric. To specify a metric, all labels enumerated in the `MetricDescriptor` must be assigned values.
+ { # A collection of data points that describes the time-varying values of a metric. A time series is identified by a combination of a fully-specified monitored resource and a fully-specified metric. This type is used for both listing and creating time series.
+ "metricKind": "A String", # The metric kind of the time series. When listing time series, this metric kind might be different from the metric kind of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the metric kind of the associated metric. If the associated metric's descriptor must be auto-created, then this field specifies the metric kind of the new descriptor and must be either GAUGE (the default) or CUMULATIVE.
+ "metric": { # A specific metric identified by specifying values for all of the labels of a MetricDescriptor. # The associated metric. A fully-specified metric used to identify the time series.
+ "labels": { # The set of labels that uniquely identify a metric. To specify a metric, all labels enumerated in the MetricDescriptor must be assigned values.
"a_key": "A String",
},
- "type": "A String", # An existing metric type, see google.api.MetricDescriptor. For example, `compute.googleapis.com/instance/cpu/usage_time`.
+ "type": "A String", # An existing metric type, see google.api.MetricDescriptor. For example, compute.googleapis.com/instance/cpu/usage_time.
},
- "points": [ # The data points of this time series. When used as output, points will be sorted by decreasing time order. When used as input, points could be written in any orders.
+ "points": [ # The data points of this time series. When listing time series, the order of the points is specified by the list method.When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be BOOL, INT64, DOUBLE, or DISTRIBUTION.
{ # A single data point in a time series.
- "interval": { # A time interval extending from after `startTime` through `endTime`. If `startTime` is omitted, the interval is the single point in time, `endTime`. # The time interval to which the value applies.
- "endTime": "A String", # Required. The end of the interval. The interval includes this time.
- "startTime": "A String", # If this value is omitted, the interval is a point in time, `endTime`. If `startTime` is present, it must be earlier than (less than) `endTime`. The interval begins after `startTime`—it does not include `startTime`.
+ "interval": { # A time interval extending just after a start time through an end time. If the start time is the same as the end time, then the interval represents a single point in time. # The time interval to which the data point applies. For GAUGE metrics, only the end time of the interval is used. For DELTA metrics, the start and end time should specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For CUMULATIVE metrics, the start and end time should specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points.
+ "endTime": "A String", # Required. The end of the time interval.
+ "startTime": "A String", # Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.
},
"value": { # A single strongly-typed value. # The value of the data point.
- "distributionValue": { # Distribution contains summary statistics for a population of values and, optionally, a histogram representing the distribution of those values across a specified set of histogram buckets. The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values. The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by specifying parameters for a method of computing them (buckets of fixed width or buckets of exponentially increasing width). Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the `mean` and `sum_of_squared_deviation` fields meaningless. # A distribution value.
+ "distributionValue": { # Distribution contains summary statistics for a population of values and, optionally, a histogram representing the distribution of those values across a specified set of histogram buckets.The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values.The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by specifying parameters for a method of computing them (buckets of fixed width or buckets of exponentially increasing width).Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the mean and sum_of_squared_deviation fields meaningless. # A distribution value.
"count": "A String", # The number of values in the population. Must be non-negative.
- "bucketCounts": [ # If `bucket_options` is given, then the sum of the values in `bucket_counts` must equal the value in `count`. If `bucket_options` is not given, no `bucket_counts` fields may be given. Bucket counts are given in order under the numbering scheme described above (the underflow bucket has number 0; the finite buckets, if any, have numbers 1 through N-2; the overflow bucket has number N-1). The size of `bucket_counts` must be no greater than N as defined in `bucket_options`. Any suffix of trailing zero bucket_count fields may be omitted.
+ "bucketCounts": [ # If bucket_options is given, then the sum of the values in bucket_counts must equal the value in count. If bucket_options is not given, no bucket_counts fields may be given.Bucket counts are given in order under the numbering scheme described above (the underflow bucket has number 0; the finite buckets, if any, have numbers 1 through N-2; the overflow bucket has number N-1).The size of bucket_counts must be no greater than N as defined in bucket_options.Any suffix of trailing zero bucket_count fields may be omitted.
"A String",
],
- "bucketOptions": { # A Distribution may optionally contain a histogram of the values in the population. The histogram is given in `bucket_counts` as counts of values that fall into one of a sequence of non-overlapping buckets. The sequence of buckets is described by `bucket_options`. A bucket specifies an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket is strictly greater than the lower bound. The sequence of N buckets for a Distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite. `BucketOptions` describes bucket boundaries in one of three ways. Two describe the boundaries by giving parameters for a formula to generate boundaries and one gives the bucket boundaries explicitly. If `bucket_boundaries` is not given, then no `bucket_counts` may be given. # Defines the histogram bucket boundaries.
- "exponentialBuckets": { # Specify a sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket. Defines `num_finite_buckets + 2` (= N) buckets with these boundaries for bucket i: Upper bound (0 <= i < N-1): scale * (growth_factor ^ i). Lower bound (1 <= i < N): scale * (growth_factor ^ (i - 1)). # The exponential buckets.
- "scale": 3.14, # Must be greater than 0
- "growthFactor": 3.14, # Must be greater than 1
- "numFiniteBuckets": 42, # must be greater than 0
+ "bucketOptions": { # A Distribution may optionally contain a histogram of the values in the population. The histogram is given in bucket_counts as counts of values that fall into one of a sequence of non-overlapping buckets. The sequence of buckets is described by bucket_options.A bucket specifies an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket is strictly greater than the lower bound.The sequence of N buckets for a Distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite.BucketOptions describes bucket boundaries in one of three ways. Two describe the boundaries by giving parameters for a formula to generate boundaries and one gives the bucket boundaries explicitly.If bucket_options is not given, then no bucket_counts may be given. # Defines the histogram bucket boundaries.
+ "exponentialBuckets": { # Specify a sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket.Defines num_finite_buckets + 2 (= N) buckets with these boundaries for bucket i:Upper bound (0 <= i < N-1): scale * (growth_factor ^ i). Lower bound (1 <= i < N): scale * (growth_factor ^ (i - 1)). # The exponential buckets.
+ "scale": 3.14, # Must be greater than 0.
+ "growthFactor": 3.14, # Must be greater than 1.
+ "numFiniteBuckets": 42, # Must be greater than 0.
},
- "linearBuckets": { # Specify a sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket. Defines `num_finite_buckets + 2` (= N) buckets with these boundaries for bucket `i`: Upper bound (0 <= i < N-1): offset + (width * i). Lower bound (1 <= i < N): offset + (width * (i - 1)). # The linear bucket.
+ "linearBuckets": { # Specify a sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket.Defines num_finite_buckets + 2 (= N) buckets with these boundaries for bucket i:Upper bound (0 <= i < N-1): offset + (width * i). Lower bound (1 <= i < N): offset + (width * (i - 1)). # The linear bucket.
"width": 3.14, # Must be greater than 0.
"numFiniteBuckets": 42, # Must be greater than 0.
"offset": 3.14, # Lower bound of the first bucket.
},
- "explicitBuckets": { # A set of buckets with arbitrary widths. Defines `size(bounds) + 1` (= N) buckets with these boundaries for bucket i: Upper bound (0 <= i < N-1): bounds[i] Lower bound (1 <= i < N); bounds[i - 1] There must be at least one element in `bounds`. If `bounds` has only one element, there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets. # The explicit buckets.
+ "explicitBuckets": { # A set of buckets with arbitrary widths.Defines size(bounds) + 1 (= N) buckets with these boundaries for bucket i:Upper bound (0 <= i < N-1): boundsi Lower bound (1 <= i < N); boundsi - 1There must be at least one element in bounds. If bounds has only one element, there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets. # The explicit buckets.
"bounds": [ # The values must be monotonically increasing.
3.14,
],
},
},
- "range": { # The range of the population values. # If specified, contains the range of the population values. The field must not be present if the `count` is zero.
+ "range": { # The range of the population values. # If specified, contains the range of the population values. The field must not be present if the count is zero. This field is presently ignored by the Stackdriver Monitoring API v3.
"max": 3.14, # The maximum of the population values.
"min": 3.14, # The minimum of the population values.
},
- "sumOfSquaredDeviation": 3.14, # The sum of squared deviations from the mean of the values in the population. For values x_i this is: Sum[i=1..n]((x_i - mean)^2) Knuth, "The Art of Computer Programming", Vol. 2, page 323, 3rd edition describes Welford's method for accumulating this sum in one pass. If `count` is zero then this field must be zero.
- "mean": 3.14, # The arithmetic mean of the values in the population. If `count` is zero then this field must be zero.
+ "sumOfSquaredDeviation": 3.14, # The sum of squared deviations from the mean of the values in the population. For values x_i this is:
+ # Sum[i=1..n]((x_i - mean)^2)
+ # Knuth, "The Art of Computer Programming", Vol. 2, page 323, 3rd edition describes Welford's method for accumulating this sum in one pass.If count is zero then this field must be zero.
+ "mean": 3.14, # The arithmetic mean of the values in the population. If count is zero then this field must be zero.
},
"stringValue": "A String", # A variable-length string value.
- "boolValue": True or False, # A Boolean value: `true` or `false`.
- "int64Value": "A String", # A 64-bit integer. Its range is approximately ±9.2x1018.
- "doubleValue": 3.14, # A 64-bit double-precision floating-point number. Its magnitude is approximately ±10±300 and it has 16 significant digits of precision.
+ "boolValue": True or False, # A Boolean value: true or false.
+ "int64Value": "A String", # A 64-bit integer. Its range is approximately ±9.2x10<sup>18</sup>.
+ "doubleValue": 3.14, # A 64-bit double-precision floating-point number. Its magnitude is approximately ±10<sup>±300</sup> and it has 16 significant digits of precision.
},
},
],
- "resource": { # An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The `type` field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the `labels` field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for `"gce_instance"` has labels `"instance_id"` and `"zone"`: { "type": "gce_instance", "labels": { "instance_id": "my-instance", "zone": "us-central1-a" }} # The fully-specified monitored resource used to identify the time series.
- "labels": { # Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Cloud SQL databases use the labels `"database_id"` and `"zone"`.
+ "resource": { # An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for "gce_instance" has labels "instance_id" and "zone": # The associated resource. A fully-specified monitored resource used to identify the time series.
+ # { "type": "gce_instance",
+ # "labels": { "instance_id": "12345678901234",
+ # "zone": "us-central1-a" }}
+ "labels": { # Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Cloud SQL databases use the labels "database_id" and "zone".
"a_key": "A String",
},
- "type": "A String", # Required. The monitored resource type. This field must match the `type` field of a MonitoredResourceDescriptor object. For example, the type of a Cloud SQL database is `"cloudsql_database"`.
+ "type": "A String", # Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Cloud SQL database is "cloudsql_database".
},
- "valueType": "A String", # The value type of the time series. This can be different than the value type specified in [google.api.MetricDescriptor] because of alignment and reduction operations on the data. This field is ignored when writing data; the value specified in the descriptor is used instead. @OutputOnly
+ "valueType": "A String", # The value type of the time series. When listing time series, this value type might be different from the value type of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the type of the data in the points field.
},
],
}</pre>
diff --git a/docs/dyn/plus_v1.activities.html b/docs/dyn/plus_v1.activities.html
index 386d1c6..d52a12b 100644
--- a/docs/dyn/plus_v1.activities.html
+++ b/docs/dyn/plus_v1.activities.html
@@ -109,7 +109,6 @@
},
"title": "A String", # Title of this activity.
"url": "A String", # The link to this activity.
- "geocode": "A String", # Latitude and longitude where this activity occurred. Format is latitude followed by longitude, space separated.
"object": { # The object of this activity.
"resharers": { # People who reshared this activity.
"totalItems": 42, # Total number of people who reshared this activity.
@@ -117,97 +116,75 @@
},
"attachments": [ # The media objects attached to this activity.
{
- "displayName": "A String", # The title of the attachment, such as a photo caption or an article title.
- "thumbnails": [ # If the attachment is an album, this property is a list of potential additional thumbnails from the album.
- {
- "url": "A String", # URL of the webpage containing the image.
- "image": { # Image resource.
- "url": "A String", # Image url.
- "width": 42, # The width, in pixels, of the linked resource.
- "type": "A String", # Media type of the link.
- "height": 42, # The height, in pixels, of the linked resource.
- },
- "description": "A String", # Potential name of the thumbnail.
- },
- ],
- "fullImage": { # The full image URL for photo attachments.
- "url": "A String", # URL of the image.
+ "displayName": "A String", # The title of the attachment (such as a photo caption or an article title).
+ "contentsource": { # If the attachment is audio, the link to the content.
+ "url": "A String", # URL of the link.
+ "type": "A String", # Media type of the link.
+ },
+ "fullImage": { # The full image url for photo attachments.
+ "url": "A String", # URL of the link.
"width": 42, # The width, in pixels, of the linked resource.
"type": "A String", # Media type of the link.
"height": 42, # The height, in pixels, of the linked resource.
},
- "url": "A String", # The link to the attachment, which should be of type text/html.
+ "url": "A String", # The link to the attachment, should be of type text/html.
"image": { # The preview image for photos or videos.
- "url": "A String", # Image URL.
+ "url": "A String", # URL of the link.
"width": 42, # The width, in pixels, of the linked resource.
"type": "A String", # Media type of the link.
"height": 42, # The height, in pixels, of the linked resource.
},
- "content": "A String", # If the attachment is an article, this property contains a snippet of text from the article. It can also include descriptions for other types.
+ "content": "A String", # If the attachment is an article, this property contains a snippet of text from the article.
"embed": { # If the attachment is a video, the embeddable link.
"url": "A String", # URL of the link.
"type": "A String", # Media type of the link.
},
- "id": "A String", # The ID of the attachment.
- "objectType": "A String", # The type of media object. Possible values include, but are not limited to, the following values:
+ "id": "A String", # The ID of the media object's resource.
+ "categories": [ # Specifies zero or more categories the attachment belongs to.
+ {
+ "term": "A String", # The tag, e.g. album.
+ "schema": "A String", # Domain of schema, e.g. http://google.com.
+ "label": "A String", # The category label, suitable for display (e.g. "album cover").
+ },
+ ],
+ "objectType": "A String", # The type of media object. Possible values are:
# - "photo" - A photo.
- # - "album" - A photo album.
# - "video" - A video.
# - "article" - An article, specified by a link.
},
],
- "originalContent": "A String", # The content (text) as provided by the author, which is stored without any HTML formatting. When creating or updating an activity, this value must be supplied as plain text in the request.
+ "originalContent": "A String", # The content (text) as provided by the author, stored without any HTML formatting. When updating an activity's content, use the value of originalContent as the starting point from which to make edits.
"plusoners": { # People who +1'd this activity.
"totalItems": 42, # Total number of people who +1'd this activity.
"selfLink": "A String", # The URL for the collection of people who +1'd this activity.
},
- "actor": { # If this activity's object is itself another activity, such as when a person reshares an activity, this property specifies the original activity's actor.
- "displayName": "A String", # The original actor's name, which is suitable for display.
+ "actor": { # If this activity's object is itself another activity (for example, when a person reshares an activity), this property specifies the original activity's actor.
"url": "A String", # A link to the original actor's Google profile.
"image": { # The image representation of the original actor.
"url": "A String", # A URL that points to a thumbnail photo of the original actor.
},
- "clientSpecificActorInfo": { # Actor info specific to particular clients.
- "youtubeActorInfo": { # Actor info specific to YouTube clients.
- "channelId": "A String", # ID of the YouTube channel owned by the Actor.
- },
- },
- "verification": { # Verification status of actor.
- "adHocVerified": "A String", # Verification for one-time or manual processes.
- },
+ "displayName": "A String", # The original actor's name, suitable for display.
"id": "A String", # ID of the original actor.
},
- "content": "A String", # The HTML-formatted content, which is suitable for display.
+ "content": "A String", # The HTML-formatted content, suitable for display. When creating or updating an activity, this value must be supplied as plain text in the request. If successful, the response will contain the HTML-formatted content. When updating an activity, use originalContent as the starting value, then assign the updated text to this property.
"url": "A String", # The URL that points to the linked resource.
"replies": { # Comments in reply to this activity.
"totalItems": 42, # Total number of comments on this activity.
"selfLink": "A String", # The URL for the collection of comments in reply to this activity.
},
- "id": "A String", # The ID of the object. When resharing an activity, this is the ID of the activity that is being reshared.
- "objectType": "A String", # The type of the object. Possible values include, but are not limited to, the following values:
+ "id": "A String", # The ID of the object. When resharing an activity, this is the ID of the activity being reshared.
+ "objectType": "A String", # The type of the object. Possible values are:
# - "note" - Textual content.
# - "activity" - A Google+ activity.
},
"placeId": "A String", # ID of the place where this activity occurred.
"actor": { # The person who performed this activity.
- "displayName": "A String", # The name of the actor, suitable for display.
- "name": { # An object representation of the individual components of name.
- "givenName": "A String", # The given name ("first name") of the actor.
- "familyName": "A String", # The family name ("last name") of the actor.
- },
"url": "A String", # The link to the actor's Google profile.
"image": { # The image representation of the actor.
- "url": "A String", # The URL of the actor's profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
+ "url": "A String", # The URL of the actor's profile photo. To re-size the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
},
- "clientSpecificActorInfo": { # Actor info specific to particular clients.
- "youtubeActorInfo": { # Actor info specific to YouTube clients.
- "channelId": "A String", # ID of the YouTube channel owned by the Actor.
- },
- },
- "verification": { # Verification status of actor.
- "adHocVerified": "A String", # Verification for one-time or manual processes.
- },
- "id": "A String", # The ID of the actor's Person resource.
+ "displayName": "A String", # The name of the actor, suitable for display.
+ "id": "A String", # The ID of the actor's person resource.
},
"id": "A String", # The ID of this activity.
"access": { # Identifies who has access to see this activity.
@@ -217,35 +194,23 @@
# - "person" - Access to an individual.
# - "circle" - Access to members of a circle.
# - "myCircles" - Access to members of all the person's circles.
- # - "extendedCircles" - Access to members of all the person's circles, plus all of the people in their circles.
- # - "domain" - Access to members of the person's Google Apps domain.
+ # - "extendedCircles" - Access to members of everyone in a person's circles, plus all of the people in their circles.
# - "public" - Access to anyone on the web.
- "displayName": "A String", # A descriptive name for this entry. Suitable for display.
"id": "A String", # The ID of the entry. For entries of type "person" or "circle", this is the ID of the resource. For other types, this property is not set.
},
],
"kind": "plus#acl", # Identifies this resource as a collection of access controls. Value: "plus#acl".
"description": "A String", # Description of the access granted, suitable for display.
},
- "verb": "A String", # This activity's verb, which indicates the action that was performed. Possible values include, but are not limited to, the following values:
+ "verb": "A String", # This activity's verb, indicating what action was performed. Possible values are:
# - "post" - Publish content to the stream.
+ # - "checkin" - Check in to a location.
# - "share" - Reshare an activity.
- "etag": "A String", # ETag of this response for caching purposes.
+ "geocode": "A String", # Latitude and longitude where this activity occurred. Format is latitude followed by longitude, space separated.
"radius": "A String", # Radius, in meters, of the region where this activity occurred, centered at the latitude and longitude identified in geocode.
- "location": { # The location where this activity occurred.
- "position": { # The position of the place.
- "latitude": 3.14, # The latitude of this position.
- "longitude": 3.14, # The longitude of this position.
- },
- "kind": "plus#place", # Identifies this resource as a place. Value: "plus#place".
- "displayName": "A String", # The display name of the place.
- "id": "A String", # The id of the place.
- "address": { # The physical address of the place.
- "formatted": "A String", # The formatted address for display.
- },
- },
"address": "A String", # Street address where this activity occurred.
"crosspostSource": "A String", # If this activity is a crosspost from another system, this property specifies the ID of the original activity.
+ "placeholder": True or False, # True if this activity is a placeholder.
"annotation": "A String", # Additional content added by the person who shared this activity, applicable only when resharing an activity.
"published": "A String", # The time at which this activity was initially published. Formatted as an RFC 3339 timestamp.
}</pre>
@@ -260,16 +225,16 @@
collection: string, The collection of activities to list. (required)
Allowed values
public - All public activities created by the specified user.
- pageToken: string, The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.
- maxResults: integer, The maximum number of activities to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.
+ pageToken: string, The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.
+ maxResults: integer, The maximum number of activities to include in the response, used for paging. For any response, the actual number returned may be less than the specified maxResults.
Returns:
An object of the form:
{
- "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.
+ "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
"kind": "plus#activityFeed", # Identifies this resource as a collection of activities. Value: "plus#activityFeed".
- "title": "A String", # The title of this collection of activities, which is a truncated portion of the content.
+ "title": "A String", # The title of this collection of activities.
"items": [ # The activities in this page of results.
{
"placeName": "A String", # Name of the place where this activity occurred.
@@ -280,7 +245,6 @@
},
"title": "A String", # Title of this activity.
"url": "A String", # The link to this activity.
- "geocode": "A String", # Latitude and longitude where this activity occurred. Format is latitude followed by longitude, space separated.
"object": { # The object of this activity.
"resharers": { # People who reshared this activity.
"totalItems": 42, # Total number of people who reshared this activity.
@@ -288,97 +252,75 @@
},
"attachments": [ # The media objects attached to this activity.
{
- "displayName": "A String", # The title of the attachment, such as a photo caption or an article title.
- "thumbnails": [ # If the attachment is an album, this property is a list of potential additional thumbnails from the album.
- {
- "url": "A String", # URL of the webpage containing the image.
- "image": { # Image resource.
- "url": "A String", # Image url.
- "width": 42, # The width, in pixels, of the linked resource.
- "type": "A String", # Media type of the link.
- "height": 42, # The height, in pixels, of the linked resource.
- },
- "description": "A String", # Potential name of the thumbnail.
- },
- ],
- "fullImage": { # The full image URL for photo attachments.
- "url": "A String", # URL of the image.
+ "displayName": "A String", # The title of the attachment (such as a photo caption or an article title).
+ "contentsource": { # If the attachment is audio, the link to the content.
+ "url": "A String", # URL of the link.
+ "type": "A String", # Media type of the link.
+ },
+ "fullImage": { # The full image url for photo attachments.
+ "url": "A String", # URL of the link.
"width": 42, # The width, in pixels, of the linked resource.
"type": "A String", # Media type of the link.
"height": 42, # The height, in pixels, of the linked resource.
},
- "url": "A String", # The link to the attachment, which should be of type text/html.
+ "url": "A String", # The link to the attachment, should be of type text/html.
"image": { # The preview image for photos or videos.
- "url": "A String", # Image URL.
+ "url": "A String", # URL of the link.
"width": 42, # The width, in pixels, of the linked resource.
"type": "A String", # Media type of the link.
"height": 42, # The height, in pixels, of the linked resource.
},
- "content": "A String", # If the attachment is an article, this property contains a snippet of text from the article. It can also include descriptions for other types.
+ "content": "A String", # If the attachment is an article, this property contains a snippet of text from the article.
"embed": { # If the attachment is a video, the embeddable link.
"url": "A String", # URL of the link.
"type": "A String", # Media type of the link.
},
- "id": "A String", # The ID of the attachment.
- "objectType": "A String", # The type of media object. Possible values include, but are not limited to, the following values:
+ "id": "A String", # The ID of the media object's resource.
+ "categories": [ # Specifies zero or more categories the attachment belongs to.
+ {
+ "term": "A String", # The tag, e.g. album.
+ "schema": "A String", # Domain of schema, e.g. http://google.com.
+ "label": "A String", # The category label, suitable for display (e.g. "album cover").
+ },
+ ],
+ "objectType": "A String", # The type of media object. Possible values are:
# - "photo" - A photo.
- # - "album" - A photo album.
# - "video" - A video.
# - "article" - An article, specified by a link.
},
],
- "originalContent": "A String", # The content (text) as provided by the author, which is stored without any HTML formatting. When creating or updating an activity, this value must be supplied as plain text in the request.
+ "originalContent": "A String", # The content (text) as provided by the author, stored without any HTML formatting. When updating an activity's content, use the value of originalContent as the starting point from which to make edits.
"plusoners": { # People who +1'd this activity.
"totalItems": 42, # Total number of people who +1'd this activity.
"selfLink": "A String", # The URL for the collection of people who +1'd this activity.
},
- "actor": { # If this activity's object is itself another activity, such as when a person reshares an activity, this property specifies the original activity's actor.
- "displayName": "A String", # The original actor's name, which is suitable for display.
+ "actor": { # If this activity's object is itself another activity (for example, when a person reshares an activity), this property specifies the original activity's actor.
"url": "A String", # A link to the original actor's Google profile.
"image": { # The image representation of the original actor.
"url": "A String", # A URL that points to a thumbnail photo of the original actor.
},
- "clientSpecificActorInfo": { # Actor info specific to particular clients.
- "youtubeActorInfo": { # Actor info specific to YouTube clients.
- "channelId": "A String", # ID of the YouTube channel owned by the Actor.
- },
- },
- "verification": { # Verification status of actor.
- "adHocVerified": "A String", # Verification for one-time or manual processes.
- },
+ "displayName": "A String", # The original actor's name, suitable for display.
"id": "A String", # ID of the original actor.
},
- "content": "A String", # The HTML-formatted content, which is suitable for display.
+ "content": "A String", # The HTML-formatted content, suitable for display. When creating or updating an activity, this value must be supplied as plain text in the request. If successful, the response will contain the HTML-formatted content. When updating an activity, use originalContent as the starting value, then assign the updated text to this property.
"url": "A String", # The URL that points to the linked resource.
"replies": { # Comments in reply to this activity.
"totalItems": 42, # Total number of comments on this activity.
"selfLink": "A String", # The URL for the collection of comments in reply to this activity.
},
- "id": "A String", # The ID of the object. When resharing an activity, this is the ID of the activity that is being reshared.
- "objectType": "A String", # The type of the object. Possible values include, but are not limited to, the following values:
+ "id": "A String", # The ID of the object. When resharing an activity, this is the ID of the activity being reshared.
+ "objectType": "A String", # The type of the object. Possible values are:
# - "note" - Textual content.
# - "activity" - A Google+ activity.
},
"placeId": "A String", # ID of the place where this activity occurred.
"actor": { # The person who performed this activity.
- "displayName": "A String", # The name of the actor, suitable for display.
- "name": { # An object representation of the individual components of name.
- "givenName": "A String", # The given name ("first name") of the actor.
- "familyName": "A String", # The family name ("last name") of the actor.
- },
"url": "A String", # The link to the actor's Google profile.
"image": { # The image representation of the actor.
- "url": "A String", # The URL of the actor's profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
+ "url": "A String", # The URL of the actor's profile photo. To re-size the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
},
- "clientSpecificActorInfo": { # Actor info specific to particular clients.
- "youtubeActorInfo": { # Actor info specific to YouTube clients.
- "channelId": "A String", # ID of the YouTube channel owned by the Actor.
- },
- },
- "verification": { # Verification status of actor.
- "adHocVerified": "A String", # Verification for one-time or manual processes.
- },
- "id": "A String", # The ID of the actor's Person resource.
+ "displayName": "A String", # The name of the actor, suitable for display.
+ "id": "A String", # The ID of the actor's person resource.
},
"id": "A String", # The ID of this activity.
"access": { # Identifies who has access to see this activity.
@@ -388,43 +330,30 @@
# - "person" - Access to an individual.
# - "circle" - Access to members of a circle.
# - "myCircles" - Access to members of all the person's circles.
- # - "extendedCircles" - Access to members of all the person's circles, plus all of the people in their circles.
- # - "domain" - Access to members of the person's Google Apps domain.
+ # - "extendedCircles" - Access to members of everyone in a person's circles, plus all of the people in their circles.
# - "public" - Access to anyone on the web.
- "displayName": "A String", # A descriptive name for this entry. Suitable for display.
"id": "A String", # The ID of the entry. For entries of type "person" or "circle", this is the ID of the resource. For other types, this property is not set.
},
],
"kind": "plus#acl", # Identifies this resource as a collection of access controls. Value: "plus#acl".
"description": "A String", # Description of the access granted, suitable for display.
},
- "verb": "A String", # This activity's verb, which indicates the action that was performed. Possible values include, but are not limited to, the following values:
+ "verb": "A String", # This activity's verb, indicating what action was performed. Possible values are:
# - "post" - Publish content to the stream.
+ # - "checkin" - Check in to a location.
# - "share" - Reshare an activity.
- "etag": "A String", # ETag of this response for caching purposes.
+ "geocode": "A String", # Latitude and longitude where this activity occurred. Format is latitude followed by longitude, space separated.
"radius": "A String", # Radius, in meters, of the region where this activity occurred, centered at the latitude and longitude identified in geocode.
- "location": { # The location where this activity occurred.
- "position": { # The position of the place.
- "latitude": 3.14, # The latitude of this position.
- "longitude": 3.14, # The longitude of this position.
- },
- "kind": "plus#place", # Identifies this resource as a place. Value: "plus#place".
- "displayName": "A String", # The display name of the place.
- "id": "A String", # The id of the place.
- "address": { # The physical address of the place.
- "formatted": "A String", # The formatted address for display.
- },
- },
"address": "A String", # Street address where this activity occurred.
"crosspostSource": "A String", # If this activity is a crosspost from another system, this property specifies the ID of the original activity.
+ "placeholder": True or False, # True if this activity is a placeholder.
"annotation": "A String", # Additional content added by the person who shared this activity, applicable only when resharing an activity.
"published": "A String", # The time at which this activity was initially published. Formatted as an RFC 3339 timestamp.
},
],
"updated": "A String", # The time at which this collection of activities was last updated. Formatted as an RFC 3339 timestamp.
"nextLink": "A String", # Link to the next page of activities.
- "etag": "A String", # ETag of this response for caching purposes.
- "id": "A String", # The ID of this collection of activities. Deprecated.
+ "id": "A String", # The ID of this collection of activities.
"selfLink": "A String", # Link to this activity resource.
}</pre>
</div>
@@ -453,17 +382,17 @@
Allowed values
best - Sort activities by relevance to the user, most relevant first.
recent - Sort activities by published date, most recent first.
- language: string, Specify the preferred language to search with. See search language codes for available values.
- pageToken: string, The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. This token can be of any length.
- maxResults: integer, The maximum number of activities to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.
+ language: string, Specify the preferred language to search with. See Language Codes for available values.
+ pageToken: string, The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. This token may be of any length.
+ maxResults: integer, The maximum number of activities to include in the response, used for paging. For any response, the actual number returned may be less than the specified maxResults.
Returns:
An object of the form:
{
- "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.
+ "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
"kind": "plus#activityFeed", # Identifies this resource as a collection of activities. Value: "plus#activityFeed".
- "title": "A String", # The title of this collection of activities, which is a truncated portion of the content.
+ "title": "A String", # The title of this collection of activities.
"items": [ # The activities in this page of results.
{
"placeName": "A String", # Name of the place where this activity occurred.
@@ -474,7 +403,6 @@
},
"title": "A String", # Title of this activity.
"url": "A String", # The link to this activity.
- "geocode": "A String", # Latitude and longitude where this activity occurred. Format is latitude followed by longitude, space separated.
"object": { # The object of this activity.
"resharers": { # People who reshared this activity.
"totalItems": 42, # Total number of people who reshared this activity.
@@ -482,97 +410,75 @@
},
"attachments": [ # The media objects attached to this activity.
{
- "displayName": "A String", # The title of the attachment, such as a photo caption or an article title.
- "thumbnails": [ # If the attachment is an album, this property is a list of potential additional thumbnails from the album.
- {
- "url": "A String", # URL of the webpage containing the image.
- "image": { # Image resource.
- "url": "A String", # Image url.
- "width": 42, # The width, in pixels, of the linked resource.
- "type": "A String", # Media type of the link.
- "height": 42, # The height, in pixels, of the linked resource.
- },
- "description": "A String", # Potential name of the thumbnail.
- },
- ],
- "fullImage": { # The full image URL for photo attachments.
- "url": "A String", # URL of the image.
+ "displayName": "A String", # The title of the attachment (such as a photo caption or an article title).
+ "contentsource": { # If the attachment is audio, the link to the content.
+ "url": "A String", # URL of the link.
+ "type": "A String", # Media type of the link.
+ },
+ "fullImage": { # The full image url for photo attachments.
+ "url": "A String", # URL of the link.
"width": 42, # The width, in pixels, of the linked resource.
"type": "A String", # Media type of the link.
"height": 42, # The height, in pixels, of the linked resource.
},
- "url": "A String", # The link to the attachment, which should be of type text/html.
+ "url": "A String", # The link to the attachment, should be of type text/html.
"image": { # The preview image for photos or videos.
- "url": "A String", # Image URL.
+ "url": "A String", # URL of the link.
"width": 42, # The width, in pixels, of the linked resource.
"type": "A String", # Media type of the link.
"height": 42, # The height, in pixels, of the linked resource.
},
- "content": "A String", # If the attachment is an article, this property contains a snippet of text from the article. It can also include descriptions for other types.
+ "content": "A String", # If the attachment is an article, this property contains a snippet of text from the article.
"embed": { # If the attachment is a video, the embeddable link.
"url": "A String", # URL of the link.
"type": "A String", # Media type of the link.
},
- "id": "A String", # The ID of the attachment.
- "objectType": "A String", # The type of media object. Possible values include, but are not limited to, the following values:
+ "id": "A String", # The ID of the media object's resource.
+ "categories": [ # Specifies zero or more categories the attachment belongs to.
+ {
+ "term": "A String", # The tag, e.g. album.
+ "schema": "A String", # Domain of schema, e.g. http://google.com.
+ "label": "A String", # The category label, suitable for display (e.g. "album cover").
+ },
+ ],
+ "objectType": "A String", # The type of media object. Possible values are:
# - "photo" - A photo.
- # - "album" - A photo album.
# - "video" - A video.
# - "article" - An article, specified by a link.
},
],
- "originalContent": "A String", # The content (text) as provided by the author, which is stored without any HTML formatting. When creating or updating an activity, this value must be supplied as plain text in the request.
+ "originalContent": "A String", # The content (text) as provided by the author, stored without any HTML formatting. When updating an activity's content, use the value of originalContent as the starting point from which to make edits.
"plusoners": { # People who +1'd this activity.
"totalItems": 42, # Total number of people who +1'd this activity.
"selfLink": "A String", # The URL for the collection of people who +1'd this activity.
},
- "actor": { # If this activity's object is itself another activity, such as when a person reshares an activity, this property specifies the original activity's actor.
- "displayName": "A String", # The original actor's name, which is suitable for display.
+ "actor": { # If this activity's object is itself another activity (for example, when a person reshares an activity), this property specifies the original activity's actor.
"url": "A String", # A link to the original actor's Google profile.
"image": { # The image representation of the original actor.
"url": "A String", # A URL that points to a thumbnail photo of the original actor.
},
- "clientSpecificActorInfo": { # Actor info specific to particular clients.
- "youtubeActorInfo": { # Actor info specific to YouTube clients.
- "channelId": "A String", # ID of the YouTube channel owned by the Actor.
- },
- },
- "verification": { # Verification status of actor.
- "adHocVerified": "A String", # Verification for one-time or manual processes.
- },
+ "displayName": "A String", # The original actor's name, suitable for display.
"id": "A String", # ID of the original actor.
},
- "content": "A String", # The HTML-formatted content, which is suitable for display.
+ "content": "A String", # The HTML-formatted content, suitable for display. When creating or updating an activity, this value must be supplied as plain text in the request. If successful, the response will contain the HTML-formatted content. When updating an activity, use originalContent as the starting value, then assign the updated text to this property.
"url": "A String", # The URL that points to the linked resource.
"replies": { # Comments in reply to this activity.
"totalItems": 42, # Total number of comments on this activity.
"selfLink": "A String", # The URL for the collection of comments in reply to this activity.
},
- "id": "A String", # The ID of the object. When resharing an activity, this is the ID of the activity that is being reshared.
- "objectType": "A String", # The type of the object. Possible values include, but are not limited to, the following values:
+ "id": "A String", # The ID of the object. When resharing an activity, this is the ID of the activity being reshared.
+ "objectType": "A String", # The type of the object. Possible values are:
# - "note" - Textual content.
# - "activity" - A Google+ activity.
},
"placeId": "A String", # ID of the place where this activity occurred.
"actor": { # The person who performed this activity.
- "displayName": "A String", # The name of the actor, suitable for display.
- "name": { # An object representation of the individual components of name.
- "givenName": "A String", # The given name ("first name") of the actor.
- "familyName": "A String", # The family name ("last name") of the actor.
- },
"url": "A String", # The link to the actor's Google profile.
"image": { # The image representation of the actor.
- "url": "A String", # The URL of the actor's profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
+ "url": "A String", # The URL of the actor's profile photo. To re-size the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
},
- "clientSpecificActorInfo": { # Actor info specific to particular clients.
- "youtubeActorInfo": { # Actor info specific to YouTube clients.
- "channelId": "A String", # ID of the YouTube channel owned by the Actor.
- },
- },
- "verification": { # Verification status of actor.
- "adHocVerified": "A String", # Verification for one-time or manual processes.
- },
- "id": "A String", # The ID of the actor's Person resource.
+ "displayName": "A String", # The name of the actor, suitable for display.
+ "id": "A String", # The ID of the actor's person resource.
},
"id": "A String", # The ID of this activity.
"access": { # Identifies who has access to see this activity.
@@ -582,43 +488,30 @@
# - "person" - Access to an individual.
# - "circle" - Access to members of a circle.
# - "myCircles" - Access to members of all the person's circles.
- # - "extendedCircles" - Access to members of all the person's circles, plus all of the people in their circles.
- # - "domain" - Access to members of the person's Google Apps domain.
+ # - "extendedCircles" - Access to members of everyone in a person's circles, plus all of the people in their circles.
# - "public" - Access to anyone on the web.
- "displayName": "A String", # A descriptive name for this entry. Suitable for display.
"id": "A String", # The ID of the entry. For entries of type "person" or "circle", this is the ID of the resource. For other types, this property is not set.
},
],
"kind": "plus#acl", # Identifies this resource as a collection of access controls. Value: "plus#acl".
"description": "A String", # Description of the access granted, suitable for display.
},
- "verb": "A String", # This activity's verb, which indicates the action that was performed. Possible values include, but are not limited to, the following values:
+ "verb": "A String", # This activity's verb, indicating what action was performed. Possible values are:
# - "post" - Publish content to the stream.
+ # - "checkin" - Check in to a location.
# - "share" - Reshare an activity.
- "etag": "A String", # ETag of this response for caching purposes.
+ "geocode": "A String", # Latitude and longitude where this activity occurred. Format is latitude followed by longitude, space separated.
"radius": "A String", # Radius, in meters, of the region where this activity occurred, centered at the latitude and longitude identified in geocode.
- "location": { # The location where this activity occurred.
- "position": { # The position of the place.
- "latitude": 3.14, # The latitude of this position.
- "longitude": 3.14, # The longitude of this position.
- },
- "kind": "plus#place", # Identifies this resource as a place. Value: "plus#place".
- "displayName": "A String", # The display name of the place.
- "id": "A String", # The id of the place.
- "address": { # The physical address of the place.
- "formatted": "A String", # The formatted address for display.
- },
- },
"address": "A String", # Street address where this activity occurred.
"crosspostSource": "A String", # If this activity is a crosspost from another system, this property specifies the ID of the original activity.
+ "placeholder": True or False, # True if this activity is a placeholder.
"annotation": "A String", # Additional content added by the person who shared this activity, applicable only when resharing an activity.
"published": "A String", # The time at which this activity was initially published. Formatted as an RFC 3339 timestamp.
},
],
"updated": "A String", # The time at which this collection of activities was last updated. Formatted as an RFC 3339 timestamp.
"nextLink": "A String", # Link to the next page of activities.
- "etag": "A String", # ETag of this response for caching purposes.
- "id": "A String", # The ID of this collection of activities. Deprecated.
+ "id": "A String", # The ID of this collection of activities.
"selfLink": "A String", # Link to this activity resource.
}</pre>
</div>
diff --git a/docs/dyn/plus_v1.comments.html b/docs/dyn/plus_v1.comments.html
index 7565bdb..e0e0e1b 100644
--- a/docs/dyn/plus_v1.comments.html
+++ b/docs/dyn/plus_v1.comments.html
@@ -78,7 +78,7 @@
<code><a href="#get">get(commentId)</a></code></p>
<p class="firstline">Get a comment.</p>
<p class="toc_element">
- <code><a href="#list">list(activityId, pageToken=None, maxResults=None, sortOrder=None)</a></code></p>
+ <code><a href="#list">list(activityId, pageToken=None, maxResults=None)</a></code></p>
<p class="firstline">List all of the comments for an activity.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -97,40 +97,27 @@
{
"inReplyTo": [ # The activity this comment replied to.
{
- "url": "A String", # The URL of the activity.
- "id": "A String", # The ID of the activity.
+ "url": "A String", # The url of the activity.
+ "id": "A String", # The id of the activity.
},
],
"kind": "plus#comment", # Identifies this resource as a comment. Value: "plus#comment".
- "plusoners": { # People who +1'd this comment.
- "totalItems": 42, # Total number of people who +1'd this comment.
- },
"object": { # The object of this comment.
- "content": "A String", # The HTML-formatted content, suitable for display.
- "originalContent": "A String", # The content (text) as provided by the author, stored without any HTML formatting. When creating or updating a comment, this value must be supplied as plain text in the request.
+ "content": "A String", # The content of this comment.
"objectType": "comment", # The object type of this comment. Possible values are:
# - "comment" - A comment in reply to an activity.
},
"updated": "A String", # The time at which this comment was last updated. Formatted as an RFC 3339 timestamp.
"actor": { # The person who posted this comment.
- "displayName": "A String", # The name of this actor, suitable for display.
- "url": "A String", # A link to the Person resource for this actor.
+ "url": "A String", # A link to the person resource for this actor.
"image": { # The image representation of this actor.
- "url": "A String", # The URL of the actor's profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
+ "url": "A String", # The URL of the actor's profile photo. To re-size the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
},
- "clientSpecificActorInfo": { # Actor info specific to particular clients.
- "youtubeActorInfo": { # Actor info specific to YouTube clients.
- "channelId": "A String", # ID of the YouTube channel owned by the Actor.
- },
- },
- "verification": { # Verification status of actor.
- "adHocVerified": "A String", # Verification for one-time or manual processes.
- },
+ "displayName": "A String", # The name of this actor, suitable for display.
"id": "A String", # The ID of the actor.
},
"verb": "post", # This comment's verb, indicating what action was performed. Possible values are:
# - "post" - Publish content to the stream.
- "etag": "A String", # ETag of this response for caching purposes.
"published": "A String", # The time at which this comment was initially published. Formatted as an RFC 3339 timestamp.
"id": "A String", # The ID of this comment.
"selfLink": "A String", # Link to this comment resource.
@@ -138,63 +125,46 @@
</div>
<div class="method">
- <code class="details" id="list">list(activityId, pageToken=None, maxResults=None, sortOrder=None)</code>
+ <code class="details" id="list">list(activityId, pageToken=None, maxResults=None)</code>
<pre>List all of the comments for an activity.
Args:
activityId: string, The ID of the activity to get comments for. (required)
- pageToken: string, The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.
- maxResults: integer, The maximum number of comments to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.
- sortOrder: string, The order in which to sort the list of comments.
- Allowed values
- ascending - Sort oldest comments first.
- descending - Sort newest comments first.
+ pageToken: string, The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.
+ maxResults: integer, The maximum number of comments to include in the response, used for paging. For any response, the actual number returned may be less than the specified maxResults.
Returns:
An object of the form:
{
- "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.
+ "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
"kind": "plus#commentFeed", # Identifies this resource as a collection of comments. Value: "plus#commentFeed".
"title": "A String", # The title of this collection of comments.
"items": [ # The comments in this page of results.
{
"inReplyTo": [ # The activity this comment replied to.
{
- "url": "A String", # The URL of the activity.
- "id": "A String", # The ID of the activity.
+ "url": "A String", # The url of the activity.
+ "id": "A String", # The id of the activity.
},
],
"kind": "plus#comment", # Identifies this resource as a comment. Value: "plus#comment".
- "plusoners": { # People who +1'd this comment.
- "totalItems": 42, # Total number of people who +1'd this comment.
- },
"object": { # The object of this comment.
- "content": "A String", # The HTML-formatted content, suitable for display.
- "originalContent": "A String", # The content (text) as provided by the author, stored without any HTML formatting. When creating or updating a comment, this value must be supplied as plain text in the request.
+ "content": "A String", # The content of this comment.
"objectType": "comment", # The object type of this comment. Possible values are:
# - "comment" - A comment in reply to an activity.
},
"updated": "A String", # The time at which this comment was last updated. Formatted as an RFC 3339 timestamp.
"actor": { # The person who posted this comment.
- "displayName": "A String", # The name of this actor, suitable for display.
- "url": "A String", # A link to the Person resource for this actor.
+ "url": "A String", # A link to the person resource for this actor.
"image": { # The image representation of this actor.
- "url": "A String", # The URL of the actor's profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
+ "url": "A String", # The URL of the actor's profile photo. To re-size the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
},
- "clientSpecificActorInfo": { # Actor info specific to particular clients.
- "youtubeActorInfo": { # Actor info specific to YouTube clients.
- "channelId": "A String", # ID of the YouTube channel owned by the Actor.
- },
- },
- "verification": { # Verification status of actor.
- "adHocVerified": "A String", # Verification for one-time or manual processes.
- },
+ "displayName": "A String", # The name of this actor, suitable for display.
"id": "A String", # The ID of the actor.
},
"verb": "post", # This comment's verb, indicating what action was performed. Possible values are:
# - "post" - Publish content to the stream.
- "etag": "A String", # ETag of this response for caching purposes.
"published": "A String", # The time at which this comment was initially published. Formatted as an RFC 3339 timestamp.
"id": "A String", # The ID of this comment.
"selfLink": "A String", # Link to this comment resource.
@@ -202,7 +172,6 @@
],
"updated": "A String", # The time at which this collection of comments was last updated. Formatted as an RFC 3339 timestamp.
"nextLink": "A String", # Link to the next page of activities.
- "etag": "A String", # ETag of this response for caching purposes.
"id": "A String", # The ID of this collection of comments.
}</pre>
</div>
diff --git a/docs/dyn/plus_v1.people.html b/docs/dyn/plus_v1.people.html
index e23259e..9e4638e 100644
--- a/docs/dyn/plus_v1.people.html
+++ b/docs/dyn/plus_v1.people.html
@@ -76,10 +76,7 @@
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(userId)</a></code></p>
-<p class="firstline">Get a person's profile. If your app uses scope https://www.googleapis.com/auth/plus.login, this method is guaranteed to return ageRange and language.</p>
-<p class="toc_element">
- <code><a href="#list">list(userId, collection, orderBy=None, pageToken=None, maxResults=None)</a></code></p>
-<p class="firstline">List all of the people in the specified collection.</p>
+<p class="firstline">Get a person's profile.</p>
<p class="toc_element">
<code><a href="#listByActivity">listByActivity(activityId, collection, pageToken=None, maxResults=None)</a></code></p>
<p class="firstline">List all of the people in the specified collection for a particular activity.</p>
@@ -87,9 +84,6 @@
<code><a href="#listByActivity_next">listByActivity_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</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>
-<p class="toc_element">
<code><a href="#search">search(query, pageToken=None, language=None, maxResults=None)</a></code></p>
<p class="firstline">Search all public profiles.</p>
<p class="toc_element">
@@ -98,7 +92,7 @@
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(userId)</code>
- <pre>Get a person's profile. If your app uses scope https://www.googleapis.com/auth/plus.login, this method is guaranteed to return ageRange and language.
+ <pre>Get a person's profile.
Args:
userId: string, The ID of the person to get the profile for. The special value "me" can be used to indicate the authenticated user. (required)
@@ -107,23 +101,7 @@
An object of the form:
{
- "braggingRights": "A String", # The "bragging rights" line of this person.
- "image": { # The representation of the person's profile photo.
- "url": "A String", # The URL of the person's profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
- "isDefault": True or False, # Whether the person's profile photo is the default one
- },
- "domain": "A String", # The hosted domain name for the user's Google Apps account. For instance, example.com. The plus.profile.emails.read or email scope is needed to get this domain name.
- "id": "A String", # The ID of this person.
- "occupation": "A String", # The occupation of this person.
- "verified": True or False, # Whether the person or Google+ Page has been verified.
- "tagline": "A String", # The brief description (tagline) of this person.
- "currentLocation": "A String", # (this field is not currently used)
- "etag": "A String", # ETag of this response for caching purposes.
- "circledByCount": 42, # For followers who are visible, the number of people who have added this person or page to a circle.
- "objectType": "A String", # Type of person within Google+. Possible values include, but are not limited to, the following values:
- # - "person" - represents an actual person.
- # - "page" - represents a page.
- "relationshipStatus": "A String", # The person's relationship status. Possible values include, but are not limited to, the following values:
+ "relationshipStatus": "A String", # The person's relationship status. Possible values are:
# - "single" - Person is single.
# - "in_a_relationship" - Person is in a relationship.
# - "engaged" - Person is engaged.
@@ -133,42 +111,23 @@
# - "widowed" - Person is widowed.
# - "in_domestic_partnership" - Person is in a domestic partnership.
# - "in_civil_union" - Person is in a civil union.
- "aboutMe": "A String", # A short biography for this person.
- "placesLived": [ # A list of places where this person has lived.
- {
- "primary": True or False, # If "true", this place of residence is this person's primary residence.
- "value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto".
- },
- ],
- "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
- "nickname": "A String", # The nickname of this person.
- "emails": [ # A list of email addresses that this person has, including their Google account email address, and the public verified email addresses on their Google+ profile. The plus.profile.emails.read scope is needed to retrieve these email addresses, or the email scope can be used to retrieve just the Google account email address.
- {
- "type": "A String", # The type of address. Possible values include, but are not limited to, the following values:
- # - "account" - Google account email address.
- # - "home" - Home email address.
- # - "work" - Work email address.
- # - "other" - Other.
- "value": "A String", # The email address.
- },
- ],
"organizations": [ # A list of current or past organizations with which this person is associated.
{
- "startDate": "A String", # The date that the person joined this organization.
- "endDate": "A String", # The date that the person left this organization.
- "description": "A String", # A short description of the person's role in this organization. Deprecated.
+ "startDate": "A String", # The date the person joined this organization.
+ "endDate": "A String", # The date the person left this organization.
+ "description": "A String", # A short description of the person's role in this organization.
"title": "A String", # The person's job title or role within the organization.
- "primary": True or False, # If "true", indicates this organization is the person's primary one, which is typically interpreted as the current one.
- "location": "A String", # The location of this organization. Deprecated.
- "department": "A String", # The department within the organization. Deprecated.
- "type": "A String", # The type of organization. Possible values include, but are not limited to, the following values:
+ "primary": True or False, # If "true", indicates this organization is the person's primary one (typically interpreted as current one).
+ "location": "A String", # The location of this organization.
+ "department": "A String", # The department within the organization.
+ "type": "A String", # The type of organization. Possible values are:
# - "work" - Work.
# - "school" - School.
"name": "A String", # The name of the organization.
},
],
"kind": "plus#person", # Identifies this resource as a person. Value: "plus#person".
- "displayName": "A String", # The name of this person, which is suitable for display.
+ "displayName": "A String", # The name of this person, suitable for display.
"name": { # An object representation of the individual components of a person's name.
"honorificPrefix": "A String", # The honorific prefixes (such as "Dr." or "Mrs.") for this person.
"middleName": "A String", # The middle name of this person.
@@ -177,192 +136,52 @@
"givenName": "A String", # The given name (first name) of this person.
"honorificSuffix": "A String", # The honorific suffixes (such as "Jr.") for this person.
},
- "language": "A String", # The user's preferred language for rendering.
- "skills": "A String", # The person's skills.
- "gender": "A String", # The person's gender. Possible values include, but are not limited to, the following values:
+ "url": "A String", # The URL of this person's profile.
+ "gender": "A String", # The person's gender. Possible values are:
# - "male" - Male gender.
# - "female" - Female gender.
# - "other" - Other.
- "cover": { # The cover photo content.
- "layout": "A String", # The layout of the cover art. Possible values include, but are not limited to, the following values:
- # - "banner" - One large image banner.
- "coverInfo": { # Extra information about the cover photo.
- "leftImageOffset": 42, # The difference between the left position of the cover image and the actual displayed cover image. Only valid for banner layout.
- "topImageOffset": 42, # The difference between the top position of the cover image and the actual displayed cover image. Only valid for banner layout.
+ "aboutMe": "A String", # A short biography for this person.
+ "tagline": "A String", # The brief description (tagline) of this person.
+ "placesLived": [ # A list of places where this person has lived.
+ {
+ "primary": True or False, # If "true", this place of residence is this person's primary residence.
+ "value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto".
},
- "coverPhoto": { # The person's primary cover image.
- "url": "A String", # The URL of the image.
- "width": 42, # The width of the image.
- "height": 42, # The height of the image.
+ ],
+ "emails": [ # A list of email addresses for this person.
+ {
+ "type": "A String", # The type of address. Possible values are:
+ # - "home" - Home email address.
+ # - "work" - Work email address.
+ # - "other" - Other.
+ "primary": True or False, # If "true", indicates this email address is the person's primary one.
+ "value": "A String", # The email address.
},
- },
- "url": "A String", # The URL of this person's profile.
- "isPlusUser": True or False, # Whether this user has signed up for Google+.
- "plusOneCount": 42, # If a Google+ Page, the number of people who have +1'd this page.
+ ],
+ "nickname": "A String", # The nickname of this person.
+ "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
"urls": [ # A list of URLs for this person.
{
- "type": "A String", # The type of URL. Possible values include, but are not limited to, the following values:
- # - "otherProfile" - URL for another profile.
- # - "contributor" - URL to a site for which this person is a contributor.
- # - "website" - URL for this Google+ Page's primary website.
- # - "other" - Other URL.
- "value": "A String", # The URL value.
- "label": "A String", # The label of the URL.
- },
- ],
- "ageRange": { # The age range of the person. Valid ranges are 17 or younger, 18 to 20, and 21 or older. Age is determined from the user's birthday using Western age reckoning.
- "max": 42, # The age range's upper bound, if any. Possible values include, but are not limited to, the following:
- # - "17" - for age 17
- # - "20" - for age 20
- "min": 42, # The age range's lower bound, if any. Possible values include, but are not limited to, the following:
- # - "21" - for age 21
- # - "18" - for age 18
- },
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(userId, collection, orderBy=None, pageToken=None, maxResults=None)</code>
- <pre>List all of the people in the specified collection.
-
-Args:
- userId: string, Get the collection of people for the person identified. Use "me" to indicate the authenticated user. (required)
- collection: string, The collection of people to list. (required)
- Allowed values
- connected - The list of visible people in the authenticated user's circles who also use the requesting app. This list is limited to users who made their app activities visible to the authenticated user.
- visible - The list of people who this user has added to one or more circles, limited to the circles visible to the requesting application.
- orderBy: string, The order to return people in.
- Allowed values
- alphabetical - Order the people by their display name.
- best - Order people based on the relevence to the viewer.
- pageToken: string, The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.
- maxResults: integer, The maximum number of people to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.
-
-Returns:
- An object of the form:
-
- {
- "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.
- "kind": "plus#peopleFeed", # Identifies this resource as a collection of people. Value: "plus#peopleFeed".
- "title": "A String", # The title of this collection of people.
- "items": [ # The people in this page of results. Each item includes the id, displayName, image, and url for the person. To retrieve additional profile data, see the people.get method.
- {
- "braggingRights": "A String", # The "bragging rights" line of this person.
- "image": { # The representation of the person's profile photo.
- "url": "A String", # The URL of the person's profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
- "isDefault": True or False, # Whether the person's profile photo is the default one
- },
- "domain": "A String", # The hosted domain name for the user's Google Apps account. For instance, example.com. The plus.profile.emails.read or email scope is needed to get this domain name.
- "id": "A String", # The ID of this person.
- "occupation": "A String", # The occupation of this person.
- "verified": True or False, # Whether the person or Google+ Page has been verified.
- "tagline": "A String", # The brief description (tagline) of this person.
- "currentLocation": "A String", # (this field is not currently used)
- "etag": "A String", # ETag of this response for caching purposes.
- "circledByCount": 42, # For followers who are visible, the number of people who have added this person or page to a circle.
- "objectType": "A String", # Type of person within Google+. Possible values include, but are not limited to, the following values:
- # - "person" - represents an actual person.
- # - "page" - represents a page.
- "relationshipStatus": "A String", # The person's relationship status. Possible values include, but are not limited to, the following values:
- # - "single" - Person is single.
- # - "in_a_relationship" - Person is in a relationship.
- # - "engaged" - Person is engaged.
- # - "married" - Person is married.
- # - "its_complicated" - The relationship is complicated.
- # - "open_relationship" - Person is in an open relationship.
- # - "widowed" - Person is widowed.
- # - "in_domestic_partnership" - Person is in a domestic partnership.
- # - "in_civil_union" - Person is in a civil union.
- "aboutMe": "A String", # A short biography for this person.
- "placesLived": [ # A list of places where this person has lived.
- {
- "primary": True or False, # If "true", this place of residence is this person's primary residence.
- "value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto".
- },
- ],
- "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
- "nickname": "A String", # The nickname of this person.
- "emails": [ # A list of email addresses that this person has, including their Google account email address, and the public verified email addresses on their Google+ profile. The plus.profile.emails.read scope is needed to retrieve these email addresses, or the email scope can be used to retrieve just the Google account email address.
- {
- "type": "A String", # The type of address. Possible values include, but are not limited to, the following values:
- # - "account" - Google account email address.
- # - "home" - Home email address.
- # - "work" - Work email address.
- # - "other" - Other.
- "value": "A String", # The email address.
- },
- ],
- "organizations": [ # A list of current or past organizations with which this person is associated.
- {
- "startDate": "A String", # The date that the person joined this organization.
- "endDate": "A String", # The date that the person left this organization.
- "description": "A String", # A short description of the person's role in this organization. Deprecated.
- "title": "A String", # The person's job title or role within the organization.
- "primary": True or False, # If "true", indicates this organization is the person's primary one, which is typically interpreted as the current one.
- "location": "A String", # The location of this organization. Deprecated.
- "department": "A String", # The department within the organization. Deprecated.
- "type": "A String", # The type of organization. Possible values include, but are not limited to, the following values:
- # - "work" - Work.
- # - "school" - School.
- "name": "A String", # The name of the organization.
- },
- ],
- "kind": "plus#person", # Identifies this resource as a person. Value: "plus#person".
- "displayName": "A String", # The name of this person, which is suitable for display.
- "name": { # An object representation of the individual components of a person's name.
- "honorificPrefix": "A String", # The honorific prefixes (such as "Dr." or "Mrs.") for this person.
- "middleName": "A String", # The middle name of this person.
- "familyName": "A String", # The family name (last name) of this person.
- "formatted": "A String", # The full name of this person, including middle names, suffixes, etc.
- "givenName": "A String", # The given name (first name) of this person.
- "honorificSuffix": "A String", # The honorific suffixes (such as "Jr.") for this person.
- },
- "language": "A String", # The user's preferred language for rendering.
- "skills": "A String", # The person's skills.
- "gender": "A String", # The person's gender. Possible values include, but are not limited to, the following values:
- # - "male" - Male gender.
- # - "female" - Female gender.
+ "type": "A String", # The type of URL. Possible values are:
+ # - "home" - URL for home.
+ # - "work" - URL for work.
+ # - "blog" - URL for blog.
+ # - "profile" - URL for profile.
# - "other" - Other.
- "cover": { # The cover photo content.
- "layout": "A String", # The layout of the cover art. Possible values include, but are not limited to, the following values:
- # - "banner" - One large image banner.
- "coverInfo": { # Extra information about the cover photo.
- "leftImageOffset": 42, # The difference between the left position of the cover image and the actual displayed cover image. Only valid for banner layout.
- "topImageOffset": 42, # The difference between the top position of the cover image and the actual displayed cover image. Only valid for banner layout.
- },
- "coverPhoto": { # The person's primary cover image.
- "url": "A String", # The URL of the image.
- "width": 42, # The width of the image.
- "height": 42, # The height of the image.
- },
- },
- "url": "A String", # The URL of this person's profile.
- "isPlusUser": True or False, # Whether this user has signed up for Google+.
- "plusOneCount": 42, # If a Google+ Page, the number of people who have +1'd this page.
- "urls": [ # A list of URLs for this person.
- {
- "type": "A String", # The type of URL. Possible values include, but are not limited to, the following values:
- # - "otherProfile" - URL for another profile.
- # - "contributor" - URL to a site for which this person is a contributor.
- # - "website" - URL for this Google+ Page's primary website.
- # - "other" - Other URL.
- "value": "A String", # The URL value.
- "label": "A String", # The label of the URL.
- },
- ],
- "ageRange": { # The age range of the person. Valid ranges are 17 or younger, 18 to 20, and 21 or older. Age is determined from the user's birthday using Western age reckoning.
- "max": 42, # The age range's upper bound, if any. Possible values include, but are not limited to, the following:
- # - "17" - for age 17
- # - "20" - for age 20
- "min": 42, # The age range's lower bound, if any. Possible values include, but are not limited to, the following:
- # - "21" - for age 21
- # - "18" - for age 18
- },
+ "primary": True or False, # If "true", this URL is the person's primary URL.
+ "value": "A String", # The URL value.
},
],
- "etag": "A String", # ETag of this response for caching purposes.
- "totalItems": 42, # The total number of people available in this list. The number of people in a response might be smaller due to paging. This might not be set for all collections.
- "selfLink": "A String", # Link to this resource.
+ "image": { # The representation of the person's profile photo.
+ "url": "A String", # The URL of the person's profile photo. To re-size the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
+ },
+ "hasApp": True or False, # If "true", indicates that the person has installed the app that is making the request and has chosen to expose this install state to the caller. A value of "false" indicates that the install state cannot be determined (it is either not installed or the person has chosen to keep this information private).
+ "id": "A String", # The ID of this person.
+ "languagesSpoken": [ # The languages spoken by this person.
+ "A String",
+ ],
+ "currentLocation": "A String", # The current location for this person.
}</pre>
</div>
@@ -376,35 +195,17 @@
Allowed values
plusoners - List all people who have +1'd this activity.
resharers - List all people who have reshared this activity.
- pageToken: string, The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.
- maxResults: integer, The maximum number of people to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.
+ pageToken: string, The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.
+ maxResults: integer, The maximum number of people to include in the response, used for paging. For any response, the actual number returned may be less than the specified maxResults.
Returns:
An object of the form:
{
- "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.
- "kind": "plus#peopleFeed", # Identifies this resource as a collection of people. Value: "plus#peopleFeed".
- "title": "A String", # The title of this collection of people.
- "items": [ # The people in this page of results. Each item includes the id, displayName, image, and url for the person. To retrieve additional profile data, see the people.get method.
+ "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
+ "items": [ # The people in this page of results. Each item will include the id, displayName, image, and url for the person. To retrieve additional profile data, see the people.get method.
{
- "braggingRights": "A String", # The "bragging rights" line of this person.
- "image": { # The representation of the person's profile photo.
- "url": "A String", # The URL of the person's profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
- "isDefault": True or False, # Whether the person's profile photo is the default one
- },
- "domain": "A String", # The hosted domain name for the user's Google Apps account. For instance, example.com. The plus.profile.emails.read or email scope is needed to get this domain name.
- "id": "A String", # The ID of this person.
- "occupation": "A String", # The occupation of this person.
- "verified": True or False, # Whether the person or Google+ Page has been verified.
- "tagline": "A String", # The brief description (tagline) of this person.
- "currentLocation": "A String", # (this field is not currently used)
- "etag": "A String", # ETag of this response for caching purposes.
- "circledByCount": 42, # For followers who are visible, the number of people who have added this person or page to a circle.
- "objectType": "A String", # Type of person within Google+. Possible values include, but are not limited to, the following values:
- # - "person" - represents an actual person.
- # - "page" - represents a page.
- "relationshipStatus": "A String", # The person's relationship status. Possible values include, but are not limited to, the following values:
+ "relationshipStatus": "A String", # The person's relationship status. Possible values are:
# - "single" - Person is single.
# - "in_a_relationship" - Person is in a relationship.
# - "engaged" - Person is engaged.
@@ -414,42 +215,23 @@
# - "widowed" - Person is widowed.
# - "in_domestic_partnership" - Person is in a domestic partnership.
# - "in_civil_union" - Person is in a civil union.
- "aboutMe": "A String", # A short biography for this person.
- "placesLived": [ # A list of places where this person has lived.
- {
- "primary": True or False, # If "true", this place of residence is this person's primary residence.
- "value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto".
- },
- ],
- "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
- "nickname": "A String", # The nickname of this person.
- "emails": [ # A list of email addresses that this person has, including their Google account email address, and the public verified email addresses on their Google+ profile. The plus.profile.emails.read scope is needed to retrieve these email addresses, or the email scope can be used to retrieve just the Google account email address.
- {
- "type": "A String", # The type of address. Possible values include, but are not limited to, the following values:
- # - "account" - Google account email address.
- # - "home" - Home email address.
- # - "work" - Work email address.
- # - "other" - Other.
- "value": "A String", # The email address.
- },
- ],
"organizations": [ # A list of current or past organizations with which this person is associated.
{
- "startDate": "A String", # The date that the person joined this organization.
- "endDate": "A String", # The date that the person left this organization.
- "description": "A String", # A short description of the person's role in this organization. Deprecated.
+ "startDate": "A String", # The date the person joined this organization.
+ "endDate": "A String", # The date the person left this organization.
+ "description": "A String", # A short description of the person's role in this organization.
"title": "A String", # The person's job title or role within the organization.
- "primary": True or False, # If "true", indicates this organization is the person's primary one, which is typically interpreted as the current one.
- "location": "A String", # The location of this organization. Deprecated.
- "department": "A String", # The department within the organization. Deprecated.
- "type": "A String", # The type of organization. Possible values include, but are not limited to, the following values:
+ "primary": True or False, # If "true", indicates this organization is the person's primary one (typically interpreted as current one).
+ "location": "A String", # The location of this organization.
+ "department": "A String", # The department within the organization.
+ "type": "A String", # The type of organization. Possible values are:
# - "work" - Work.
# - "school" - School.
"name": "A String", # The name of the organization.
},
],
"kind": "plus#person", # Identifies this resource as a person. Value: "plus#person".
- "displayName": "A String", # The name of this person, which is suitable for display.
+ "displayName": "A String", # The name of this person, suitable for display.
"name": { # An object representation of the individual components of a person's name.
"honorificPrefix": "A String", # The honorific prefixes (such as "Dr." or "Mrs.") for this person.
"middleName": "A String", # The middle name of this person.
@@ -458,52 +240,57 @@
"givenName": "A String", # The given name (first name) of this person.
"honorificSuffix": "A String", # The honorific suffixes (such as "Jr.") for this person.
},
- "language": "A String", # The user's preferred language for rendering.
- "skills": "A String", # The person's skills.
- "gender": "A String", # The person's gender. Possible values include, but are not limited to, the following values:
+ "url": "A String", # The URL of this person's profile.
+ "gender": "A String", # The person's gender. Possible values are:
# - "male" - Male gender.
# - "female" - Female gender.
# - "other" - Other.
- "cover": { # The cover photo content.
- "layout": "A String", # The layout of the cover art. Possible values include, but are not limited to, the following values:
- # - "banner" - One large image banner.
- "coverInfo": { # Extra information about the cover photo.
- "leftImageOffset": 42, # The difference between the left position of the cover image and the actual displayed cover image. Only valid for banner layout.
- "topImageOffset": 42, # The difference between the top position of the cover image and the actual displayed cover image. Only valid for banner layout.
- },
- "coverPhoto": { # The person's primary cover image.
- "url": "A String", # The URL of the image.
- "width": 42, # The width of the image.
- "height": 42, # The height of the image.
- },
- },
- "url": "A String", # The URL of this person's profile.
- "isPlusUser": True or False, # Whether this user has signed up for Google+.
- "plusOneCount": 42, # If a Google+ Page, the number of people who have +1'd this page.
- "urls": [ # A list of URLs for this person.
+ "aboutMe": "A String", # A short biography for this person.
+ "tagline": "A String", # The brief description (tagline) of this person.
+ "placesLived": [ # A list of places where this person has lived.
{
- "type": "A String", # The type of URL. Possible values include, but are not limited to, the following values:
- # - "otherProfile" - URL for another profile.
- # - "contributor" - URL to a site for which this person is a contributor.
- # - "website" - URL for this Google+ Page's primary website.
- # - "other" - Other URL.
- "value": "A String", # The URL value.
- "label": "A String", # The label of the URL.
+ "primary": True or False, # If "true", this place of residence is this person's primary residence.
+ "value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto".
},
],
- "ageRange": { # The age range of the person. Valid ranges are 17 or younger, 18 to 20, and 21 or older. Age is determined from the user's birthday using Western age reckoning.
- "max": 42, # The age range's upper bound, if any. Possible values include, but are not limited to, the following:
- # - "17" - for age 17
- # - "20" - for age 20
- "min": 42, # The age range's lower bound, if any. Possible values include, but are not limited to, the following:
- # - "21" - for age 21
- # - "18" - for age 18
+ "emails": [ # A list of email addresses for this person.
+ {
+ "type": "A String", # The type of address. Possible values are:
+ # - "home" - Home email address.
+ # - "work" - Work email address.
+ # - "other" - Other.
+ "primary": True or False, # If "true", indicates this email address is the person's primary one.
+ "value": "A String", # The email address.
+ },
+ ],
+ "nickname": "A String", # The nickname of this person.
+ "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
+ "urls": [ # A list of URLs for this person.
+ {
+ "type": "A String", # The type of URL. Possible values are:
+ # - "home" - URL for home.
+ # - "work" - URL for work.
+ # - "blog" - URL for blog.
+ # - "profile" - URL for profile.
+ # - "other" - Other.
+ "primary": True or False, # If "true", this URL is the person's primary URL.
+ "value": "A String", # The URL value.
+ },
+ ],
+ "image": { # The representation of the person's profile photo.
+ "url": "A String", # The URL of the person's profile photo. To re-size the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
},
+ "hasApp": True or False, # If "true", indicates that the person has installed the app that is making the request and has chosen to expose this install state to the caller. A value of "false" indicates that the install state cannot be determined (it is either not installed or the person has chosen to keep this information private).
+ "id": "A String", # The ID of this person.
+ "languagesSpoken": [ # The languages spoken by this person.
+ "A String",
+ ],
+ "currentLocation": "A String", # The current location for this person.
},
],
- "etag": "A String", # ETag of this response for caching purposes.
- "totalItems": 42, # The total number of people available in this list. The number of people in a response might be smaller due to paging. This might not be set for all collections.
+ "kind": "plus#peopleFeed", # Identifies this resource as a collection of people. Value: "plus#peopleFeed".
"selfLink": "A String", # Link to this resource.
+ "title": "A String", # The title of this collection of people.
}</pre>
</div>
@@ -522,55 +309,23 @@
</div>
<div class="method">
- <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
- <pre>Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-Returns:
- A request object that you can call 'execute()' on to request the next
- page. Returns None if there are no more items in the collection.
- </pre>
-</div>
-
-<div class="method">
<code class="details" id="search">search(query, pageToken=None, language=None, maxResults=None)</code>
<pre>Search all public profiles.
Args:
- query: string, Specify a query string for full text search of public text in all profiles. (required)
- pageToken: string, The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. This token can be of any length.
- language: string, Specify the preferred language to search with. See search language codes for available values.
- maxResults: integer, The maximum number of people to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.
+ query: string, Full-text search query string. (required)
+ pageToken: string, The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. This token may be of any length.
+ language: string, Specify the preferred language to search with. See Language Codes for available values.
+ maxResults: integer, The maximum number of people to include in the response, used for paging. For any response, the actual number returned may be less than the specified maxResults.
Returns:
An object of the form:
{
- "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.
- "kind": "plus#peopleFeed", # Identifies this resource as a collection of people. Value: "plus#peopleFeed".
- "title": "A String", # The title of this collection of people.
- "items": [ # The people in this page of results. Each item includes the id, displayName, image, and url for the person. To retrieve additional profile data, see the people.get method.
+ "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
+ "items": [ # The people in this page of results. Each item will include the id, displayName, image, and url for the person. To retrieve additional profile data, see the people.get method.
{
- "braggingRights": "A String", # The "bragging rights" line of this person.
- "image": { # The representation of the person's profile photo.
- "url": "A String", # The URL of the person's profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
- "isDefault": True or False, # Whether the person's profile photo is the default one
- },
- "domain": "A String", # The hosted domain name for the user's Google Apps account. For instance, example.com. The plus.profile.emails.read or email scope is needed to get this domain name.
- "id": "A String", # The ID of this person.
- "occupation": "A String", # The occupation of this person.
- "verified": True or False, # Whether the person or Google+ Page has been verified.
- "tagline": "A String", # The brief description (tagline) of this person.
- "currentLocation": "A String", # (this field is not currently used)
- "etag": "A String", # ETag of this response for caching purposes.
- "circledByCount": 42, # For followers who are visible, the number of people who have added this person or page to a circle.
- "objectType": "A String", # Type of person within Google+. Possible values include, but are not limited to, the following values:
- # - "person" - represents an actual person.
- # - "page" - represents a page.
- "relationshipStatus": "A String", # The person's relationship status. Possible values include, but are not limited to, the following values:
+ "relationshipStatus": "A String", # The person's relationship status. Possible values are:
# - "single" - Person is single.
# - "in_a_relationship" - Person is in a relationship.
# - "engaged" - Person is engaged.
@@ -580,42 +335,23 @@
# - "widowed" - Person is widowed.
# - "in_domestic_partnership" - Person is in a domestic partnership.
# - "in_civil_union" - Person is in a civil union.
- "aboutMe": "A String", # A short biography for this person.
- "placesLived": [ # A list of places where this person has lived.
- {
- "primary": True or False, # If "true", this place of residence is this person's primary residence.
- "value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto".
- },
- ],
- "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
- "nickname": "A String", # The nickname of this person.
- "emails": [ # A list of email addresses that this person has, including their Google account email address, and the public verified email addresses on their Google+ profile. The plus.profile.emails.read scope is needed to retrieve these email addresses, or the email scope can be used to retrieve just the Google account email address.
- {
- "type": "A String", # The type of address. Possible values include, but are not limited to, the following values:
- # - "account" - Google account email address.
- # - "home" - Home email address.
- # - "work" - Work email address.
- # - "other" - Other.
- "value": "A String", # The email address.
- },
- ],
"organizations": [ # A list of current or past organizations with which this person is associated.
{
- "startDate": "A String", # The date that the person joined this organization.
- "endDate": "A String", # The date that the person left this organization.
- "description": "A String", # A short description of the person's role in this organization. Deprecated.
+ "startDate": "A String", # The date the person joined this organization.
+ "endDate": "A String", # The date the person left this organization.
+ "description": "A String", # A short description of the person's role in this organization.
"title": "A String", # The person's job title or role within the organization.
- "primary": True or False, # If "true", indicates this organization is the person's primary one, which is typically interpreted as the current one.
- "location": "A String", # The location of this organization. Deprecated.
- "department": "A String", # The department within the organization. Deprecated.
- "type": "A String", # The type of organization. Possible values include, but are not limited to, the following values:
+ "primary": True or False, # If "true", indicates this organization is the person's primary one (typically interpreted as current one).
+ "location": "A String", # The location of this organization.
+ "department": "A String", # The department within the organization.
+ "type": "A String", # The type of organization. Possible values are:
# - "work" - Work.
# - "school" - School.
"name": "A String", # The name of the organization.
},
],
"kind": "plus#person", # Identifies this resource as a person. Value: "plus#person".
- "displayName": "A String", # The name of this person, which is suitable for display.
+ "displayName": "A String", # The name of this person, suitable for display.
"name": { # An object representation of the individual components of a person's name.
"honorificPrefix": "A String", # The honorific prefixes (such as "Dr." or "Mrs.") for this person.
"middleName": "A String", # The middle name of this person.
@@ -624,52 +360,57 @@
"givenName": "A String", # The given name (first name) of this person.
"honorificSuffix": "A String", # The honorific suffixes (such as "Jr.") for this person.
},
- "language": "A String", # The user's preferred language for rendering.
- "skills": "A String", # The person's skills.
- "gender": "A String", # The person's gender. Possible values include, but are not limited to, the following values:
+ "url": "A String", # The URL of this person's profile.
+ "gender": "A String", # The person's gender. Possible values are:
# - "male" - Male gender.
# - "female" - Female gender.
# - "other" - Other.
- "cover": { # The cover photo content.
- "layout": "A String", # The layout of the cover art. Possible values include, but are not limited to, the following values:
- # - "banner" - One large image banner.
- "coverInfo": { # Extra information about the cover photo.
- "leftImageOffset": 42, # The difference between the left position of the cover image and the actual displayed cover image. Only valid for banner layout.
- "topImageOffset": 42, # The difference between the top position of the cover image and the actual displayed cover image. Only valid for banner layout.
- },
- "coverPhoto": { # The person's primary cover image.
- "url": "A String", # The URL of the image.
- "width": 42, # The width of the image.
- "height": 42, # The height of the image.
- },
- },
- "url": "A String", # The URL of this person's profile.
- "isPlusUser": True or False, # Whether this user has signed up for Google+.
- "plusOneCount": 42, # If a Google+ Page, the number of people who have +1'd this page.
- "urls": [ # A list of URLs for this person.
+ "aboutMe": "A String", # A short biography for this person.
+ "tagline": "A String", # The brief description (tagline) of this person.
+ "placesLived": [ # A list of places where this person has lived.
{
- "type": "A String", # The type of URL. Possible values include, but are not limited to, the following values:
- # - "otherProfile" - URL for another profile.
- # - "contributor" - URL to a site for which this person is a contributor.
- # - "website" - URL for this Google+ Page's primary website.
- # - "other" - Other URL.
- "value": "A String", # The URL value.
- "label": "A String", # The label of the URL.
+ "primary": True or False, # If "true", this place of residence is this person's primary residence.
+ "value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto".
},
],
- "ageRange": { # The age range of the person. Valid ranges are 17 or younger, 18 to 20, and 21 or older. Age is determined from the user's birthday using Western age reckoning.
- "max": 42, # The age range's upper bound, if any. Possible values include, but are not limited to, the following:
- # - "17" - for age 17
- # - "20" - for age 20
- "min": 42, # The age range's lower bound, if any. Possible values include, but are not limited to, the following:
- # - "21" - for age 21
- # - "18" - for age 18
+ "emails": [ # A list of email addresses for this person.
+ {
+ "type": "A String", # The type of address. Possible values are:
+ # - "home" - Home email address.
+ # - "work" - Work email address.
+ # - "other" - Other.
+ "primary": True or False, # If "true", indicates this email address is the person's primary one.
+ "value": "A String", # The email address.
+ },
+ ],
+ "nickname": "A String", # The nickname of this person.
+ "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
+ "urls": [ # A list of URLs for this person.
+ {
+ "type": "A String", # The type of URL. Possible values are:
+ # - "home" - URL for home.
+ # - "work" - URL for work.
+ # - "blog" - URL for blog.
+ # - "profile" - URL for profile.
+ # - "other" - Other.
+ "primary": True or False, # If "true", this URL is the person's primary URL.
+ "value": "A String", # The URL value.
+ },
+ ],
+ "image": { # The representation of the person's profile photo.
+ "url": "A String", # The URL of the person's profile photo. To re-size the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
},
+ "hasApp": True or False, # If "true", indicates that the person has installed the app that is making the request and has chosen to expose this install state to the caller. A value of "false" indicates that the install state cannot be determined (it is either not installed or the person has chosen to keep this information private).
+ "id": "A String", # The ID of this person.
+ "languagesSpoken": [ # The languages spoken by this person.
+ "A String",
+ ],
+ "currentLocation": "A String", # The current location for this person.
},
],
- "etag": "A String", # ETag of this response for caching purposes.
- "totalItems": 42, # The total number of people available in this list. The number of people in a response might be smaller due to paging. This might not be set for all collections.
+ "kind": "plus#peopleFeed", # Identifies this resource as a collection of people. Value: "plus#peopleFeed".
"selfLink": "A String", # Link to this resource.
+ "title": "A String", # The title of this collection of people.
}</pre>
</div>
diff --git a/docs/dyn/pubsub_v1.projects.html b/docs/dyn/pubsub_v1.projects.html
index 205ae0b..f19d881 100644
--- a/docs/dyn/pubsub_v1.projects.html
+++ b/docs/dyn/pubsub_v1.projects.html
@@ -75,6 +75,11 @@
<h1><a href="pubsub_v1.html">Google Cloud Pub/Sub API</a> . <a href="pubsub_v1.projects.html">projects</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
+ <code><a href="pubsub_v1.projects.snapshots.html">snapshots()</a></code>
+</p>
+<p class="firstline">Returns the snapshots Resource.</p>
+
+<p class="toc_element">
<code><a href="pubsub_v1.projects.subscriptions.html">subscriptions()</a></code>
</p>
<p class="firstline">Returns the subscriptions Resource.</p>
diff --git a/docs/dyn/pubsub_v1.projects.snapshots.html b/docs/dyn/pubsub_v1.projects.snapshots.html
new file mode 100644
index 0000000..32dbf2c
--- /dev/null
+++ b/docs/dyn/pubsub_v1.projects.snapshots.html
@@ -0,0 +1,182 @@
+<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="pubsub_v1.html">Google Cloud Pub/Sub API</a> . <a href="pubsub_v1.projects.html">projects</a> . <a href="pubsub_v1.projects.snapshots.html">snapshots</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#getIamPolicy">getIamPolicy(resource, x__xgafv=None)</a></code></p>
+<p class="firstline">Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.</p>
+<p class="toc_element">
+ <code><a href="#setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="getIamPolicy">getIamPolicy(resource, x__xgafv=None)</code>
+ <pre>Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
+
+Args:
+ resource: string, REQUIRED: The resource for which the policy is being requested. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
+ "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
+ { # Associates `members` with a `role`.
+ "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
+ "A String",
+ ],
+ },
+ ],
+ "version": 42, # Version of the `Policy`. The default version is 0.
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</code>
+ <pre>Sets the access control policy on the specified resource. Replaces any existing policy.
+
+Args:
+ resource: string, REQUIRED: The resource for which the policy is being specified. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Request message for `SetIamPolicy` method.
+ "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
+ "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
+ { # Associates `members` with a `role`.
+ "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
+ "A String",
+ ],
+ },
+ ],
+ "version": 42, # Version of the `Policy`. The default version is 0.
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
+ },
+ }
+
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
+ "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
+ { # Associates `members` with a `role`.
+ "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
+ "A String",
+ ],
+ },
+ ],
+ "version": 42, # Version of the `Policy`. The default version is 0.
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ resource: string, REQUIRED: The resource for which the policy detail is being requested. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Request message for `TestIamPermissions` method.
+ "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
+ "A String",
+ ],
+ }
+
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # Response message for `TestIamPermissions` method.
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/pubsub_v1.projects.subscriptions.html b/docs/dyn/pubsub_v1.projects.subscriptions.html
index 40efcff..9bb150b 100644
--- a/docs/dyn/pubsub_v1.projects.subscriptions.html
+++ b/docs/dyn/pubsub_v1.projects.subscriptions.html
@@ -79,16 +79,16 @@
<p class="firstline">Acknowledges the messages associated with the `ack_ids` in the `AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages from the subscription. Acknowledging a message whose ack deadline has expired may succeed, but such a message may be redelivered later. Acknowledging a message more than once will not result in an error.</p>
<p class="toc_element">
<code><a href="#create">create(name, body, x__xgafv=None)</a></code></p>
-<p class="firstline">Creates a subscription to a given topic. If the subscription already exists, returns `ALREADY_EXISTS`. If the corresponding topic doesn't exist, returns `NOT_FOUND`. If the name is not provided in the request, the server will assign a random name for this subscription on the same project as the topic.</p>
+<p class="firstline">Creates a subscription to a given topic. If the subscription already exists, returns `ALREADY_EXISTS`. If the corresponding topic doesn't exist, returns `NOT_FOUND`. If the name is not provided in the request, the server will assign a random name for this subscription on the same project as the topic. Note that for REST API requests, you must specify a name.</p>
<p class="toc_element">
<code><a href="#delete">delete(subscription, x__xgafv=None)</a></code></p>
-<p class="firstline">Deletes an existing subscription. All pending messages in the subscription are immediately dropped. Calls to `Pull` after deletion will return `NOT_FOUND`. After a subscription is deleted, a new one may be created with the same name, but the new one has no association with the old subscription, or its topic unless the same topic is specified.</p>
+<p class="firstline">Deletes an existing subscription. All messages retained in the subscription are immediately dropped. Calls to `Pull` after deletion will return `NOT_FOUND`. After a subscription is deleted, a new one may be created with the same name, but the new one has no association with the old subscription or its topic unless the same topic is specified.</p>
<p class="toc_element">
<code><a href="#get">get(subscription, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the configuration details of a subscription.</p>
<p class="toc_element">
<code><a href="#getIamPolicy">getIamPolicy(resource, x__xgafv=None)</a></code></p>
-<p class="firstline">Gets the access control policy for a `resource`. Returns an empty policy if the resource exists and does not have a policy set.</p>
+<p class="firstline">Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.</p>
<p class="toc_element">
<code><a href="#list">list(project, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists matching subscriptions.</p>
@@ -97,7 +97,7 @@
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#modifyAckDeadline">modifyAckDeadline(subscription, body, x__xgafv=None)</a></code></p>
-<p class="firstline">Modifies the ack deadline for a specific message. This method is useful to indicate that more time is needed to process a message by the subscriber, or to make the message available for redelivery if the processing was interrupted.</p>
+<p class="firstline">Modifies the ack deadline for a specific message. This method is useful to indicate that more time is needed to process a message by the subscriber, or to make the message available for redelivery if the processing was interrupted. Note that this does not modify the subscription-level `ackDeadlineSeconds` used for subsequent messages.</p>
<p class="toc_element">
<code><a href="#modifyPushConfig">modifyPushConfig(subscription, body, x__xgafv=None)</a></code></p>
<p class="firstline">Modifies the `PushConfig` for a specified subscription. This may be used to change a push subscription to a pull one (signified by an empty `PushConfig`) or vice versa, or change the endpoint URL and other attributes of a push subscription. Messages will accumulate for delivery continuously through the call regardless of changes to the `PushConfig`.</p>
@@ -137,7 +137,7 @@
<div class="method">
<code class="details" id="create">create(name, body, x__xgafv=None)</code>
- <pre>Creates a subscription to a given topic. If the subscription already exists, returns `ALREADY_EXISTS`. If the corresponding topic doesn't exist, returns `NOT_FOUND`. If the name is not provided in the request, the server will assign a random name for this subscription on the same project as the topic.
+ <pre>Creates a subscription to a given topic. If the subscription already exists, returns `ALREADY_EXISTS`. If the corresponding topic doesn't exist, returns `NOT_FOUND`. If the name is not provided in the request, the server will assign a random name for this subscription on the same project as the topic. Note that for REST API requests, you must specify a name.
Args:
name: string, The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. (required)
@@ -146,7 +146,7 @@
{ # A subscription resource.
"topic": "A String", # The name of the topic from which this subscription is receiving messages. The value of this field will be `_deleted-topic_` if the topic has been deleted.
- "ackDeadlineSeconds": 42, # This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id` if using pull. For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. If this parameter is not set, the default value of 10 seconds is used.
+ "ackDeadlineSeconds": 42, # This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id` if using pull. The maximum custom deadline you can specify is 600 seconds (10 minutes). For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. If this parameter is 0, a default value of 10 seconds is used.
"pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it. An empty `pushConfig` signifies that the subscriber will pull and ack messages using API methods.
"attributes": { # Endpoint configuration attributes. Every endpoint has a set of API supported attributes that can be used to control different aspects of the message delivery. The currently supported attribute is `x-goog-version`, which you can use to change the format of the push message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the envelope (i.e. its fields and metadata). The endpoint version is based on the version of the Pub/Sub API. If not present during the `CreateSubscription` call, it will default to the version of the API used to make such call. If not present during a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The possible values for this attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
"a_key": "A String",
@@ -163,7 +163,7 @@
{ # A subscription resource.
"topic": "A String", # The name of the topic from which this subscription is receiving messages. The value of this field will be `_deleted-topic_` if the topic has been deleted.
- "ackDeadlineSeconds": 42, # This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id` if using pull. For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. If this parameter is not set, the default value of 10 seconds is used.
+ "ackDeadlineSeconds": 42, # This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id` if using pull. The maximum custom deadline you can specify is 600 seconds (10 minutes). For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. If this parameter is 0, a default value of 10 seconds is used.
"pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it. An empty `pushConfig` signifies that the subscriber will pull and ack messages using API methods.
"attributes": { # Endpoint configuration attributes. Every endpoint has a set of API supported attributes that can be used to control different aspects of the message delivery. The currently supported attribute is `x-goog-version`, which you can use to change the format of the push message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the envelope (i.e. its fields and metadata). The endpoint version is based on the version of the Pub/Sub API. If not present during the `CreateSubscription` call, it will default to the version of the API used to make such call. If not present during a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The possible values for this attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
"a_key": "A String",
@@ -176,7 +176,7 @@
<div class="method">
<code class="details" id="delete">delete(subscription, x__xgafv=None)</code>
- <pre>Deletes an existing subscription. All pending messages in the subscription are immediately dropped. Calls to `Pull` after deletion will return `NOT_FOUND`. After a subscription is deleted, a new one may be created with the same name, but the new one has no association with the old subscription, or its topic unless the same topic is specified.
+ <pre>Deletes an existing subscription. All messages retained in the subscription are immediately dropped. Calls to `Pull` after deletion will return `NOT_FOUND`. After a subscription is deleted, a new one may be created with the same name, but the new one has no association with the old subscription or its topic unless the same topic is specified.
Args:
subscription: string, The subscription to delete. (required)
@@ -202,7 +202,7 @@
{ # A subscription resource.
"topic": "A String", # The name of the topic from which this subscription is receiving messages. The value of this field will be `_deleted-topic_` if the topic has been deleted.
- "ackDeadlineSeconds": 42, # This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id` if using pull. For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. If this parameter is not set, the default value of 10 seconds is used.
+ "ackDeadlineSeconds": 42, # This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id` if using pull. The maximum custom deadline you can specify is 600 seconds (10 minutes). For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. If this parameter is 0, a default value of 10 seconds is used.
"pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it. An empty `pushConfig` signifies that the subscriber will pull and ack messages using API methods.
"attributes": { # Endpoint configuration attributes. Every endpoint has a set of API supported attributes that can be used to control different aspects of the message delivery. The currently supported attribute is `x-goog-version`, which you can use to change the format of the push message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the envelope (i.e. its fields and metadata). The endpoint version is based on the version of the Pub/Sub API. If not present during the `CreateSubscription` call, it will default to the version of the API used to make such call. If not present during a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The possible values for this attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
"a_key": "A String",
@@ -215,10 +215,10 @@
<div class="method">
<code class="details" id="getIamPolicy">getIamPolicy(resource, x__xgafv=None)</code>
- <pre>Gets the access control policy for a `resource`. Returns an empty policy if the resource exists and does not have a policy set.
+ <pre>Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Args:
- resource: string, REQUIRED: The resource for which the policy is being requested. `resource` is usually specified as a path, such as `projects/*project*/zones/*zone*/disks/*disk*`. The format for the path specified in this value is resource specific and is specified in the `getIamPolicy` documentation. (required)
+ resource: string, REQUIRED: The resource for which the policy is being requested. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
x__xgafv: string, V1 error format.
Returns:
@@ -256,7 +256,7 @@
"subscriptions": [ # The subscriptions that match the request.
{ # A subscription resource.
"topic": "A String", # The name of the topic from which this subscription is receiving messages. The value of this field will be `_deleted-topic_` if the topic has been deleted.
- "ackDeadlineSeconds": 42, # This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id` if using pull. For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. If this parameter is not set, the default value of 10 seconds is used.
+ "ackDeadlineSeconds": 42, # This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id` if using pull. The maximum custom deadline you can specify is 600 seconds (10 minutes). For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. If this parameter is 0, a default value of 10 seconds is used.
"pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it. An empty `pushConfig` signifies that the subscriber will pull and ack messages using API methods.
"attributes": { # Endpoint configuration attributes. Every endpoint has a set of API supported attributes that can be used to control different aspects of the message delivery. The currently supported attribute is `x-goog-version`, which you can use to change the format of the push message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the envelope (i.e. its fields and metadata). The endpoint version is based on the version of the Pub/Sub API. If not present during the `CreateSubscription` call, it will default to the version of the API used to make such call. If not present during a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The possible values for this attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
"a_key": "A String",
@@ -285,7 +285,7 @@
<div class="method">
<code class="details" id="modifyAckDeadline">modifyAckDeadline(subscription, body, x__xgafv=None)</code>
- <pre>Modifies the ack deadline for a specific message. This method is useful to indicate that more time is needed to process a message by the subscriber, or to make the message available for redelivery if the processing was interrupted.
+ <pre>Modifies the ack deadline for a specific message. This method is useful to indicate that more time is needed to process a message by the subscriber, or to make the message available for redelivery if the processing was interrupted. Note that this does not modify the subscription-level `ackDeadlineSeconds` used for subsequent messages.
Args:
subscription: string, The name of the subscription. (required)
@@ -362,7 +362,7 @@
"attributes": { # Optional attributes for this message.
"a_key": "A String",
},
- "data": "A String", # The message payload. For JSON requests, the value of this field must be base64-encoded.
+ "data": "A String", # The message payload. For JSON requests, the value of this field must be [base64-encoded](https://tools.ietf.org/html/rfc4648).
"publishTime": "A String", # The time at which the message was published, populated by the server when it receives the `Publish` call. It must not be populated by the publisher in a `Publish` call.
"messageId": "A String", # ID of this message, assigned by the server when the message is published. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a `PubsubMessage` via a `Pull` call or a push delivery. It must not be populated by the publisher in a `Publish` call.
},
@@ -376,7 +376,7 @@
<pre>Sets the access control policy on the specified resource. Replaces any existing policy.
Args:
- resource: string, REQUIRED: The resource for which the policy is being specified. `resource` is usually specified as a path, such as `projects/*project*/zones/*zone*/disks/*disk*`. The format for the path specified in this value is resource specific and is specified in the `setIamPolicy` documentation. (required)
+ resource: string, REQUIRED: The resource for which the policy is being specified. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
body: object, The request body. (required)
The object takes the form of:
@@ -419,12 +419,12 @@
<pre>Returns permissions that a caller has on the specified resource.
Args:
- resource: string, REQUIRED: The resource for which the policy detail is being requested. `resource` is usually specified as a path, such as `projects/*project*/zones/*zone*/disks/*disk*`. The format for the path specified in this value is resource specific and is specified in the `testIamPermissions` documentation. (required)
+ resource: string, REQUIRED: The resource for which the policy detail is being requested. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Request message for `TestIamPermissions` method.
- "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see IAM Overview.
+ "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
"A String",
],
}
diff --git a/docs/dyn/pubsub_v1.projects.topics.html b/docs/dyn/pubsub_v1.projects.topics.html
index a199f91..0d960fa 100644
--- a/docs/dyn/pubsub_v1.projects.topics.html
+++ b/docs/dyn/pubsub_v1.projects.topics.html
@@ -90,7 +90,7 @@
<p class="firstline">Gets the configuration of a topic.</p>
<p class="toc_element">
<code><a href="#getIamPolicy">getIamPolicy(resource, x__xgafv=None)</a></code></p>
-<p class="firstline">Gets the access control policy for a `resource`. Returns an empty policy if the resource exists and does not have a policy set.</p>
+<p class="firstline">Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.</p>
<p class="toc_element">
<code><a href="#list">list(project, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists matching topics.</p>
@@ -163,10 +163,10 @@
<div class="method">
<code class="details" id="getIamPolicy">getIamPolicy(resource, x__xgafv=None)</code>
- <pre>Gets the access control policy for a `resource`. Returns an empty policy if the resource exists and does not have a policy set.
+ <pre>Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Args:
- resource: string, REQUIRED: The resource for which the policy is being requested. `resource` is usually specified as a path, such as `projects/*project*/zones/*zone*/disks/*disk*`. The format for the path specified in this value is resource specific and is specified in the `getIamPolicy` documentation. (required)
+ resource: string, REQUIRED: The resource for which the policy is being requested. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
x__xgafv: string, V1 error format.
Returns:
@@ -238,7 +238,7 @@
"attributes": { # Optional attributes for this message.
"a_key": "A String",
},
- "data": "A String", # The message payload. For JSON requests, the value of this field must be base64-encoded.
+ "data": "A String", # The message payload. For JSON requests, the value of this field must be [base64-encoded](https://tools.ietf.org/html/rfc4648).
"publishTime": "A String", # The time at which the message was published, populated by the server when it receives the `Publish` call. It must not be populated by the publisher in a `Publish` call.
"messageId": "A String", # ID of this message, assigned by the server when the message is published. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a `PubsubMessage` via a `Pull` call or a push delivery. It must not be populated by the publisher in a `Publish` call.
},
@@ -262,7 +262,7 @@
<pre>Sets the access control policy on the specified resource. Replaces any existing policy.
Args:
- resource: string, REQUIRED: The resource for which the policy is being specified. `resource` is usually specified as a path, such as `projects/*project*/zones/*zone*/disks/*disk*`. The format for the path specified in this value is resource specific and is specified in the `setIamPolicy` documentation. (required)
+ resource: string, REQUIRED: The resource for which the policy is being specified. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
body: object, The request body. (required)
The object takes the form of:
@@ -305,12 +305,12 @@
<pre>Returns permissions that a caller has on the specified resource.
Args:
- resource: string, REQUIRED: The resource for which the policy detail is being requested. `resource` is usually specified as a path, such as `projects/*project*/zones/*zone*/disks/*disk*`. The format for the path specified in this value is resource specific and is specified in the `testIamPermissions` documentation. (required)
+ resource: string, REQUIRED: The resource for which the policy detail is being requested. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Request message for `TestIamPermissions` method.
- "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see IAM Overview.
+ "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
"A String",
],
}
diff --git a/docs/dyn/runtimeconfig_v1beta1.projects.configs.html b/docs/dyn/runtimeconfig_v1beta1.projects.configs.html
index da4b6ef..b25b8e3 100644
--- a/docs/dyn/runtimeconfig_v1beta1.projects.configs.html
+++ b/docs/dyn/runtimeconfig_v1beta1.projects.configs.html
@@ -90,7 +90,7 @@
<p class="firstline">Returns the waiters Resource.</p>
<p class="toc_element">
- <code><a href="#create">create(parent=None, body, x__xgafv=None)</a></code></p>
+ <code><a href="#create">create(parent=None, body, requestId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new RuntimeConfig resource. The configuration name must be</p>
<p class="toc_element">
<code><a href="#delete">delete(name=None, x__xgafv=None)</a></code></p>
@@ -109,7 +109,7 @@
<p class="firstline">Updates a RuntimeConfig resource. The configuration must exist beforehand.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="create">create(parent=None, body, x__xgafv=None)</code>
+ <code class="details" id="create">create(parent=None, body, requestId=None, x__xgafv=None)</code>
<pre>Creates a new RuntimeConfig resource. The configuration name must be
unique within project.
@@ -137,6 +137,13 @@
# change the resource's name.
}
+ requestId: string, An optional unique request_id. If server receives two Create requests with
+the same request_id then second request will be ignored and the resource
+stored in the backend will be returned. Empty request_id fields are
+ignored.
+It is responsibility of the client to ensure uniqueness of the request_id
+strings.
+The strings are limited to 64 characters.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
diff --git a/docs/dyn/runtimeconfig_v1beta1.projects.configs.variables.html b/docs/dyn/runtimeconfig_v1beta1.projects.configs.variables.html
index eef113c..003e455 100644
--- a/docs/dyn/runtimeconfig_v1beta1.projects.configs.variables.html
+++ b/docs/dyn/runtimeconfig_v1beta1.projects.configs.variables.html
@@ -75,7 +75,7 @@
<h1><a href="runtimeconfig_v1beta1.html">Google Cloud RuntimeConfig API</a> . <a href="runtimeconfig_v1beta1.projects.html">projects</a> . <a href="runtimeconfig_v1beta1.projects.configs.html">configs</a> . <a href="runtimeconfig_v1beta1.projects.configs.variables.html">variables</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#create">create(parent=None, body, x__xgafv=None)</a></code></p>
+ <code><a href="#create">create(parent=None, body, requestId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a variable within the given configuration. You cannot create</p>
<p class="toc_element">
<code><a href="#delete">delete(name=None, recursive=None, x__xgafv=None)</a></code></p>
@@ -97,7 +97,7 @@
<p class="firstline">Watches a specific variable and waits for a change in the variable's value.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="create">create(parent=None, body, x__xgafv=None)</code>
+ <code class="details" id="create">create(parent=None, body, requestId=None, x__xgafv=None)</code>
<pre>Creates a variable within the given configuration. You cannot create
a variable with a name that is a prefix of an existing variable name, or a
name that has an existing variable name as a prefix.
@@ -148,6 +148,13 @@
# Once you create a variable, you cannot change the variable name.
}
+ requestId: string, An optional unique request_id. If server receives two Create requests with
+the same request_id then second request will be ignored and the resource
+stored in the backend will be returned. Empty request_id fields are
+ignored.
+It is responsibility of the client to ensure uniqueness of the request_id
+strings.
+The strings are limited to 64 characters.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
diff --git a/docs/dyn/runtimeconfig_v1beta1.projects.configs.waiters.html b/docs/dyn/runtimeconfig_v1beta1.projects.configs.waiters.html
index b9c212f..57c2c09 100644
--- a/docs/dyn/runtimeconfig_v1beta1.projects.configs.waiters.html
+++ b/docs/dyn/runtimeconfig_v1beta1.projects.configs.waiters.html
@@ -75,7 +75,7 @@
<h1><a href="runtimeconfig_v1beta1.html">Google Cloud RuntimeConfig API</a> . <a href="runtimeconfig_v1beta1.projects.html">projects</a> . <a href="runtimeconfig_v1beta1.projects.configs.html">configs</a> . <a href="runtimeconfig_v1beta1.projects.configs.waiters.html">waiters</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#create">create(parent=None, body, x__xgafv=None)</a></code></p>
+ <code><a href="#create">create(parent=None, body, requestId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a Waiter resource. This operation returns a long-running Operation</p>
<p class="toc_element">
<code><a href="#delete">delete(name=None, x__xgafv=None)</a></code></p>
@@ -91,7 +91,7 @@
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="create">create(parent=None, body, x__xgafv=None)</code>
+ <code class="details" id="create">create(parent=None, body, requestId=None, x__xgafv=None)</code>
<pre>Creates a Waiter resource. This operation returns a long-running Operation
resource which can be polled for completion. However, a waiter with the
given name will exist (and can be retrieved) prior to the operation
@@ -256,6 +256,13 @@
# waiter.
}
+ requestId: string, An optional unique request_id. If server receives two Create requests with
+the same request_id then second request will be ignored and information
+stored in the backend will be returned. Empty request_id fields are
+ignored.
+It is responsibility of the client to ensure uniqueness of the request_id
+strings.
+The strings are limited to 64 characters.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
diff --git a/docs/dyn/servicemanagement_v1.services.configs.html b/docs/dyn/servicemanagement_v1.services.configs.html
index 62e3f0b..76ab8a1 100644
--- a/docs/dyn/servicemanagement_v1.services.configs.html
+++ b/docs/dyn/servicemanagement_v1.services.configs.html
@@ -103,22 +103,23 @@
body: object, The request body. (required)
The object takes the form of:
-{ # `Service` is the root object of the configuration schema. It
- # describes basic information like the name of the service and the
- # exposed API interfaces, and delegates other aspects to configuration
- # sub-sections.
+{ # `Service` is the root object of Google service configuration schema. It
+ # describes basic information about a service, such as the name and the
+ # title, and delegates other aspects to sub-sections. Each sub-section is
+ # either a proto message or a repeated proto message that configures a
+ # specific aspect, such as auth. See each proto message definition for details.
#
# Example:
#
# type: google.api.Service
- # config_version: 1
+ # config_version: 3
# name: calendar.googleapis.com
# title: Google Calendar API
# apis:
- # - name: google.calendar.Calendar
+ # - name: google.calendar.v3.Calendar
# backend:
# rules:
- # - selector: "*"
+ # - selector: "google.calendar.v3.*"
# address: calendar.example.com
"control": { # Selects and configures the service controller used by the service. The # Configuration for the service control plane.
# service controller handles features like abuse, quota, billing, logging,
@@ -191,7 +192,7 @@
# slash, underscore, hyphen, period [/_-.].
},
],
- "systemParameters": { # ### System parameter configuration # Configuration for system parameters.
+ "systemParameters": { # ### System parameter configuration # System parameter configuration.
#
# A system parameter is a special kind of parameter defined by the API
# system, not by an individual API. It is typically mapped to an HTTP header
@@ -266,7 +267,7 @@
},
],
},
- "monitoring": { # Monitoring configuration of the service. # Monitoring configuration of the service.
+ "monitoring": { # Monitoring configuration of the service. # Monitoring configuration.
#
# The example below shows how to configure monitored resources and metrics
# for monitoring. In the example, a monitored resource and two metrics are
@@ -947,8 +948,8 @@
# **NOTE:** All service configuration rules follow "last one wins" order.
{ # A visibility rule provides visibility configuration for an individual API
# element.
- "restriction": "A String", # Lists the visibility labels for this rule. Any of the listed labels grants
- # visibility to the element.
+ "restriction": "A String", # A comma-separated list of visibility labels that apply to the `selector`.
+ # Any of the listed labels can be used to grant the visibility.
#
# If a rule has multiple labels, removing one of the labels but not all of
# them can break clients.
@@ -974,7 +975,9 @@
# Use sentence case without an ending period, for example "Request count".
"description": "A String", # A detailed description of the metric, which can be used in documentation.
"metricKind": "A String", # Whether the metric records instantaneous values, changes to a value, etc.
+ # Some combinations of `metric_kind` and `value_type` might not be supported.
"valueType": "A String", # Whether the measurement is an integer, a floating-point number, etc.
+ # Some combinations of `metric_kind` and `value_type` might not be supported.
"labels": [ # The set of labels that can be used to describe a specific instance of this
# metric type. For example, the
# `compute.googleapis.com/instance/network/received_bytes_count` metric type
@@ -1164,7 +1167,7 @@
],
},
],
- "logging": { # Logging configuration of the service. # Logging configuration of the service.
+ "logging": { # Logging configuration of the service. # Logging configuration.
#
# The following example shows how to configure logs to be sent to the
# producer and consumer projects. In the example,
@@ -1425,6 +1428,69 @@
},
],
},
+ "endpoints": [ # Configuration for network endpoints. If this is empty, then an endpoint
+ # with the same name as the service is automatically generated to service all
+ # defined APIs.
+ { # `Endpoint` describes a network endpoint that serves a set of APIs.
+ # A service may expose any number of endpoints, and all endpoints share the
+ # same service configuration, such as quota configuration and monitoring
+ # configuration.
+ #
+ # Example service configuration:
+ #
+ # name: library-example.googleapis.com
+ # endpoints:
+ # # Below entry makes 'google.example.library.v1.Library'
+ # # API be served from endpoint address library-example.googleapis.com.
+ # # It also allows HTTP OPTIONS calls to be passed to the backend, for
+ # # it to decide whether the subsequent cross-origin request is
+ # # allowed to proceed.
+ # - name: library-example.googleapis.com
+ # apis: google.example.library.v1.Library
+ # allow_cors: true
+ # # Below entry makes 'google.example.library.v1.Library'
+ # # API be served from endpoint address
+ # # google.example.library-example.v1.LibraryManager.
+ # - name: library-manager.googleapis.com
+ # apis: google.example.library.v1.LibraryManager
+ # # BNS address for a borg job. Can specify a task by appending
+ # # "/taskId" (e.g. "/0") to the job spec.
+ #
+ # Example OpenAPI extension for endpoint with allow_cors set to true:
+ #
+ # {
+ # "swagger": "2.0",
+ # "info": {
+ # "description": "A simple..."
+ # },
+ # "host": "MY_PROJECT_ID.appspot.com",
+ # "x-google-endpoints": [{
+ # "name": "MY_PROJECT_ID.appspot.com",
+ # "allow_cors": "true"
+ # }]
+ # }
+ "allowCors": True or False, # Allowing
+ # [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka
+ # cross-domain traffic, would allow the backends served from this endpoint to
+ # receive and respond to HTTP OPTIONS requests. The response will be used by
+ # the browser to determine whether the subsequent cross-origin request is
+ # allowed to proceed.
+ "aliases": [ # DEPRECATED: This field is no longer supported. Instead of using aliases,
+ # please specify multiple google.api.Endpoint for each of the intented
+ # alias.
+ #
+ # Additional names that this endpoint will be hosted on.
+ "A String",
+ ],
+ "features": [ # The list of features enabled on this endpoint.
+ "A String",
+ ],
+ "name": "A String", # The canonical name of this endpoint.
+ "apis": [ # The list of APIs served by this endpoint.
+ "A String",
+ ],
+ },
+ ],
}
x__xgafv: string, V1 error format.
@@ -1435,22 +1501,23 @@
Returns:
An object of the form:
- { # `Service` is the root object of the configuration schema. It
- # describes basic information like the name of the service and the
- # exposed API interfaces, and delegates other aspects to configuration
- # sub-sections.
+ { # `Service` is the root object of Google service configuration schema. It
+ # describes basic information about a service, such as the name and the
+ # title, and delegates other aspects to sub-sections. Each sub-section is
+ # either a proto message or a repeated proto message that configures a
+ # specific aspect, such as auth. See each proto message definition for details.
#
# Example:
#
# type: google.api.Service
- # config_version: 1
+ # config_version: 3
# name: calendar.googleapis.com
# title: Google Calendar API
# apis:
- # - name: google.calendar.Calendar
+ # - name: google.calendar.v3.Calendar
# backend:
# rules:
- # - selector: "*"
+ # - selector: "google.calendar.v3.*"
# address: calendar.example.com
"control": { # Selects and configures the service controller used by the service. The # Configuration for the service control plane.
# service controller handles features like abuse, quota, billing, logging,
@@ -1523,7 +1590,7 @@
# slash, underscore, hyphen, period [/_-.].
},
],
- "systemParameters": { # ### System parameter configuration # Configuration for system parameters.
+ "systemParameters": { # ### System parameter configuration # System parameter configuration.
#
# A system parameter is a special kind of parameter defined by the API
# system, not by an individual API. It is typically mapped to an HTTP header
@@ -1598,7 +1665,7 @@
},
],
},
- "monitoring": { # Monitoring configuration of the service. # Monitoring configuration of the service.
+ "monitoring": { # Monitoring configuration of the service. # Monitoring configuration.
#
# The example below shows how to configure monitored resources and metrics
# for monitoring. In the example, a monitored resource and two metrics are
@@ -2279,8 +2346,8 @@
# **NOTE:** All service configuration rules follow "last one wins" order.
{ # A visibility rule provides visibility configuration for an individual API
# element.
- "restriction": "A String", # Lists the visibility labels for this rule. Any of the listed labels grants
- # visibility to the element.
+ "restriction": "A String", # A comma-separated list of visibility labels that apply to the `selector`.
+ # Any of the listed labels can be used to grant the visibility.
#
# If a rule has multiple labels, removing one of the labels but not all of
# them can break clients.
@@ -2306,7 +2373,9 @@
# Use sentence case without an ending period, for example "Request count".
"description": "A String", # A detailed description of the metric, which can be used in documentation.
"metricKind": "A String", # Whether the metric records instantaneous values, changes to a value, etc.
+ # Some combinations of `metric_kind` and `value_type` might not be supported.
"valueType": "A String", # Whether the measurement is an integer, a floating-point number, etc.
+ # Some combinations of `metric_kind` and `value_type` might not be supported.
"labels": [ # The set of labels that can be used to describe a specific instance of this
# metric type. For example, the
# `compute.googleapis.com/instance/network/received_bytes_count` metric type
@@ -2496,7 +2565,7 @@
],
},
],
- "logging": { # Logging configuration of the service. # Logging configuration of the service.
+ "logging": { # Logging configuration of the service. # Logging configuration.
#
# The following example shows how to configure logs to be sent to the
# producer and consumer projects. In the example,
@@ -2757,6 +2826,69 @@
},
],
},
+ "endpoints": [ # Configuration for network endpoints. If this is empty, then an endpoint
+ # with the same name as the service is automatically generated to service all
+ # defined APIs.
+ { # `Endpoint` describes a network endpoint that serves a set of APIs.
+ # A service may expose any number of endpoints, and all endpoints share the
+ # same service configuration, such as quota configuration and monitoring
+ # configuration.
+ #
+ # Example service configuration:
+ #
+ # name: library-example.googleapis.com
+ # endpoints:
+ # # Below entry makes 'google.example.library.v1.Library'
+ # # API be served from endpoint address library-example.googleapis.com.
+ # # It also allows HTTP OPTIONS calls to be passed to the backend, for
+ # # it to decide whether the subsequent cross-origin request is
+ # # allowed to proceed.
+ # - name: library-example.googleapis.com
+ # apis: google.example.library.v1.Library
+ # allow_cors: true
+ # # Below entry makes 'google.example.library.v1.Library'
+ # # API be served from endpoint address
+ # # google.example.library-example.v1.LibraryManager.
+ # - name: library-manager.googleapis.com
+ # apis: google.example.library.v1.LibraryManager
+ # # BNS address for a borg job. Can specify a task by appending
+ # # "/taskId" (e.g. "/0") to the job spec.
+ #
+ # Example OpenAPI extension for endpoint with allow_cors set to true:
+ #
+ # {
+ # "swagger": "2.0",
+ # "info": {
+ # "description": "A simple..."
+ # },
+ # "host": "MY_PROJECT_ID.appspot.com",
+ # "x-google-endpoints": [{
+ # "name": "MY_PROJECT_ID.appspot.com",
+ # "allow_cors": "true"
+ # }]
+ # }
+ "allowCors": True or False, # Allowing
+ # [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka
+ # cross-domain traffic, would allow the backends served from this endpoint to
+ # receive and respond to HTTP OPTIONS requests. The response will be used by
+ # the browser to determine whether the subsequent cross-origin request is
+ # allowed to proceed.
+ "aliases": [ # DEPRECATED: This field is no longer supported. Instead of using aliases,
+ # please specify multiple google.api.Endpoint for each of the intented
+ # alias.
+ #
+ # Additional names that this endpoint will be hosted on.
+ "A String",
+ ],
+ "features": [ # The list of features enabled on this endpoint.
+ "A String",
+ ],
+ "name": "A String", # The canonical name of this endpoint.
+ "apis": [ # The list of APIs served by this endpoint.
+ "A String",
+ ],
+ },
+ ],
}</pre>
</div>
@@ -2776,22 +2908,23 @@
Returns:
An object of the form:
- { # `Service` is the root object of the configuration schema. It
- # describes basic information like the name of the service and the
- # exposed API interfaces, and delegates other aspects to configuration
- # sub-sections.
+ { # `Service` is the root object of Google service configuration schema. It
+ # describes basic information about a service, such as the name and the
+ # title, and delegates other aspects to sub-sections. Each sub-section is
+ # either a proto message or a repeated proto message that configures a
+ # specific aspect, such as auth. See each proto message definition for details.
#
# Example:
#
# type: google.api.Service
- # config_version: 1
+ # config_version: 3
# name: calendar.googleapis.com
# title: Google Calendar API
# apis:
- # - name: google.calendar.Calendar
+ # - name: google.calendar.v3.Calendar
# backend:
# rules:
- # - selector: "*"
+ # - selector: "google.calendar.v3.*"
# address: calendar.example.com
"control": { # Selects and configures the service controller used by the service. The # Configuration for the service control plane.
# service controller handles features like abuse, quota, billing, logging,
@@ -2864,7 +2997,7 @@
# slash, underscore, hyphen, period [/_-.].
},
],
- "systemParameters": { # ### System parameter configuration # Configuration for system parameters.
+ "systemParameters": { # ### System parameter configuration # System parameter configuration.
#
# A system parameter is a special kind of parameter defined by the API
# system, not by an individual API. It is typically mapped to an HTTP header
@@ -2939,7 +3072,7 @@
},
],
},
- "monitoring": { # Monitoring configuration of the service. # Monitoring configuration of the service.
+ "monitoring": { # Monitoring configuration of the service. # Monitoring configuration.
#
# The example below shows how to configure monitored resources and metrics
# for monitoring. In the example, a monitored resource and two metrics are
@@ -3620,8 +3753,8 @@
# **NOTE:** All service configuration rules follow "last one wins" order.
{ # A visibility rule provides visibility configuration for an individual API
# element.
- "restriction": "A String", # Lists the visibility labels for this rule. Any of the listed labels grants
- # visibility to the element.
+ "restriction": "A String", # A comma-separated list of visibility labels that apply to the `selector`.
+ # Any of the listed labels can be used to grant the visibility.
#
# If a rule has multiple labels, removing one of the labels but not all of
# them can break clients.
@@ -3647,7 +3780,9 @@
# Use sentence case without an ending period, for example "Request count".
"description": "A String", # A detailed description of the metric, which can be used in documentation.
"metricKind": "A String", # Whether the metric records instantaneous values, changes to a value, etc.
+ # Some combinations of `metric_kind` and `value_type` might not be supported.
"valueType": "A String", # Whether the measurement is an integer, a floating-point number, etc.
+ # Some combinations of `metric_kind` and `value_type` might not be supported.
"labels": [ # The set of labels that can be used to describe a specific instance of this
# metric type. For example, the
# `compute.googleapis.com/instance/network/received_bytes_count` metric type
@@ -3837,7 +3972,7 @@
],
},
],
- "logging": { # Logging configuration of the service. # Logging configuration of the service.
+ "logging": { # Logging configuration of the service. # Logging configuration.
#
# The following example shows how to configure logs to be sent to the
# producer and consumer projects. In the example,
@@ -4098,6 +4233,69 @@
},
],
},
+ "endpoints": [ # Configuration for network endpoints. If this is empty, then an endpoint
+ # with the same name as the service is automatically generated to service all
+ # defined APIs.
+ { # `Endpoint` describes a network endpoint that serves a set of APIs.
+ # A service may expose any number of endpoints, and all endpoints share the
+ # same service configuration, such as quota configuration and monitoring
+ # configuration.
+ #
+ # Example service configuration:
+ #
+ # name: library-example.googleapis.com
+ # endpoints:
+ # # Below entry makes 'google.example.library.v1.Library'
+ # # API be served from endpoint address library-example.googleapis.com.
+ # # It also allows HTTP OPTIONS calls to be passed to the backend, for
+ # # it to decide whether the subsequent cross-origin request is
+ # # allowed to proceed.
+ # - name: library-example.googleapis.com
+ # apis: google.example.library.v1.Library
+ # allow_cors: true
+ # # Below entry makes 'google.example.library.v1.Library'
+ # # API be served from endpoint address
+ # # google.example.library-example.v1.LibraryManager.
+ # - name: library-manager.googleapis.com
+ # apis: google.example.library.v1.LibraryManager
+ # # BNS address for a borg job. Can specify a task by appending
+ # # "/taskId" (e.g. "/0") to the job spec.
+ #
+ # Example OpenAPI extension for endpoint with allow_cors set to true:
+ #
+ # {
+ # "swagger": "2.0",
+ # "info": {
+ # "description": "A simple..."
+ # },
+ # "host": "MY_PROJECT_ID.appspot.com",
+ # "x-google-endpoints": [{
+ # "name": "MY_PROJECT_ID.appspot.com",
+ # "allow_cors": "true"
+ # }]
+ # }
+ "allowCors": True or False, # Allowing
+ # [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka
+ # cross-domain traffic, would allow the backends served from this endpoint to
+ # receive and respond to HTTP OPTIONS requests. The response will be used by
+ # the browser to determine whether the subsequent cross-origin request is
+ # allowed to proceed.
+ "aliases": [ # DEPRECATED: This field is no longer supported. Instead of using aliases,
+ # please specify multiple google.api.Endpoint for each of the intented
+ # alias.
+ #
+ # Additional names that this endpoint will be hosted on.
+ "A String",
+ ],
+ "features": [ # The list of features enabled on this endpoint.
+ "A String",
+ ],
+ "name": "A String", # The canonical name of this endpoint.
+ "apis": [ # The list of APIs served by this endpoint.
+ "A String",
+ ],
+ },
+ ],
}</pre>
</div>
@@ -4122,22 +4320,23 @@
{ # Response message for ListServiceConfigs method.
"nextPageToken": "A String", # The token of the next page of results.
"serviceConfigs": [ # The list of service configuration resources.
- { # `Service` is the root object of the configuration schema. It
- # describes basic information like the name of the service and the
- # exposed API interfaces, and delegates other aspects to configuration
- # sub-sections.
+ { # `Service` is the root object of Google service configuration schema. It
+ # describes basic information about a service, such as the name and the
+ # title, and delegates other aspects to sub-sections. Each sub-section is
+ # either a proto message or a repeated proto message that configures a
+ # specific aspect, such as auth. See each proto message definition for details.
#
# Example:
#
# type: google.api.Service
- # config_version: 1
+ # config_version: 3
# name: calendar.googleapis.com
# title: Google Calendar API
# apis:
- # - name: google.calendar.Calendar
+ # - name: google.calendar.v3.Calendar
# backend:
# rules:
- # - selector: "*"
+ # - selector: "google.calendar.v3.*"
# address: calendar.example.com
"control": { # Selects and configures the service controller used by the service. The # Configuration for the service control plane.
# service controller handles features like abuse, quota, billing, logging,
@@ -4210,7 +4409,7 @@
# slash, underscore, hyphen, period [/_-.].
},
],
- "systemParameters": { # ### System parameter configuration # Configuration for system parameters.
+ "systemParameters": { # ### System parameter configuration # System parameter configuration.
#
# A system parameter is a special kind of parameter defined by the API
# system, not by an individual API. It is typically mapped to an HTTP header
@@ -4285,7 +4484,7 @@
},
],
},
- "monitoring": { # Monitoring configuration of the service. # Monitoring configuration of the service.
+ "monitoring": { # Monitoring configuration of the service. # Monitoring configuration.
#
# The example below shows how to configure monitored resources and metrics
# for monitoring. In the example, a monitored resource and two metrics are
@@ -4966,8 +5165,8 @@
# **NOTE:** All service configuration rules follow "last one wins" order.
{ # A visibility rule provides visibility configuration for an individual API
# element.
- "restriction": "A String", # Lists the visibility labels for this rule. Any of the listed labels grants
- # visibility to the element.
+ "restriction": "A String", # A comma-separated list of visibility labels that apply to the `selector`.
+ # Any of the listed labels can be used to grant the visibility.
#
# If a rule has multiple labels, removing one of the labels but not all of
# them can break clients.
@@ -4993,7 +5192,9 @@
# Use sentence case without an ending period, for example "Request count".
"description": "A String", # A detailed description of the metric, which can be used in documentation.
"metricKind": "A String", # Whether the metric records instantaneous values, changes to a value, etc.
+ # Some combinations of `metric_kind` and `value_type` might not be supported.
"valueType": "A String", # Whether the measurement is an integer, a floating-point number, etc.
+ # Some combinations of `metric_kind` and `value_type` might not be supported.
"labels": [ # The set of labels that can be used to describe a specific instance of this
# metric type. For example, the
# `compute.googleapis.com/instance/network/received_bytes_count` metric type
@@ -5183,7 +5384,7 @@
],
},
],
- "logging": { # Logging configuration of the service. # Logging configuration of the service.
+ "logging": { # Logging configuration of the service. # Logging configuration.
#
# The following example shows how to configure logs to be sent to the
# producer and consumer projects. In the example,
@@ -5444,6 +5645,69 @@
},
],
},
+ "endpoints": [ # Configuration for network endpoints. If this is empty, then an endpoint
+ # with the same name as the service is automatically generated to service all
+ # defined APIs.
+ { # `Endpoint` describes a network endpoint that serves a set of APIs.
+ # A service may expose any number of endpoints, and all endpoints share the
+ # same service configuration, such as quota configuration and monitoring
+ # configuration.
+ #
+ # Example service configuration:
+ #
+ # name: library-example.googleapis.com
+ # endpoints:
+ # # Below entry makes 'google.example.library.v1.Library'
+ # # API be served from endpoint address library-example.googleapis.com.
+ # # It also allows HTTP OPTIONS calls to be passed to the backend, for
+ # # it to decide whether the subsequent cross-origin request is
+ # # allowed to proceed.
+ # - name: library-example.googleapis.com
+ # apis: google.example.library.v1.Library
+ # allow_cors: true
+ # # Below entry makes 'google.example.library.v1.Library'
+ # # API be served from endpoint address
+ # # google.example.library-example.v1.LibraryManager.
+ # - name: library-manager.googleapis.com
+ # apis: google.example.library.v1.LibraryManager
+ # # BNS address for a borg job. Can specify a task by appending
+ # # "/taskId" (e.g. "/0") to the job spec.
+ #
+ # Example OpenAPI extension for endpoint with allow_cors set to true:
+ #
+ # {
+ # "swagger": "2.0",
+ # "info": {
+ # "description": "A simple..."
+ # },
+ # "host": "MY_PROJECT_ID.appspot.com",
+ # "x-google-endpoints": [{
+ # "name": "MY_PROJECT_ID.appspot.com",
+ # "allow_cors": "true"
+ # }]
+ # }
+ "allowCors": True or False, # Allowing
+ # [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka
+ # cross-domain traffic, would allow the backends served from this endpoint to
+ # receive and respond to HTTP OPTIONS requests. The response will be used by
+ # the browser to determine whether the subsequent cross-origin request is
+ # allowed to proceed.
+ "aliases": [ # DEPRECATED: This field is no longer supported. Instead of using aliases,
+ # please specify multiple google.api.Endpoint for each of the intented
+ # alias.
+ #
+ # Additional names that this endpoint will be hosted on.
+ "A String",
+ ],
+ "features": [ # The list of features enabled on this endpoint.
+ "A String",
+ ],
+ "name": "A String", # The canonical name of this endpoint.
+ "apis": [ # The list of APIs served by this endpoint.
+ "A String",
+ ],
+ },
+ ],
},
],
}</pre>
diff --git a/docs/dyn/servicemanagement_v1.services.html b/docs/dyn/servicemanagement_v1.services.html
index f5c29d0..758a05b 100644
--- a/docs/dyn/servicemanagement_v1.services.html
+++ b/docs/dyn/servicemanagement_v1.services.html
@@ -127,6 +127,7 @@
<div class="method">
<code class="details" id="create">create(body, x__xgafv=None)</code>
<pre>Creates a new managed service.
+Please note one producer project can own no more than 20 services.
Operation<response: ManagedService>
@@ -734,22 +735,23 @@
Returns:
An object of the form:
- { # `Service` is the root object of the configuration schema. It
- # describes basic information like the name of the service and the
- # exposed API interfaces, and delegates other aspects to configuration
- # sub-sections.
+ { # `Service` is the root object of Google service configuration schema. It
+ # describes basic information about a service, such as the name and the
+ # title, and delegates other aspects to sub-sections. Each sub-section is
+ # either a proto message or a repeated proto message that configures a
+ # specific aspect, such as auth. See each proto message definition for details.
#
# Example:
#
# type: google.api.Service
- # config_version: 1
+ # config_version: 3
# name: calendar.googleapis.com
# title: Google Calendar API
# apis:
- # - name: google.calendar.Calendar
+ # - name: google.calendar.v3.Calendar
# backend:
# rules:
- # - selector: "*"
+ # - selector: "google.calendar.v3.*"
# address: calendar.example.com
"control": { # Selects and configures the service controller used by the service. The # Configuration for the service control plane.
# service controller handles features like abuse, quota, billing, logging,
@@ -822,7 +824,7 @@
# slash, underscore, hyphen, period [/_-.].
},
],
- "systemParameters": { # ### System parameter configuration # Configuration for system parameters.
+ "systemParameters": { # ### System parameter configuration # System parameter configuration.
#
# A system parameter is a special kind of parameter defined by the API
# system, not by an individual API. It is typically mapped to an HTTP header
@@ -897,7 +899,7 @@
},
],
},
- "monitoring": { # Monitoring configuration of the service. # Monitoring configuration of the service.
+ "monitoring": { # Monitoring configuration of the service. # Monitoring configuration.
#
# The example below shows how to configure monitored resources and metrics
# for monitoring. In the example, a monitored resource and two metrics are
@@ -1578,8 +1580,8 @@
# **NOTE:** All service configuration rules follow "last one wins" order.
{ # A visibility rule provides visibility configuration for an individual API
# element.
- "restriction": "A String", # Lists the visibility labels for this rule. Any of the listed labels grants
- # visibility to the element.
+ "restriction": "A String", # A comma-separated list of visibility labels that apply to the `selector`.
+ # Any of the listed labels can be used to grant the visibility.
#
# If a rule has multiple labels, removing one of the labels but not all of
# them can break clients.
@@ -1605,7 +1607,9 @@
# Use sentence case without an ending period, for example "Request count".
"description": "A String", # A detailed description of the metric, which can be used in documentation.
"metricKind": "A String", # Whether the metric records instantaneous values, changes to a value, etc.
+ # Some combinations of `metric_kind` and `value_type` might not be supported.
"valueType": "A String", # Whether the measurement is an integer, a floating-point number, etc.
+ # Some combinations of `metric_kind` and `value_type` might not be supported.
"labels": [ # The set of labels that can be used to describe a specific instance of this
# metric type. For example, the
# `compute.googleapis.com/instance/network/received_bytes_count` metric type
@@ -1795,7 +1799,7 @@
],
},
],
- "logging": { # Logging configuration of the service. # Logging configuration of the service.
+ "logging": { # Logging configuration of the service. # Logging configuration.
#
# The following example shows how to configure logs to be sent to the
# producer and consumer projects. In the example,
@@ -2056,6 +2060,69 @@
},
],
},
+ "endpoints": [ # Configuration for network endpoints. If this is empty, then an endpoint
+ # with the same name as the service is automatically generated to service all
+ # defined APIs.
+ { # `Endpoint` describes a network endpoint that serves a set of APIs.
+ # A service may expose any number of endpoints, and all endpoints share the
+ # same service configuration, such as quota configuration and monitoring
+ # configuration.
+ #
+ # Example service configuration:
+ #
+ # name: library-example.googleapis.com
+ # endpoints:
+ # # Below entry makes 'google.example.library.v1.Library'
+ # # API be served from endpoint address library-example.googleapis.com.
+ # # It also allows HTTP OPTIONS calls to be passed to the backend, for
+ # # it to decide whether the subsequent cross-origin request is
+ # # allowed to proceed.
+ # - name: library-example.googleapis.com
+ # apis: google.example.library.v1.Library
+ # allow_cors: true
+ # # Below entry makes 'google.example.library.v1.Library'
+ # # API be served from endpoint address
+ # # google.example.library-example.v1.LibraryManager.
+ # - name: library-manager.googleapis.com
+ # apis: google.example.library.v1.LibraryManager
+ # # BNS address for a borg job. Can specify a task by appending
+ # # "/taskId" (e.g. "/0") to the job spec.
+ #
+ # Example OpenAPI extension for endpoint with allow_cors set to true:
+ #
+ # {
+ # "swagger": "2.0",
+ # "info": {
+ # "description": "A simple..."
+ # },
+ # "host": "MY_PROJECT_ID.appspot.com",
+ # "x-google-endpoints": [{
+ # "name": "MY_PROJECT_ID.appspot.com",
+ # "allow_cors": "true"
+ # }]
+ # }
+ "allowCors": True or False, # Allowing
+ # [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka
+ # cross-domain traffic, would allow the backends served from this endpoint to
+ # receive and respond to HTTP OPTIONS requests. The response will be used by
+ # the browser to determine whether the subsequent cross-origin request is
+ # allowed to proceed.
+ "aliases": [ # DEPRECATED: This field is no longer supported. Instead of using aliases,
+ # please specify multiple google.api.Endpoint for each of the intented
+ # alias.
+ #
+ # Additional names that this endpoint will be hosted on.
+ "A String",
+ ],
+ "features": [ # The list of features enabled on this endpoint.
+ "A String",
+ ],
+ "name": "A String", # The canonical name of this endpoint.
+ "apis": [ # The list of APIs served by this endpoint.
+ "A String",
+ ],
+ },
+ ],
}</pre>
</div>
diff --git a/docs/dyn/sheets_v4.spreadsheets.html b/docs/dyn/sheets_v4.spreadsheets.html
index b6fdd6f..79f396b 100644
--- a/docs/dyn/sheets_v4.spreadsheets.html
+++ b/docs/dyn/sheets_v4.spreadsheets.html
@@ -287,6 +287,8 @@
"numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.
"pattern": "A String", # Pattern string used for formatting. If not set, a default pattern based on
# the user's locale will be used if necessary for the given type.
+ # See the [Date and Number Formats guide](/sheets/guides/formats) for more
+ # information about the supported patterns.
"type": "A String", # The type of the number format.
# When writing, this field must be set.
},
@@ -2063,6 +2065,8 @@
"numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.
"pattern": "A String", # Pattern string used for formatting. If not set, a default pattern based on
# the user's locale will be used if necessary for the given type.
+ # See the [Date and Number Formats guide](/sheets/guides/formats) for more
+ # information about the supported patterns.
"type": "A String", # The type of the number format.
# When writing, this field must be set.
},
@@ -2890,6 +2894,8 @@
"numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.
"pattern": "A String", # Pattern string used for formatting. If not set, a default pattern based on
# the user's locale will be used if necessary for the given type.
+ # See the [Date and Number Formats guide](/sheets/guides/formats) for more
+ # information about the supported patterns.
"type": "A String", # The type of the number format.
# When writing, this field must be set.
},
@@ -4600,6 +4606,8 @@
"numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.
"pattern": "A String", # Pattern string used for formatting. If not set, a default pattern based on
# the user's locale will be used if necessary for the given type.
+ # See the [Date and Number Formats guide](/sheets/guides/formats) for more
+ # information about the supported patterns.
"type": "A String", # The type of the number format.
# When writing, this field must be set.
},
@@ -6118,6 +6126,8 @@
"numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.
"pattern": "A String", # Pattern string used for formatting. If not set, a default pattern based on
# the user's locale will be used if necessary for the given type.
+ # See the [Date and Number Formats guide](/sheets/guides/formats) for more
+ # information about the supported patterns.
"type": "A String", # The type of the number format.
# When writing, this field must be set.
},
@@ -6945,6 +6955,8 @@
"numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.
"pattern": "A String", # Pattern string used for formatting. If not set, a default pattern based on
# the user's locale will be used if necessary for the given type.
+ # See the [Date and Number Formats guide](/sheets/guides/formats) for more
+ # information about the supported patterns.
"type": "A String", # The type of the number format.
# When writing, this field must be set.
},
@@ -8152,6 +8164,8 @@
"numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.
"pattern": "A String", # Pattern string used for formatting. If not set, a default pattern based on
# the user's locale will be used if necessary for the given type.
+ # See the [Date and Number Formats guide](/sheets/guides/formats) for more
+ # information about the supported patterns.
"type": "A String", # The type of the number format.
# When writing, this field must be set.
},
@@ -9287,6 +9301,8 @@
"numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.
"pattern": "A String", # Pattern string used for formatting. If not set, a default pattern based on
# the user's locale will be used if necessary for the given type.
+ # See the [Date and Number Formats guide](/sheets/guides/formats) for more
+ # information about the supported patterns.
"type": "A String", # The type of the number format.
# When writing, this field must be set.
},
@@ -10114,6 +10130,8 @@
"numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.
"pattern": "A String", # Pattern string used for formatting. If not set, a default pattern based on
# the user's locale will be used if necessary for the given type.
+ # See the [Date and Number Formats guide](/sheets/guides/formats) for more
+ # information about the supported patterns.
"type": "A String", # The type of the number format.
# When writing, this field must be set.
},
@@ -14170,6 +14188,8 @@
"numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.
"pattern": "A String", # Pattern string used for formatting. If not set, a default pattern based on
# the user's locale will be used if necessary for the given type.
+ # See the [Date and Number Formats guide](/sheets/guides/formats) for more
+ # information about the supported patterns.
"type": "A String", # The type of the number format.
# When writing, this field must be set.
},
@@ -15485,6 +15505,8 @@
"numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.
"pattern": "A String", # Pattern string used for formatting. If not set, a default pattern based on
# the user's locale will be used if necessary for the given type.
+ # See the [Date and Number Formats guide](/sheets/guides/formats) for more
+ # information about the supported patterns.
"type": "A String", # The type of the number format.
# When writing, this field must be set.
},
@@ -17119,6 +17141,8 @@
"numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.
"pattern": "A String", # Pattern string used for formatting. If not set, a default pattern based on
# the user's locale will be used if necessary for the given type.
+ # See the [Date and Number Formats guide](/sheets/guides/formats) for more
+ # information about the supported patterns.
"type": "A String", # The type of the number format.
# When writing, this field must be set.
},
@@ -18528,6 +18552,8 @@
"numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.
"pattern": "A String", # Pattern string used for formatting. If not set, a default pattern based on
# the user's locale will be used if necessary for the given type.
+ # See the [Date and Number Formats guide](/sheets/guides/formats) for more
+ # information about the supported patterns.
"type": "A String", # The type of the number format.
# When writing, this field must be set.
},
@@ -19429,6 +19455,8 @@
"numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.
"pattern": "A String", # Pattern string used for formatting. If not set, a default pattern based on
# the user's locale will be used if necessary for the given type.
+ # See the [Date and Number Formats guide](/sheets/guides/formats) for more
+ # information about the supported patterns.
"type": "A String", # The type of the number format.
# When writing, this field must be set.
},
@@ -21740,6 +21768,8 @@
"numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.
"pattern": "A String", # Pattern string used for formatting. If not set, a default pattern based on
# the user's locale will be used if necessary for the given type.
+ # See the [Date and Number Formats guide](/sheets/guides/formats) for more
+ # information about the supported patterns.
"type": "A String", # The type of the number format.
# When writing, this field must be set.
},
@@ -22567,6 +22597,8 @@
"numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.
"pattern": "A String", # Pattern string used for formatting. If not set, a default pattern based on
# the user's locale will be used if necessary for the given type.
+ # See the [Date and Number Formats guide](/sheets/guides/formats) for more
+ # information about the supported patterns.
"type": "A String", # The type of the number format.
# When writing, this field must be set.
},
@@ -23809,6 +23841,8 @@
"numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.
"pattern": "A String", # Pattern string used for formatting. If not set, a default pattern based on
# the user's locale will be used if necessary for the given type.
+ # See the [Date and Number Formats guide](/sheets/guides/formats) for more
+ # information about the supported patterns.
"type": "A String", # The type of the number format.
# When writing, this field must be set.
},
@@ -24710,6 +24744,8 @@
"numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.
"pattern": "A String", # Pattern string used for formatting. If not set, a default pattern based on
# the user's locale will be used if necessary for the given type.
+ # See the [Date and Number Formats guide](/sheets/guides/formats) for more
+ # information about the supported patterns.
"type": "A String", # The type of the number format.
# When writing, this field must be set.
},
@@ -27021,6 +27057,8 @@
"numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.
"pattern": "A String", # Pattern string used for formatting. If not set, a default pattern based on
# the user's locale will be used if necessary for the given type.
+ # See the [Date and Number Formats guide](/sheets/guides/formats) for more
+ # information about the supported patterns.
"type": "A String", # The type of the number format.
# When writing, this field must be set.
},
@@ -27848,6 +27886,8 @@
"numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.
"pattern": "A String", # Pattern string used for formatting. If not set, a default pattern based on
# the user's locale will be used if necessary for the given type.
+ # See the [Date and Number Formats guide](/sheets/guides/formats) for more
+ # information about the supported patterns.
"type": "A String", # The type of the number format.
# When writing, this field must be set.
},
@@ -29120,6 +29160,8 @@
"numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.
"pattern": "A String", # Pattern string used for formatting. If not set, a default pattern based on
# the user's locale will be used if necessary for the given type.
+ # See the [Date and Number Formats guide](/sheets/guides/formats) for more
+ # information about the supported patterns.
"type": "A String", # The type of the number format.
# When writing, this field must be set.
},
@@ -30021,6 +30063,8 @@
"numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.
"pattern": "A String", # Pattern string used for formatting. If not set, a default pattern based on
# the user's locale will be used if necessary for the given type.
+ # See the [Date and Number Formats guide](/sheets/guides/formats) for more
+ # information about the supported patterns.
"type": "A String", # The type of the number format.
# When writing, this field must be set.
},
@@ -32332,6 +32376,8 @@
"numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.
"pattern": "A String", # Pattern string used for formatting. If not set, a default pattern based on
# the user's locale will be used if necessary for the given type.
+ # See the [Date and Number Formats guide](/sheets/guides/formats) for more
+ # information about the supported patterns.
"type": "A String", # The type of the number format.
# When writing, this field must be set.
},
@@ -33159,6 +33205,8 @@
"numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.
"pattern": "A String", # Pattern string used for formatting. If not set, a default pattern based on
# the user's locale will be used if necessary for the given type.
+ # See the [Date and Number Formats guide](/sheets/guides/formats) for more
+ # information about the supported patterns.
"type": "A String", # The type of the number format.
# When writing, this field must be set.
},
diff --git a/docs/dyn/speech_v1beta1.operations.html b/docs/dyn/speech_v1beta1.operations.html
index 3bf0c3c..b7eb168 100644
--- a/docs/dyn/speech_v1beta1.operations.html
+++ b/docs/dyn/speech_v1beta1.operations.html
@@ -98,7 +98,10 @@
`google.rpc.Code.UNIMPLEMENTED`. Clients can use
Operations.GetOperation or
other methods to check whether the cancellation succeeded or whether the
-operation completed despite cancellation.
+operation completed despite cancellation. On successful cancellation,
+the operation is not deleted; instead, it becomes an operation with
+an Operation.error value with a google.rpc.Status.code of 1,
+corresponding to `Code.CANCELLED`.
Args:
name: string, The name of the operation resource to be cancelled. (required)
@@ -197,7 +200,7 @@
"name": "A String", # The server-assigned name, which is only unique within the same service that
# originally returns it. If you use the default HTTP mapping, the
# `name` should have the format of `operations/some/unique/name`.
- "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure.
+ "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
# programming environments, including REST APIs and RPC APIs. It is used by
# [gRPC](https://github.com/grpc). The error model is designed to be:
#
@@ -311,7 +314,7 @@
"name": "A String", # The server-assigned name, which is only unique within the same service that
# originally returns it. If you use the default HTTP mapping, the
# `name` should have the format of `operations/some/unique/name`.
- "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure.
+ "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
# programming environments, including REST APIs and RPC APIs. It is used by
# [gRPC](https://github.com/grpc). The error model is designed to be:
#
diff --git a/docs/dyn/speech_v1beta1.speech.html b/docs/dyn/speech_v1beta1.speech.html
index 4607dee..2f96060 100644
--- a/docs/dyn/speech_v1beta1.speech.html
+++ b/docs/dyn/speech_v1beta1.speech.html
@@ -114,7 +114,7 @@
"languageCode": "A String", # [Optional] The language of the supplied audio as a BCP-47 language tag.
# Example: "en-GB" https://www.rfc-editor.org/rfc/bcp/bcp47.txt
# If omitted, defaults to "en-US". See
- # [Language Support](https://cloud.google.com/speech/docs/best-practices#language_support)
+ # [Language Support](https://cloud.google.com/speech/docs/languages)
# for a list of the currently supported language codes.
"speechContext": { # Provides "hints" to the speech recognizer to favor specific words and phrases # [Optional] A means to provide context to assist the speech recognition.
# in the results.
@@ -178,7 +178,7 @@
"name": "A String", # The server-assigned name, which is only unique within the same service that
# originally returns it. If you use the default HTTP mapping, the
# `name` should have the format of `operations/some/unique/name`.
- "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure.
+ "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
# programming environments, including REST APIs and RPC APIs. It is used by
# [gRPC](https://github.com/grpc). The error model is designed to be:
#
@@ -275,7 +275,7 @@
"languageCode": "A String", # [Optional] The language of the supplied audio as a BCP-47 language tag.
# Example: "en-GB" https://www.rfc-editor.org/rfc/bcp/bcp47.txt
# If omitted, defaults to "en-US". See
- # [Language Support](https://cloud.google.com/speech/docs/best-practices#language_support)
+ # [Language Support](https://cloud.google.com/speech/docs/languages)
# for a list of the currently supported language codes.
"speechContext": { # Provides "hints" to the speech recognizer to favor specific words and phrases # [Optional] A means to provide context to assist the speech recognition.
# in the results.
diff --git a/docs/dyn/sqladmin_v1beta4.backupRuns.html b/docs/dyn/sqladmin_v1beta4.backupRuns.html
index 4e62913..c75b21f 100644
--- a/docs/dyn/sqladmin_v1beta4.backupRuns.html
+++ b/docs/dyn/sqladmin_v1beta4.backupRuns.html
@@ -82,7 +82,7 @@
<p class="firstline">Retrieves a resource containing information about a backup run.</p>
<p class="toc_element">
<code><a href="#insert">insert(project, instance, body)</a></code></p>
-<p class="firstline">Creates a new backup run on demand.</p>
+<p class="firstline">Creates a new backup run on demand. This method is applicable only to Second Generation instances.</p>
<p class="toc_element">
<code><a href="#list">list(project, instance, maxResults=None, pageToken=None)</a></code></p>
<p class="firstline">Lists all backup runs associated with a given instance and configuration in the reverse chronological order of the enqueued time.</p>
@@ -195,7 +195,7 @@
<div class="method">
<code class="details" id="insert">insert(project, instance, body)</code>
- <pre>Creates a new backup run on demand.
+ <pre>Creates a new backup run on demand. This method is applicable only to Second Generation instances.
Args:
project: string, Project ID of the project that contains the instance. (required)
diff --git a/docs/dyn/sqladmin_v1beta4.instances.html b/docs/dyn/sqladmin_v1beta4.instances.html
index 9042084..51805b7 100644
--- a/docs/dyn/sqladmin_v1beta4.instances.html
+++ b/docs/dyn/sqladmin_v1beta4.instances.html
@@ -508,6 +508,7 @@
"kind": "sql#onPremisesConfiguration", # This is always sql#onPremisesConfiguration.
"hostPort": "A String", # The host and port of the on-premises instance in host:port format
},
+ "connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings.
"kind": "sql#instance", # This is always sql#instance.
"name": "A String", # Name of the Cloud SQL instance. This does not include the project ID.
"ipv6Address": "A String", # The IPv6 address assigned to the instance. This property is applicable only to First Generation instances.
@@ -740,6 +741,7 @@
"kind": "sql#onPremisesConfiguration", # This is always sql#onPremisesConfiguration.
"hostPort": "A String", # The host and port of the on-premises instance in host:port format
},
+ "connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings.
"kind": "sql#instance", # This is always sql#instance.
"name": "A String", # Name of the Cloud SQL instance. This does not include the project ID.
"ipv6Address": "A String", # The IPv6 address assigned to the instance. This property is applicable only to First Generation instances.
@@ -950,6 +952,7 @@
"kind": "sql#onPremisesConfiguration", # This is always sql#onPremisesConfiguration.
"hostPort": "A String", # The host and port of the on-premises instance in host:port format
},
+ "connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings.
"kind": "sql#instance", # This is always sql#instance.
"name": "A String", # Name of the Cloud SQL instance. This does not include the project ID.
"ipv6Address": "A String", # The IPv6 address assigned to the instance. This property is applicable only to First Generation instances.
@@ -1110,6 +1113,7 @@
"kind": "sql#onPremisesConfiguration", # This is always sql#onPremisesConfiguration.
"hostPort": "A String", # The host and port of the on-premises instance in host:port format
},
+ "connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings.
"kind": "sql#instance", # This is always sql#instance.
"name": "A String", # Name of the Cloud SQL instance. This does not include the project ID.
"ipv6Address": "A String", # The IPv6 address assigned to the instance. This property is applicable only to First Generation instances.
@@ -1746,6 +1750,7 @@
"kind": "sql#onPremisesConfiguration", # This is always sql#onPremisesConfiguration.
"hostPort": "A String", # The host and port of the on-premises instance in host:port format
},
+ "connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings.
"kind": "sql#instance", # This is always sql#instance.
"name": "A String", # Name of the Cloud SQL instance. This does not include the project ID.
"ipv6Address": "A String", # The IPv6 address assigned to the instance. This property is applicable only to First Generation instances.
diff --git a/docs/dyn/storage_v1.buckets.html b/docs/dyn/storage_v1.buckets.html
index b63ef41..c2677f6 100644
--- a/docs/dyn/storage_v1.buckets.html
+++ b/docs/dyn/storage_v1.buckets.html
@@ -137,9 +137,6 @@
"name": "A String", # The name of the bucket.
"metageneration": "A String", # The metadata generation of this bucket.
"timeCreated": "A String", # The creation time of the bucket in RFC 3339 format.
- "encryption": { # Encryption configuration used by default for newly inserted objects, when no encryption config is specified.
- "default_kms_key_name": "A String",
- },
"updated": "A String", # The modification time of the bucket in RFC 3339 format.
"versioning": { # The bucket's versioning configuration.
"enabled": True or False, # While set to true, versioning is fully enabled for this bucket.
@@ -176,8 +173,8 @@
"defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided.
{ # An access-control entry.
"domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
+ "generation": "A String", # The content generation of the object, if applied to an object.
+ "object": "A String", # The name of the object, if applied to an object.
"bucket": "A String", # The name of the bucket.
"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
"entity": "A String", # The entity holding the permission, in one of the following forms:
@@ -268,9 +265,6 @@
"name": "A String", # The name of the bucket.
"metageneration": "A String", # The metadata generation of this bucket.
"timeCreated": "A String", # The creation time of the bucket in RFC 3339 format.
- "encryption": { # Encryption configuration used by default for newly inserted objects, when no encryption config is specified.
- "default_kms_key_name": "A String",
- },
"updated": "A String", # The modification time of the bucket in RFC 3339 format.
"versioning": { # The bucket's versioning configuration.
"enabled": True or False, # While set to true, versioning is fully enabled for this bucket.
@@ -307,8 +301,8 @@
"defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided.
{ # An access-control entry.
"domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
+ "generation": "A String", # The content generation of the object, if applied to an object.
+ "object": "A String", # The name of the object, if applied to an object.
"bucket": "A String", # The name of the bucket.
"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
"entity": "A String", # The entity holding the permission, in one of the following forms:
@@ -412,9 +406,6 @@
"name": "A String", # The name of the bucket.
"metageneration": "A String", # The metadata generation of this bucket.
"timeCreated": "A String", # The creation time of the bucket in RFC 3339 format.
- "encryption": { # Encryption configuration used by default for newly inserted objects, when no encryption config is specified.
- "default_kms_key_name": "A String",
- },
"updated": "A String", # The modification time of the bucket in RFC 3339 format.
"versioning": { # The bucket's versioning configuration.
"enabled": True or False, # While set to true, versioning is fully enabled for this bucket.
@@ -451,8 +442,8 @@
"defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided.
{ # An access-control entry.
"domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
+ "generation": "A String", # The content generation of the object, if applied to an object.
+ "object": "A String", # The name of the object, if applied to an object.
"bucket": "A String", # The name of the bucket.
"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
"entity": "A String", # The entity holding the permission, in one of the following forms:
@@ -554,9 +545,6 @@
"name": "A String", # The name of the bucket.
"metageneration": "A String", # The metadata generation of this bucket.
"timeCreated": "A String", # The creation time of the bucket in RFC 3339 format.
- "encryption": { # Encryption configuration used by default for newly inserted objects, when no encryption config is specified.
- "default_kms_key_name": "A String",
- },
"updated": "A String", # The modification time of the bucket in RFC 3339 format.
"versioning": { # The bucket's versioning configuration.
"enabled": True or False, # While set to true, versioning is fully enabled for this bucket.
@@ -593,8 +581,8 @@
"defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided.
{ # An access-control entry.
"domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
+ "generation": "A String", # The content generation of the object, if applied to an object.
+ "object": "A String", # The name of the object, if applied to an object.
"bucket": "A String", # The name of the bucket.
"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
"entity": "A String", # The entity holding the permission, in one of the following forms:
@@ -702,9 +690,6 @@
"name": "A String", # The name of the bucket.
"metageneration": "A String", # The metadata generation of this bucket.
"timeCreated": "A String", # The creation time of the bucket in RFC 3339 format.
- "encryption": { # Encryption configuration used by default for newly inserted objects, when no encryption config is specified.
- "default_kms_key_name": "A String",
- },
"updated": "A String", # The modification time of the bucket in RFC 3339 format.
"versioning": { # The bucket's versioning configuration.
"enabled": True or False, # While set to true, versioning is fully enabled for this bucket.
@@ -741,8 +726,8 @@
"defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided.
{ # An access-control entry.
"domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
+ "generation": "A String", # The content generation of the object, if applied to an object.
+ "object": "A String", # The name of the object, if applied to an object.
"bucket": "A String", # The name of the bucket.
"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
"entity": "A String", # The entity holding the permission, in one of the following forms:
@@ -848,9 +833,6 @@
"name": "A String", # The name of the bucket.
"metageneration": "A String", # The metadata generation of this bucket.
"timeCreated": "A String", # The creation time of the bucket in RFC 3339 format.
- "encryption": { # Encryption configuration used by default for newly inserted objects, when no encryption config is specified.
- "default_kms_key_name": "A String",
- },
"updated": "A String", # The modification time of the bucket in RFC 3339 format.
"versioning": { # The bucket's versioning configuration.
"enabled": True or False, # While set to true, versioning is fully enabled for this bucket.
@@ -887,8 +869,8 @@
"defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided.
{ # An access-control entry.
"domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
+ "generation": "A String", # The content generation of the object, if applied to an object.
+ "object": "A String", # The name of the object, if applied to an object.
"bucket": "A String", # The name of the bucket.
"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
"entity": "A String", # The entity holding the permission, in one of the following forms:
@@ -979,9 +961,6 @@
"name": "A String", # The name of the bucket.
"metageneration": "A String", # The metadata generation of this bucket.
"timeCreated": "A String", # The creation time of the bucket in RFC 3339 format.
- "encryption": { # Encryption configuration used by default for newly inserted objects, when no encryption config is specified.
- "default_kms_key_name": "A String",
- },
"updated": "A String", # The modification time of the bucket in RFC 3339 format.
"versioning": { # The bucket's versioning configuration.
"enabled": True or False, # While set to true, versioning is fully enabled for this bucket.
@@ -1018,8 +997,8 @@
"defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided.
{ # An access-control entry.
"domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
+ "generation": "A String", # The content generation of the object, if applied to an object.
+ "object": "A String", # The name of the object, if applied to an object.
"bucket": "A String", # The name of the bucket.
"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
"entity": "A String", # The entity holding the permission, in one of the following forms:
@@ -1125,9 +1104,6 @@
"name": "A String", # The name of the bucket.
"metageneration": "A String", # The metadata generation of this bucket.
"timeCreated": "A String", # The creation time of the bucket in RFC 3339 format.
- "encryption": { # Encryption configuration used by default for newly inserted objects, when no encryption config is specified.
- "default_kms_key_name": "A String",
- },
"updated": "A String", # The modification time of the bucket in RFC 3339 format.
"versioning": { # The bucket's versioning configuration.
"enabled": True or False, # While set to true, versioning is fully enabled for this bucket.
@@ -1164,8 +1140,8 @@
"defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided.
{ # An access-control entry.
"domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
+ "generation": "A String", # The content generation of the object, if applied to an object.
+ "object": "A String", # The name of the object, if applied to an object.
"bucket": "A String", # The name of the bucket.
"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
"entity": "A String", # The entity holding the permission, in one of the following forms:
diff --git a/docs/dyn/storage_v1.defaultObjectAccessControls.html b/docs/dyn/storage_v1.defaultObjectAccessControls.html
index 401fcfa..555edc0 100644
--- a/docs/dyn/storage_v1.defaultObjectAccessControls.html
+++ b/docs/dyn/storage_v1.defaultObjectAccessControls.html
@@ -116,8 +116,8 @@
{ # An access-control entry.
"domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
+ "generation": "A String", # The content generation of the object, if applied to an object.
+ "object": "A String", # The name of the object, if applied to an object.
"bucket": "A String", # The name of the bucket.
"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
"entity": "A String", # The entity holding the permission, in one of the following forms:
@@ -156,8 +156,8 @@
{ # An access-control entry.
"domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
+ "generation": "A String", # The content generation of the object, if applied to an object.
+ "object": "A String", # The name of the object, if applied to an object.
"bucket": "A String", # The name of the bucket.
"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
"entity": "A String", # The entity holding the permission, in one of the following forms:
@@ -190,8 +190,8 @@
{ # An access-control entry.
"domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
+ "generation": "A String", # The content generation of the object, if applied to an object.
+ "object": "A String", # The name of the object, if applied to an object.
"bucket": "A String", # The name of the bucket.
"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
"entity": "A String", # The entity holding the permission, in one of the following forms:
@@ -233,7 +233,35 @@
{ # An access-control list.
"items": [ # The list of items.
- "",
+ { # An access-control entry.
+ "domain": "A String", # The domain associated with the entity, if any.
+ "generation": "A String", # The content generation of the object, if applied to an object.
+ "object": "A String", # The name of the object, if applied to an object.
+ "bucket": "A String", # The name of the bucket.
+ "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
+ "entity": "A String", # The entity holding the permission, in one of the following forms:
+ # - user-userId
+ # - user-email
+ # - group-groupId
+ # - group-email
+ # - domain-domain
+ # - project-team-projectId
+ # - allUsers
+ # - allAuthenticatedUsers Examples:
+ # - The user liz@example.com would be user-liz@example.com.
+ # - The group example@googlegroups.com would be group-example@googlegroups.com.
+ # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
+ "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
+ "role": "A String", # The access permission for the entity.
+ "id": "A String", # The ID of the access-control entry.
+ "entityId": "A String", # The ID for the entity, if any.
+ "projectTeam": { # The project team associated with the entity, if any.
+ "projectNumber": "A String", # The project number.
+ "team": "A String", # The team.
+ },
+ "email": "A String", # The email address associated with the entity, if any.
+ "selfLink": "A String", # The link to this access-control entry.
+ },
],
"kind": "storage#objectAccessControls", # The kind of item this is. For lists of object access control entries, this is always storage#objectAccessControls.
}</pre>
@@ -251,8 +279,8 @@
{ # An access-control entry.
"domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
+ "generation": "A String", # The content generation of the object, if applied to an object.
+ "object": "A String", # The name of the object, if applied to an object.
"bucket": "A String", # The name of the bucket.
"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
"entity": "A String", # The entity holding the permission, in one of the following forms:
@@ -285,8 +313,8 @@
{ # An access-control entry.
"domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
+ "generation": "A String", # The content generation of the object, if applied to an object.
+ "object": "A String", # The name of the object, if applied to an object.
"bucket": "A String", # The name of the bucket.
"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
"entity": "A String", # The entity holding the permission, in one of the following forms:
@@ -326,8 +354,8 @@
{ # An access-control entry.
"domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
+ "generation": "A String", # The content generation of the object, if applied to an object.
+ "object": "A String", # The name of the object, if applied to an object.
"bucket": "A String", # The name of the bucket.
"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
"entity": "A String", # The entity holding the permission, in one of the following forms:
@@ -360,8 +388,8 @@
{ # An access-control entry.
"domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
+ "generation": "A String", # The content generation of the object, if applied to an object.
+ "object": "A String", # The name of the object, if applied to an object.
"bucket": "A String", # The name of the bucket.
"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
"entity": "A String", # The entity holding the permission, in one of the following forms:
diff --git a/docs/dyn/storage_v1.objectAccessControls.html b/docs/dyn/storage_v1.objectAccessControls.html
index 6cbf414..f3d94e0 100644
--- a/docs/dyn/storage_v1.objectAccessControls.html
+++ b/docs/dyn/storage_v1.objectAccessControls.html
@@ -120,8 +120,8 @@
{ # An access-control entry.
"domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
+ "generation": "A String", # The content generation of the object, if applied to an object.
+ "object": "A String", # The name of the object, if applied to an object.
"bucket": "A String", # The name of the bucket.
"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
"entity": "A String", # The entity holding the permission, in one of the following forms:
@@ -161,8 +161,8 @@
{ # An access-control entry.
"domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
+ "generation": "A String", # The content generation of the object, if applied to an object.
+ "object": "A String", # The name of the object, if applied to an object.
"bucket": "A String", # The name of the bucket.
"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
"entity": "A String", # The entity holding the permission, in one of the following forms:
@@ -196,8 +196,8 @@
{ # An access-control entry.
"domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
+ "generation": "A String", # The content generation of the object, if applied to an object.
+ "object": "A String", # The name of the object, if applied to an object.
"bucket": "A String", # The name of the bucket.
"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
"entity": "A String", # The entity holding the permission, in one of the following forms:
@@ -239,7 +239,35 @@
{ # An access-control list.
"items": [ # The list of items.
- "",
+ { # An access-control entry.
+ "domain": "A String", # The domain associated with the entity, if any.
+ "generation": "A String", # The content generation of the object, if applied to an object.
+ "object": "A String", # The name of the object, if applied to an object.
+ "bucket": "A String", # The name of the bucket.
+ "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
+ "entity": "A String", # The entity holding the permission, in one of the following forms:
+ # - user-userId
+ # - user-email
+ # - group-groupId
+ # - group-email
+ # - domain-domain
+ # - project-team-projectId
+ # - allUsers
+ # - allAuthenticatedUsers Examples:
+ # - The user liz@example.com would be user-liz@example.com.
+ # - The group example@googlegroups.com would be group-example@googlegroups.com.
+ # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
+ "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
+ "role": "A String", # The access permission for the entity.
+ "id": "A String", # The ID of the access-control entry.
+ "entityId": "A String", # The ID for the entity, if any.
+ "projectTeam": { # The project team associated with the entity, if any.
+ "projectNumber": "A String", # The project number.
+ "team": "A String", # The team.
+ },
+ "email": "A String", # The email address associated with the entity, if any.
+ "selfLink": "A String", # The link to this access-control entry.
+ },
],
"kind": "storage#objectAccessControls", # The kind of item this is. For lists of object access control entries, this is always storage#objectAccessControls.
}</pre>
@@ -258,8 +286,8 @@
{ # An access-control entry.
"domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
+ "generation": "A String", # The content generation of the object, if applied to an object.
+ "object": "A String", # The name of the object, if applied to an object.
"bucket": "A String", # The name of the bucket.
"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
"entity": "A String", # The entity holding the permission, in one of the following forms:
@@ -293,8 +321,8 @@
{ # An access-control entry.
"domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
+ "generation": "A String", # The content generation of the object, if applied to an object.
+ "object": "A String", # The name of the object, if applied to an object.
"bucket": "A String", # The name of the bucket.
"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
"entity": "A String", # The entity holding the permission, in one of the following forms:
@@ -335,8 +363,8 @@
{ # An access-control entry.
"domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
+ "generation": "A String", # The content generation of the object, if applied to an object.
+ "object": "A String", # The name of the object, if applied to an object.
"bucket": "A String", # The name of the bucket.
"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
"entity": "A String", # The entity holding the permission, in one of the following forms:
@@ -370,8 +398,8 @@
{ # An access-control entry.
"domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
+ "generation": "A String", # The content generation of the object, if applied to an object.
+ "object": "A String", # The name of the object, if applied to an object.
"bucket": "A String", # The name of the bucket.
"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
"entity": "A String", # The entity holding the permission, in one of the following forms:
diff --git a/docs/dyn/storage_v1.objects.html b/docs/dyn/storage_v1.objects.html
index 738a7df..62dc691 100644
--- a/docs/dyn/storage_v1.objects.html
+++ b/docs/dyn/storage_v1.objects.html
@@ -75,10 +75,10 @@
<h1><a href="storage_v1.html">Cloud Storage JSON API</a> . <a href="storage_v1.objects.html">objects</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#compose">compose(destinationBucket, destinationObject, body, ifGenerationMatch=None, ifMetagenerationMatch=None, destinationPredefinedAcl=None, kmsKeyName=None)</a></code></p>
+ <code><a href="#compose">compose(destinationBucket, destinationObject, body, ifGenerationMatch=None, ifMetagenerationMatch=None, destinationPredefinedAcl=None)</a></code></p>
<p class="firstline">Concatenates a list of existing objects into a new object in the same bucket.</p>
<p class="toc_element">
- <code><a href="#compose_media">compose_media(destinationBucket, destinationObject, body, ifGenerationMatch=None, ifMetagenerationMatch=None, destinationPredefinedAcl=None, kmsKeyName=None)</a></code></p>
+ <code><a href="#compose_media">compose_media(destinationBucket, destinationObject, body, ifGenerationMatch=None, ifMetagenerationMatch=None, destinationPredefinedAcl=None)</a></code></p>
<p class="firstline">Concatenates a list of existing objects into a new object in the same bucket.</p>
<p class="toc_element">
<code><a href="#copy">copy(sourceBucket, sourceObject, destinationBucket, destinationObject, body, projection=None, sourceGeneration=None, ifSourceGenerationNotMatch=None, ifSourceMetagenerationNotMatch=None, ifGenerationMatch=None, ifGenerationNotMatch=None, ifMetagenerationMatch=None, destinationPredefinedAcl=None, ifSourceGenerationMatch=None, ifSourceMetagenerationMatch=None, ifMetagenerationNotMatch=None)</a></code></p>
@@ -96,10 +96,10 @@
<code><a href="#get_media">get_media(bucket, object, ifGenerationNotMatch=None, generation=None, ifMetagenerationMatch=None, ifGenerationMatch=None, ifMetagenerationNotMatch=None, projection=None)</a></code></p>
<p class="firstline">Retrieves an object or its metadata.</p>
<p class="toc_element">
- <code><a href="#insert">insert(bucket, body=None, projection=None, kmsKeyName=None, media_body=None, predefinedAcl=None, ifGenerationMatch=None, ifGenerationNotMatch=None, name=None, ifMetagenerationMatch=None, contentEncoding=None, ifMetagenerationNotMatch=None)</a></code></p>
+ <code><a href="#insert">insert(bucket, body=None, projection=None, media_body=None, predefinedAcl=None, ifGenerationMatch=None, ifGenerationNotMatch=None, name=None, ifMetagenerationMatch=None, contentEncoding=None, ifMetagenerationNotMatch=None)</a></code></p>
<p class="firstline">Stores a new object and metadata.</p>
<p class="toc_element">
- <code><a href="#insert_media">insert_media(bucket, body=None, projection=None, kmsKeyName=None, media_body=None, predefinedAcl=None, ifGenerationMatch=None, ifGenerationNotMatch=None, name=None, ifMetagenerationMatch=None, contentEncoding=None, ifMetagenerationNotMatch=None)</a></code></p>
+ <code><a href="#insert_media">insert_media(bucket, body=None, projection=None, media_body=None, predefinedAcl=None, ifGenerationMatch=None, ifGenerationNotMatch=None, name=None, ifMetagenerationMatch=None, contentEncoding=None, ifMetagenerationNotMatch=None)</a></code></p>
<p class="firstline">Stores a new object and metadata.</p>
<p class="toc_element">
<code><a href="#list">list(bucket, projection=None, versions=None, delimiter=None, maxResults=None, pageToken=None, prefix=None)</a></code></p>
@@ -111,7 +111,7 @@
<code><a href="#patch">patch(bucket, object, body, ifGenerationMatch=None, ifGenerationNotMatch=None, generation=None, ifMetagenerationMatch=None, predefinedAcl=None, ifMetagenerationNotMatch=None, projection=None)</a></code></p>
<p class="firstline">Updates an object's metadata. This method supports patch semantics.</p>
<p class="toc_element">
- <code><a href="#rewrite">rewrite(sourceBucket, sourceObject, destinationBucket, destinationObject, body, projection=None, sourceGeneration=None, maxBytesRewrittenPerCall=None, ifSourceGenerationNotMatch=None, ifGenerationMatch=None, ifGenerationNotMatch=None, ifSourceMetagenerationNotMatch=None, destinationKmsKeyName=None, rewriteToken=None, ifMetagenerationMatch=None, destinationPredefinedAcl=None, ifSourceGenerationMatch=None, ifSourceMetagenerationMatch=None, ifMetagenerationNotMatch=None)</a></code></p>
+ <code><a href="#rewrite">rewrite(sourceBucket, sourceObject, destinationBucket, destinationObject, body, projection=None, sourceGeneration=None, maxBytesRewrittenPerCall=None, ifSourceGenerationNotMatch=None, ifGenerationMatch=None, ifGenerationNotMatch=None, ifSourceMetagenerationNotMatch=None, rewriteToken=None, ifMetagenerationMatch=None, destinationPredefinedAcl=None, ifSourceGenerationMatch=None, ifSourceMetagenerationMatch=None, ifMetagenerationNotMatch=None)</a></code></p>
<p class="firstline">Rewrites a source object to a destination object. Optionally overrides metadata.</p>
<p class="toc_element">
<code><a href="#update">update(bucket, object, body, ifGenerationMatch=None, ifGenerationNotMatch=None, generation=None, ifMetagenerationMatch=None, predefinedAcl=None, ifMetagenerationNotMatch=None, projection=None)</a></code></p>
@@ -124,7 +124,7 @@
<p class="firstline">Watch for changes on all objects in a bucket.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="compose">compose(destinationBucket, destinationObject, body, ifGenerationMatch=None, ifMetagenerationMatch=None, destinationPredefinedAcl=None, kmsKeyName=None)</code>
+ <code class="details" id="compose">compose(destinationBucket, destinationObject, body, ifGenerationMatch=None, ifMetagenerationMatch=None, destinationPredefinedAcl=None)</code>
<pre>Concatenates a list of existing objects into a new object in the same bucket.
Args:
@@ -139,7 +139,6 @@
"generation": "A String", # The content generation of this object. Used for object versioning.
"componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations.
"mediaLink": "A String", # Media download link.
- "kmsKeyName": "A String", # Cloud KMS Key used to encrypt this object, if the object is encrypted by such a key.
"owner": { # The owner of the object. This will always be the uploader of the object.
"entityId": "A String", # The ID for the entity.
"entity": "A String", # The entity, in the form user-userId.
@@ -148,8 +147,8 @@
"acl": [ # Access controls on the object.
{ # An access-control entry.
"domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
+ "generation": "A String", # The content generation of the object, if applied to an object.
+ "object": "A String", # The name of the object, if applied to an object.
"bucket": "A String", # The name of the bucket.
"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
"entity": "A String", # The entity holding the permission, in one of the following forms:
@@ -223,7 +222,6 @@
private - Object owner gets OWNER access.
projectPrivate - Object owner gets OWNER access, and project team members get access according to their roles.
publicRead - Object owner gets OWNER access, and allUsers get READER access.
- kmsKeyName: string, Resource name of the Cloud KMS key, of the form projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadata's kms_key_name value, if any.
Returns:
An object of the form:
@@ -232,7 +230,6 @@
"generation": "A String", # The content generation of this object. Used for object versioning.
"componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations.
"mediaLink": "A String", # Media download link.
- "kmsKeyName": "A String", # Cloud KMS Key used to encrypt this object, if the object is encrypted by such a key.
"owner": { # The owner of the object. This will always be the uploader of the object.
"entityId": "A String", # The ID for the entity.
"entity": "A String", # The entity, in the form user-userId.
@@ -241,8 +238,8 @@
"acl": [ # Access controls on the object.
{ # An access-control entry.
"domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
+ "generation": "A String", # The content generation of the object, if applied to an object.
+ "object": "A String", # The name of the object, if applied to an object.
"bucket": "A String", # The name of the bucket.
"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
"entity": "A String", # The entity holding the permission, in one of the following forms:
@@ -298,7 +295,7 @@
</div>
<div class="method">
- <code class="details" id="compose_media">compose_media(destinationBucket, destinationObject, body, ifGenerationMatch=None, ifMetagenerationMatch=None, destinationPredefinedAcl=None, kmsKeyName=None)</code>
+ <code class="details" id="compose_media">compose_media(destinationBucket, destinationObject, body, ifGenerationMatch=None, ifMetagenerationMatch=None, destinationPredefinedAcl=None)</code>
<pre>Concatenates a list of existing objects into a new object in the same bucket.
Args:
@@ -313,7 +310,6 @@
"generation": "A String", # The content generation of this object. Used for object versioning.
"componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations.
"mediaLink": "A String", # Media download link.
- "kmsKeyName": "A String", # Cloud KMS Key used to encrypt this object, if the object is encrypted by such a key.
"owner": { # The owner of the object. This will always be the uploader of the object.
"entityId": "A String", # The ID for the entity.
"entity": "A String", # The entity, in the form user-userId.
@@ -322,8 +318,8 @@
"acl": [ # Access controls on the object.
{ # An access-control entry.
"domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
+ "generation": "A String", # The content generation of the object, if applied to an object.
+ "object": "A String", # The name of the object, if applied to an object.
"bucket": "A String", # The name of the bucket.
"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
"entity": "A String", # The entity holding the permission, in one of the following forms:
@@ -397,7 +393,6 @@
private - Object owner gets OWNER access.
projectPrivate - Object owner gets OWNER access, and project team members get access according to their roles.
publicRead - Object owner gets OWNER access, and allUsers get READER access.
- kmsKeyName: string, Resource name of the Cloud KMS key, of the form projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadata's kms_key_name value, if any.
Returns:
The media object as a string.
@@ -421,7 +416,6 @@
"generation": "A String", # The content generation of this object. Used for object versioning.
"componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations.
"mediaLink": "A String", # Media download link.
- "kmsKeyName": "A String", # Cloud KMS Key used to encrypt this object, if the object is encrypted by such a key.
"owner": { # The owner of the object. This will always be the uploader of the object.
"entityId": "A String", # The ID for the entity.
"entity": "A String", # The entity, in the form user-userId.
@@ -430,8 +424,8 @@
"acl": [ # Access controls on the object.
{ # An access-control entry.
"domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
+ "generation": "A String", # The content generation of the object, if applied to an object.
+ "object": "A String", # The name of the object, if applied to an object.
"bucket": "A String", # The name of the bucket.
"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
"entity": "A String", # The entity holding the permission, in one of the following forms:
@@ -514,7 +508,6 @@
"generation": "A String", # The content generation of this object. Used for object versioning.
"componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations.
"mediaLink": "A String", # Media download link.
- "kmsKeyName": "A String", # Cloud KMS Key used to encrypt this object, if the object is encrypted by such a key.
"owner": { # The owner of the object. This will always be the uploader of the object.
"entityId": "A String", # The ID for the entity.
"entity": "A String", # The entity, in the form user-userId.
@@ -523,8 +516,8 @@
"acl": [ # Access controls on the object.
{ # An access-control entry.
"domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
+ "generation": "A String", # The content generation of the object, if applied to an object.
+ "object": "A String", # The name of the object, if applied to an object.
"bucket": "A String", # The name of the bucket.
"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
"entity": "A String", # The entity holding the permission, in one of the following forms:
@@ -595,7 +588,6 @@
"generation": "A String", # The content generation of this object. Used for object versioning.
"componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations.
"mediaLink": "A String", # Media download link.
- "kmsKeyName": "A String", # Cloud KMS Key used to encrypt this object, if the object is encrypted by such a key.
"owner": { # The owner of the object. This will always be the uploader of the object.
"entityId": "A String", # The ID for the entity.
"entity": "A String", # The entity, in the form user-userId.
@@ -604,8 +596,8 @@
"acl": [ # Access controls on the object.
{ # An access-control entry.
"domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
+ "generation": "A String", # The content generation of the object, if applied to an object.
+ "object": "A String", # The name of the object, if applied to an object.
"bucket": "A String", # The name of the bucket.
"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
"entity": "A String", # The entity holding the permission, in one of the following forms:
@@ -726,7 +718,6 @@
"generation": "A String", # The content generation of this object. Used for object versioning.
"componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations.
"mediaLink": "A String", # Media download link.
- "kmsKeyName": "A String", # Cloud KMS Key used to encrypt this object, if the object is encrypted by such a key.
"owner": { # The owner of the object. This will always be the uploader of the object.
"entityId": "A String", # The ID for the entity.
"entity": "A String", # The entity, in the form user-userId.
@@ -735,8 +726,8 @@
"acl": [ # Access controls on the object.
{ # An access-control entry.
"domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
+ "generation": "A String", # The content generation of the object, if applied to an object.
+ "object": "A String", # The name of the object, if applied to an object.
"bucket": "A String", # The name of the bucket.
"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
"entity": "A String", # The entity holding the permission, in one of the following forms:
@@ -815,7 +806,7 @@
</div>
<div class="method">
- <code class="details" id="insert">insert(bucket, body=None, projection=None, kmsKeyName=None, media_body=None, predefinedAcl=None, ifGenerationMatch=None, ifGenerationNotMatch=None, name=None, ifMetagenerationMatch=None, contentEncoding=None, ifMetagenerationNotMatch=None)</code>
+ <code class="details" id="insert">insert(bucket, body=None, projection=None, media_body=None, predefinedAcl=None, ifGenerationMatch=None, ifGenerationNotMatch=None, name=None, ifMetagenerationMatch=None, contentEncoding=None, ifMetagenerationNotMatch=None)</code>
<pre>Stores a new object and metadata.
Args:
@@ -827,7 +818,6 @@
"generation": "A String", # The content generation of this object. Used for object versioning.
"componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations.
"mediaLink": "A String", # Media download link.
- "kmsKeyName": "A String", # Cloud KMS Key used to encrypt this object, if the object is encrypted by such a key.
"owner": { # The owner of the object. This will always be the uploader of the object.
"entityId": "A String", # The ID for the entity.
"entity": "A String", # The entity, in the form user-userId.
@@ -836,8 +826,8 @@
"acl": [ # Access controls on the object.
{ # An access-control entry.
"domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
+ "generation": "A String", # The content generation of the object, if applied to an object.
+ "object": "A String", # The name of the object, if applied to an object.
"bucket": "A String", # The name of the bucket.
"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
"entity": "A String", # The entity holding the permission, in one of the following forms:
@@ -895,7 +885,6 @@
Allowed values
full - Include all properties.
noAcl - Omit the owner, acl property.
- kmsKeyName: string, Resource name of the Cloud KMS key, of the form projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadata's kms_key_name value, if any.
media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
predefinedAcl: string, Apply a predefined set of access controls to this object.
Allowed values
@@ -919,7 +908,6 @@
"generation": "A String", # The content generation of this object. Used for object versioning.
"componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations.
"mediaLink": "A String", # Media download link.
- "kmsKeyName": "A String", # Cloud KMS Key used to encrypt this object, if the object is encrypted by such a key.
"owner": { # The owner of the object. This will always be the uploader of the object.
"entityId": "A String", # The ID for the entity.
"entity": "A String", # The entity, in the form user-userId.
@@ -928,8 +916,8 @@
"acl": [ # Access controls on the object.
{ # An access-control entry.
"domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
+ "generation": "A String", # The content generation of the object, if applied to an object.
+ "object": "A String", # The name of the object, if applied to an object.
"bucket": "A String", # The name of the bucket.
"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
"entity": "A String", # The entity holding the permission, in one of the following forms:
@@ -985,7 +973,7 @@
</div>
<div class="method">
- <code class="details" id="insert_media">insert_media(bucket, body=None, projection=None, kmsKeyName=None, media_body=None, predefinedAcl=None, ifGenerationMatch=None, ifGenerationNotMatch=None, name=None, ifMetagenerationMatch=None, contentEncoding=None, ifMetagenerationNotMatch=None)</code>
+ <code class="details" id="insert_media">insert_media(bucket, body=None, projection=None, media_body=None, predefinedAcl=None, ifGenerationMatch=None, ifGenerationNotMatch=None, name=None, ifMetagenerationMatch=None, contentEncoding=None, ifMetagenerationNotMatch=None)</code>
<pre>Stores a new object and metadata.
Args:
@@ -997,7 +985,6 @@
"generation": "A String", # The content generation of this object. Used for object versioning.
"componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations.
"mediaLink": "A String", # Media download link.
- "kmsKeyName": "A String", # Cloud KMS Key used to encrypt this object, if the object is encrypted by such a key.
"owner": { # The owner of the object. This will always be the uploader of the object.
"entityId": "A String", # The ID for the entity.
"entity": "A String", # The entity, in the form user-userId.
@@ -1006,8 +993,8 @@
"acl": [ # Access controls on the object.
{ # An access-control entry.
"domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
+ "generation": "A String", # The content generation of the object, if applied to an object.
+ "object": "A String", # The name of the object, if applied to an object.
"bucket": "A String", # The name of the bucket.
"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
"entity": "A String", # The entity holding the permission, in one of the following forms:
@@ -1065,7 +1052,6 @@
Allowed values
full - Include all properties.
noAcl - Omit the owner, acl property.
- kmsKeyName: string, Resource name of the Cloud KMS key, of the form projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadata's kms_key_name value, if any.
media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
predefinedAcl: string, Apply a predefined set of access controls to this object.
Allowed values
@@ -1114,7 +1100,6 @@
"generation": "A String", # The content generation of this object. Used for object versioning.
"componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations.
"mediaLink": "A String", # Media download link.
- "kmsKeyName": "A String", # Cloud KMS Key used to encrypt this object, if the object is encrypted by such a key.
"owner": { # The owner of the object. This will always be the uploader of the object.
"entityId": "A String", # The ID for the entity.
"entity": "A String", # The entity, in the form user-userId.
@@ -1123,8 +1108,8 @@
"acl": [ # Access controls on the object.
{ # An access-control entry.
"domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
+ "generation": "A String", # The content generation of the object, if applied to an object.
+ "object": "A String", # The name of the object, if applied to an object.
"bucket": "A String", # The name of the bucket.
"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
"entity": "A String", # The entity holding the permission, in one of the following forms:
@@ -1213,7 +1198,6 @@
"generation": "A String", # The content generation of this object. Used for object versioning.
"componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations.
"mediaLink": "A String", # Media download link.
- "kmsKeyName": "A String", # Cloud KMS Key used to encrypt this object, if the object is encrypted by such a key.
"owner": { # The owner of the object. This will always be the uploader of the object.
"entityId": "A String", # The ID for the entity.
"entity": "A String", # The entity, in the form user-userId.
@@ -1222,8 +1206,8 @@
"acl": [ # Access controls on the object.
{ # An access-control entry.
"domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
+ "generation": "A String", # The content generation of the object, if applied to an object.
+ "object": "A String", # The name of the object, if applied to an object.
"bucket": "A String", # The name of the bucket.
"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
"entity": "A String", # The entity holding the permission, in one of the following forms:
@@ -1302,7 +1286,6 @@
"generation": "A String", # The content generation of this object. Used for object versioning.
"componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations.
"mediaLink": "A String", # Media download link.
- "kmsKeyName": "A String", # Cloud KMS Key used to encrypt this object, if the object is encrypted by such a key.
"owner": { # The owner of the object. This will always be the uploader of the object.
"entityId": "A String", # The ID for the entity.
"entity": "A String", # The entity, in the form user-userId.
@@ -1311,8 +1294,8 @@
"acl": [ # Access controls on the object.
{ # An access-control entry.
"domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
+ "generation": "A String", # The content generation of the object, if applied to an object.
+ "object": "A String", # The name of the object, if applied to an object.
"bucket": "A String", # The name of the bucket.
"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
"entity": "A String", # The entity holding the permission, in one of the following forms:
@@ -1368,7 +1351,7 @@
</div>
<div class="method">
- <code class="details" id="rewrite">rewrite(sourceBucket, sourceObject, destinationBucket, destinationObject, body, projection=None, sourceGeneration=None, maxBytesRewrittenPerCall=None, ifSourceGenerationNotMatch=None, ifGenerationMatch=None, ifGenerationNotMatch=None, ifSourceMetagenerationNotMatch=None, destinationKmsKeyName=None, rewriteToken=None, ifMetagenerationMatch=None, destinationPredefinedAcl=None, ifSourceGenerationMatch=None, ifSourceMetagenerationMatch=None, ifMetagenerationNotMatch=None)</code>
+ <code class="details" id="rewrite">rewrite(sourceBucket, sourceObject, destinationBucket, destinationObject, body, projection=None, sourceGeneration=None, maxBytesRewrittenPerCall=None, ifSourceGenerationNotMatch=None, ifGenerationMatch=None, ifGenerationNotMatch=None, ifSourceMetagenerationNotMatch=None, rewriteToken=None, ifMetagenerationMatch=None, destinationPredefinedAcl=None, ifSourceGenerationMatch=None, ifSourceMetagenerationMatch=None, ifMetagenerationNotMatch=None)</code>
<pre>Rewrites a source object to a destination object. Optionally overrides metadata.
Args:
@@ -1383,7 +1366,6 @@
"generation": "A String", # The content generation of this object. Used for object versioning.
"componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations.
"mediaLink": "A String", # Media download link.
- "kmsKeyName": "A String", # Cloud KMS Key used to encrypt this object, if the object is encrypted by such a key.
"owner": { # The owner of the object. This will always be the uploader of the object.
"entityId": "A String", # The ID for the entity.
"entity": "A String", # The entity, in the form user-userId.
@@ -1392,8 +1374,8 @@
"acl": [ # Access controls on the object.
{ # An access-control entry.
"domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
+ "generation": "A String", # The content generation of the object, if applied to an object.
+ "object": "A String", # The name of the object, if applied to an object.
"bucket": "A String", # The name of the bucket.
"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
"entity": "A String", # The entity holding the permission, in one of the following forms:
@@ -1457,7 +1439,6 @@
ifGenerationMatch: string, Makes the operation conditional on whether the destination object's current generation matches the given value.
ifGenerationNotMatch: string, Makes the operation conditional on whether the destination object's current generation does not match the given value.
ifSourceMetagenerationNotMatch: string, Makes the operation conditional on whether the source object's current metageneration does not match the given value.
- destinationKmsKeyName: string, Resource name of the Cloud KMS key, of the form projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadata's kms_key_name value, if any.
rewriteToken: string, Include this field (from the previous rewrite response) on each rewrite request after the first one, until the rewrite response 'done' flag is true. Calls that provide a rewriteToken can omit all other request fields, but if included those fields must match the values provided in the first rewrite request.
ifMetagenerationMatch: string, Makes the operation conditional on whether the destination object's current metageneration matches the given value.
destinationPredefinedAcl: string, Apply a predefined set of access controls to the destination object.
@@ -1482,7 +1463,6 @@
"generation": "A String", # The content generation of this object. Used for object versioning.
"componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations.
"mediaLink": "A String", # Media download link.
- "kmsKeyName": "A String", # Cloud KMS Key used to encrypt this object, if the object is encrypted by such a key.
"owner": { # The owner of the object. This will always be the uploader of the object.
"entityId": "A String", # The ID for the entity.
"entity": "A String", # The entity, in the form user-userId.
@@ -1491,8 +1471,8 @@
"acl": [ # Access controls on the object.
{ # An access-control entry.
"domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
+ "generation": "A String", # The content generation of the object, if applied to an object.
+ "object": "A String", # The name of the object, if applied to an object.
"bucket": "A String", # The name of the bucket.
"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
"entity": "A String", # The entity holding the permission, in one of the following forms:
@@ -1565,7 +1545,6 @@
"generation": "A String", # The content generation of this object. Used for object versioning.
"componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations.
"mediaLink": "A String", # Media download link.
- "kmsKeyName": "A String", # Cloud KMS Key used to encrypt this object, if the object is encrypted by such a key.
"owner": { # The owner of the object. This will always be the uploader of the object.
"entityId": "A String", # The ID for the entity.
"entity": "A String", # The entity, in the form user-userId.
@@ -1574,8 +1553,8 @@
"acl": [ # Access controls on the object.
{ # An access-control entry.
"domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
+ "generation": "A String", # The content generation of the object, if applied to an object.
+ "object": "A String", # The name of the object, if applied to an object.
"bucket": "A String", # The name of the bucket.
"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
"entity": "A String", # The entity holding the permission, in one of the following forms:
@@ -1654,7 +1633,6 @@
"generation": "A String", # The content generation of this object. Used for object versioning.
"componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations.
"mediaLink": "A String", # Media download link.
- "kmsKeyName": "A String", # Cloud KMS Key used to encrypt this object, if the object is encrypted by such a key.
"owner": { # The owner of the object. This will always be the uploader of the object.
"entityId": "A String", # The ID for the entity.
"entity": "A String", # The entity, in the form user-userId.
@@ -1663,8 +1641,8 @@
"acl": [ # Access controls on the object.
{ # An access-control entry.
"domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
+ "generation": "A String", # The content generation of the object, if applied to an object.
+ "object": "A String", # The name of the object, if applied to an object.
"bucket": "A String", # The name of the bucket.
"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
"entity": "A String", # The entity holding the permission, in one of the following forms:
@@ -1733,7 +1711,6 @@
"generation": "A String", # The content generation of this object. Used for object versioning.
"componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations.
"mediaLink": "A String", # Media download link.
- "kmsKeyName": "A String", # Cloud KMS Key used to encrypt this object, if the object is encrypted by such a key.
"owner": { # The owner of the object. This will always be the uploader of the object.
"entityId": "A String", # The ID for the entity.
"entity": "A String", # The entity, in the form user-userId.
@@ -1742,8 +1719,8 @@
"acl": [ # Access controls on the object.
{ # An access-control entry.
"domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
+ "generation": "A String", # The content generation of the object, if applied to an object.
+ "object": "A String", # The name of the object, if applied to an object.
"bucket": "A String", # The name of the bucket.
"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
"entity": "A String", # The entity holding the permission, in one of the following forms:
diff --git a/docs/dyn/tasks_v1.tasklists.html b/docs/dyn/tasks_v1.tasklists.html
index 3e70ee3..6267117 100644
--- a/docs/dyn/tasks_v1.tasklists.html
+++ b/docs/dyn/tasks_v1.tasklists.html
@@ -117,11 +117,10 @@
{
"kind": "tasks#taskList", # Type of the resource. This is always "tasks#taskList".
- "title": "A String", # Title of the task list.
- "updated": "A String", # Last modification time of the task list (as a RFC 3339 timestamp).
"etag": "A String", # ETag of the resource.
"id": "A String", # Task list identifier.
"selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list.
+ "title": "A String", # Title of the task list.
}</pre>
</div>
@@ -135,11 +134,10 @@
{
"kind": "tasks#taskList", # Type of the resource. This is always "tasks#taskList".
- "title": "A String", # Title of the task list.
- "updated": "A String", # Last modification time of the task list (as a RFC 3339 timestamp).
"etag": "A String", # ETag of the resource.
"id": "A String", # Task list identifier.
"selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list.
+ "title": "A String", # Title of the task list.
}
@@ -148,11 +146,10 @@
{
"kind": "tasks#taskList", # Type of the resource. This is always "tasks#taskList".
- "title": "A String", # Title of the task list.
- "updated": "A String", # Last modification time of the task list (as a RFC 3339 timestamp).
"etag": "A String", # ETag of the resource.
"id": "A String", # Task list identifier.
"selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list.
+ "title": "A String", # Title of the task list.
}</pre>
</div>
@@ -162,7 +159,7 @@
Args:
pageToken: string, Token specifying the result page to return. Optional.
- maxResults: string, Maximum number of task lists returned on one page. Optional. The default is 100.
+ maxResults: integer, Maximum number of task lists returned on one page. Optional. The default is 100.
Returns:
An object of the form:
@@ -172,11 +169,10 @@
"items": [ # Collection of task lists.
{
"kind": "tasks#taskList", # Type of the resource. This is always "tasks#taskList".
- "title": "A String", # Title of the task list.
- "updated": "A String", # Last modification time of the task list (as a RFC 3339 timestamp).
"etag": "A String", # ETag of the resource.
"id": "A String", # Task list identifier.
"selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list.
+ "title": "A String", # Title of the task list.
},
],
"kind": "tasks#taskLists", # Type of the resource. This is always "tasks#taskLists".
@@ -209,11 +205,10 @@
{
"kind": "tasks#taskList", # Type of the resource. This is always "tasks#taskList".
- "title": "A String", # Title of the task list.
- "updated": "A String", # Last modification time of the task list (as a RFC 3339 timestamp).
"etag": "A String", # ETag of the resource.
"id": "A String", # Task list identifier.
"selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list.
+ "title": "A String", # Title of the task list.
}
@@ -222,11 +217,10 @@
{
"kind": "tasks#taskList", # Type of the resource. This is always "tasks#taskList".
- "title": "A String", # Title of the task list.
- "updated": "A String", # Last modification time of the task list (as a RFC 3339 timestamp).
"etag": "A String", # ETag of the resource.
"id": "A String", # Task list identifier.
"selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list.
+ "title": "A String", # Title of the task list.
}</pre>
</div>
@@ -241,11 +235,10 @@
{
"kind": "tasks#taskList", # Type of the resource. This is always "tasks#taskList".
- "title": "A String", # Title of the task list.
- "updated": "A String", # Last modification time of the task list (as a RFC 3339 timestamp).
"etag": "A String", # ETag of the resource.
"id": "A String", # Task list identifier.
"selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list.
+ "title": "A String", # Title of the task list.
}
@@ -254,11 +247,10 @@
{
"kind": "tasks#taskList", # Type of the resource. This is always "tasks#taskList".
- "title": "A String", # Title of the task list.
- "updated": "A String", # Last modification time of the task list (as a RFC 3339 timestamp).
"etag": "A String", # ETag of the resource.
"id": "A String", # Task list identifier.
"selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list.
+ "title": "A String", # Title of the task list.
}</pre>
</div>
diff --git a/docs/dyn/tasks_v1.tasks.html b/docs/dyn/tasks_v1.tasks.html
index d580833..6f2117e 100644
--- a/docs/dyn/tasks_v1.tasks.html
+++ b/docs/dyn/tasks_v1.tasks.html
@@ -87,7 +87,7 @@
<code><a href="#insert">insert(tasklist, body, parent=None, previous=None)</a></code></p>
<p class="firstline">Creates a new task on the specified task list.</p>
<p class="toc_element">
- <code><a href="#list">list(tasklist, showCompleted=None, dueMin=None, dueMax=None, pageToken=None, updatedMin=None, showDeleted=None, completedMax=None, maxResults=None, completedMin=None, showHidden=None)</a></code></p>
+ <code><a href="#list">list(tasklist, dueMax=None, pageToken=None, updatedMin=None, maxResults=None, completedMin=None, showDeleted=None, completedMax=None, showHidden=None, showCompleted=None, dueMin=None)</a></code></p>
<p class="firstline">Returns all tasks in the specified task list.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -137,13 +137,6 @@
"kind": "tasks#task", # Type of the resource. This is always "tasks#task".
"updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
"parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level.
- "links": [ # Collection of links. This collection is read-only.
- {
- "type": "A String", # Type of the link, e.g. "email".
- "link": "A String", # The URL.
- "description": "A String", # The description. In HTML speak: Everything between <a> and </a>.
- },
- ],
"title": "A String", # Title of the task.
"deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.
"completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
@@ -171,13 +164,6 @@
"kind": "tasks#task", # Type of the resource. This is always "tasks#task".
"updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
"parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level.
- "links": [ # Collection of links. This collection is read-only.
- {
- "type": "A String", # Type of the link, e.g. "email".
- "link": "A String", # The URL.
- "description": "A String", # The description. In HTML speak: Everything between <a> and </a>.
- },
- ],
"title": "A String", # Title of the task.
"deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.
"completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
@@ -201,13 +187,6 @@
"kind": "tasks#task", # Type of the resource. This is always "tasks#task".
"updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
"parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level.
- "links": [ # Collection of links. This collection is read-only.
- {
- "type": "A String", # Type of the link, e.g. "email".
- "link": "A String", # The URL.
- "description": "A String", # The description. In HTML speak: Everything between <a> and </a>.
- },
- ],
"title": "A String", # Title of the task.
"deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.
"completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
@@ -222,21 +201,21 @@
</div>
<div class="method">
- <code class="details" id="list">list(tasklist, showCompleted=None, dueMin=None, dueMax=None, pageToken=None, updatedMin=None, showDeleted=None, completedMax=None, maxResults=None, completedMin=None, showHidden=None)</code>
+ <code class="details" id="list">list(tasklist, dueMax=None, pageToken=None, updatedMin=None, maxResults=None, completedMin=None, showDeleted=None, completedMax=None, showHidden=None, showCompleted=None, dueMin=None)</code>
<pre>Returns all tasks in the specified task list.
Args:
tasklist: string, Task list identifier. (required)
- showCompleted: boolean, Flag indicating whether completed tasks are returned in the result. Optional. The default is True.
- dueMin: string, Lower bound for a task's due date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by due date.
dueMax: string, Upper bound for a task's due date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by due date.
pageToken: string, Token specifying the result page to return. Optional.
updatedMin: string, Lower bound for a task's last modification time (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by last modification time.
+ maxResults: integer, Maximum number of task lists returned on one page. Optional. The default is 100.
+ completedMin: string, Lower bound for a task's completion date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by completion date.
showDeleted: boolean, Flag indicating whether deleted tasks are returned in the result. Optional. The default is False.
completedMax: string, Upper bound for a task's completion date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by completion date.
- maxResults: string, Maximum number of task lists returned on one page. Optional. The default is 100.
- completedMin: string, Lower bound for a task's completion date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by completion date.
showHidden: boolean, Flag indicating whether hidden tasks are returned in the result. Optional. The default is False.
+ showCompleted: boolean, Flag indicating whether completed tasks are returned in the result. Optional. The default is True.
+ dueMin: string, Lower bound for a task's due date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by due date.
Returns:
An object of the form:
@@ -249,13 +228,6 @@
"kind": "tasks#task", # Type of the resource. This is always "tasks#task".
"updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
"parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level.
- "links": [ # Collection of links. This collection is read-only.
- {
- "type": "A String", # Type of the link, e.g. "email".
- "link": "A String", # The URL.
- "description": "A String", # The description. In HTML speak: Everything between <a> and </a>.
- },
- ],
"title": "A String", # Title of the task.
"deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.
"completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
@@ -305,13 +277,6 @@
"kind": "tasks#task", # Type of the resource. This is always "tasks#task".
"updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
"parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level.
- "links": [ # Collection of links. This collection is read-only.
- {
- "type": "A String", # Type of the link, e.g. "email".
- "link": "A String", # The URL.
- "description": "A String", # The description. In HTML speak: Everything between <a> and </a>.
- },
- ],
"title": "A String", # Title of the task.
"deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.
"completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
@@ -340,13 +305,6 @@
"kind": "tasks#task", # Type of the resource. This is always "tasks#task".
"updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
"parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level.
- "links": [ # Collection of links. This collection is read-only.
- {
- "type": "A String", # Type of the link, e.g. "email".
- "link": "A String", # The URL.
- "description": "A String", # The description. In HTML speak: Everything between <a> and </a>.
- },
- ],
"title": "A String", # Title of the task.
"deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.
"completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
@@ -368,13 +326,6 @@
"kind": "tasks#task", # Type of the resource. This is always "tasks#task".
"updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
"parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level.
- "links": [ # Collection of links. This collection is read-only.
- {
- "type": "A String", # Type of the link, e.g. "email".
- "link": "A String", # The URL.
- "description": "A String", # The description. In HTML speak: Everything between <a> and </a>.
- },
- ],
"title": "A String", # Title of the task.
"deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.
"completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
@@ -403,13 +354,6 @@
"kind": "tasks#task", # Type of the resource. This is always "tasks#task".
"updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
"parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level.
- "links": [ # Collection of links. This collection is read-only.
- {
- "type": "A String", # Type of the link, e.g. "email".
- "link": "A String", # The URL.
- "description": "A String", # The description. In HTML speak: Everything between <a> and </a>.
- },
- ],
"title": "A String", # Title of the task.
"deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.
"completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
@@ -431,13 +375,6 @@
"kind": "tasks#task", # Type of the resource. This is always "tasks#task".
"updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
"parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level.
- "links": [ # Collection of links. This collection is read-only.
- {
- "type": "A String", # Type of the link, e.g. "email".
- "link": "A String", # The URL.
- "description": "A String", # The description. In HTML speak: Everything between <a> and </a>.
- },
- ],
"title": "A String", # Title of the task.
"deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.
"completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.